src/librustc/session/mod.rs

   1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use lint;
  12 use middle::cstore::CrateStore;
  13 use middle::dependency_format;
  14 use session::search_paths::PathKind;
  15 use util::nodemap::{NodeMap, FnvHashMap};
  16
  17 use syntax::ast::{NodeId, NodeIdAssigner, Name};
  18 use syntax::codemap::Span;
  19 use syntax::diagnostic::{self, Emitter};
  20 use syntax::diagnostics;
  21 use syntax::feature_gate;
  22 use syntax::parse;
  23 use syntax::parse::ParseSess;
  24 use syntax::{ast, codemap};
  25 use syntax::feature_gate::AttributeType;
  26
  27 use rustc_back::target::Target;
  28
  29 use std::path::{Path, PathBuf};
  30 use std::cell::{Cell, RefCell};
  31 use std::collections::HashSet;
  32 use std::env;
  33 use std::rc::Rc;
  34
  35 pub mod config;
  36 pub mod filesearch;
  37 pub mod search_paths;
  38
  39 // Represents the data associated with a compilation
  40 // session for a single crate.
  41 pub struct Session {
  42     pub target: config::Config,
  43     pub host: Target,
  44     pub opts: config::Options,
  45     pub cstore: Rc<for<'a> CrateStore<'a>>,
  46     pub parse_sess: ParseSess,
  47     // For a library crate, this is always none
  48     pub entry_fn: RefCell<Option<(NodeId, codemap::Span)>>,
  49     pub entry_type: Cell<Option<config::EntryFnType>>,
  50     pub plugin_registrar_fn: Cell<Option<ast::NodeId>>,
  51     pub default_sysroot: Option<PathBuf>,
  52     // The name of the root source file of the crate, in the local file system.
  53     // The path is always expected to be absolute. `None` means that there is no
  54     // source file.
  55     pub local_crate_source_file: Option<PathBuf>,
  56     pub working_dir: PathBuf,
  57     pub lint_store: RefCell<lint::LintStore>,
  58     pub lints: RefCell<NodeMap<Vec<(lint::LintId, codemap::Span, String)>>>,
  59     pub plugin_llvm_passes: RefCell<Vec<String>>,
  60     pub plugin_attributes: RefCell<Vec<(String, AttributeType)>>,
  61     pub crate_types: RefCell<Vec<config::CrateType>>,
  62     pub dependency_formats: RefCell<dependency_format::Dependencies>,
  63     pub crate_metadata: RefCell<Vec<String>>,
  64     pub features: RefCell<feature_gate::Features>,
  65
  66     pub delayed_span_bug: RefCell<Option<(codemap::Span, String)>>,
  67
  68     /// The maximum recursion limit for potentially infinitely recursive
  69     /// operations such as auto-dereference and monomorphization.
  70     pub recursion_limit: Cell<usize>,
  71
  72     pub can_print_warnings: bool,
  73
  74     /// The metadata::creader module may inject an allocator dependency if it
  75     /// didn't already find one, and this tracks what was injected.
  76     pub injected_allocator: Cell<Option<ast::CrateNum>>,
  77
  78     /// Names of all bang-style macros and syntax extensions
  79     /// available in this crate
  80     pub available_macros: RefCell<HashSet<Name>>,
  81
  82     next_node_id: Cell<ast::NodeId>,
  83 }
  84
  85 impl Session {
  86     pub fn span_fatal(&self, sp: Span, msg: &str) -> ! {
  87         if self.opts.treat_err_as_bug {
  88             self.span_bug(sp, msg);
  89         }
  90         panic!(self.diagnostic().span_fatal(sp, msg))
  91     }
  92     pub fn span_fatal_with_code(&self, sp: Span, msg: &str, code: &str) -> ! {
  93         if self.opts.treat_err_as_bug {
  94             self.span_bug(sp, msg);
  95         }
  96         panic!(self.diagnostic().span_fatal_with_code(sp, msg, code))
  97     }
  98     pub fn fatal(&self, msg: &str) -> ! {
  99         if self.opts.treat_err_as_bug {
 100             self.bug(msg);
 101         }
 102         panic!(self.diagnostic().handler().fatal(msg))
 103     }
 104     pub fn span_err_or_warn(&self, is_warning: bool, sp: Span, msg: &str) {
 105         if is_warning {
 106             self.span_warn(sp, msg);
 107         } else {
 108             self.span_err(sp, msg);
 109         }
 110     }
 111     pub fn span_err(&self, sp: Span, msg: &str) {
 112         if self.opts.treat_err_as_bug {
 113             self.span_bug(sp, msg);
 114         }
 115         match split_msg_into_multilines(msg) {
 116             Some(msg) => self.diagnostic().span_err(sp, &msg[..]),
 117             None => self.diagnostic().span_err(sp, msg)
 118         }
 119     }
 120     pub fn span_err_with_code(&self, sp: Span, msg: &str, code: &str) {
 121         if self.opts.treat_err_as_bug {
 122             self.span_bug(sp, msg);
 123         }
 124         match split_msg_into_multilines(msg) {
 125             Some(msg) => self.diagnostic().span_err_with_code(sp, &msg[..], code),
 126             None => self.diagnostic().span_err_with_code(sp, msg, code)
 127         }
 128     }
 129     pub fn err(&self, msg: &str) {
 130         if self.opts.treat_err_as_bug {
 131             self.bug(msg);
 132         }
 133         self.diagnostic().handler().err(msg)
 134     }
 135     pub fn err_count(&self) -> usize {
 136         self.diagnostic().handler().err_count()
 137     }
 138     pub fn has_errors(&self) -> bool {
 139         self.diagnostic().handler().has_errors()
 140     }
 141     pub fn abort_if_errors(&self) {
 142         self.diagnostic().handler().abort_if_errors();
 143
 144         let delayed_bug = self.delayed_span_bug.borrow();
 145         match *delayed_bug {
 146             Some((span, ref errmsg)) => {
 147                 self.diagnostic().span_bug(span, errmsg);
 148             },
 149             _ => {}
 150         }
 151     }
 152     pub fn abort_if_new_errors<F>(&self, mut f: F)
 153         where F: FnMut()
 154     {
 155         let count = self.err_count();
 156         f();
 157         if self.err_count() > count {
 158             self.abort_if_errors();
 159         }
 160     }
 161     pub fn span_warn(&self, sp: Span, msg: &str) {
 162         if self.can_print_warnings {
 163             self.diagnostic().span_warn(sp, msg)
 164         }
 165     }
 166     pub fn span_warn_with_code(&self, sp: Span, msg: &str, code: &str) {
 167         if self.can_print_warnings {
 168             self.diagnostic().span_warn_with_code(sp, msg, code)
 169         }
 170     }
 171     pub fn warn(&self, msg: &str) {
 172         if self.can_print_warnings {
 173             self.diagnostic().handler().warn(msg)
 174         }
 175     }
 176     pub fn opt_span_warn(&self, opt_sp: Option<Span>, msg: &str) {
 177         match opt_sp {
 178             Some(sp) => self.span_warn(sp, msg),
 179             None => self.warn(msg),
 180         }
 181     }
 182     pub fn span_note(&self, sp: Span, msg: &str) {
 183         self.diagnostic().span_note(sp, msg)
 184     }
 185     pub fn span_end_note(&self, sp: Span, msg: &str) {
 186         self.diagnostic().span_end_note(sp, msg)
 187     }
 188
 189     /// Prints out a message with a suggested edit of the code.
 190     ///
 191     /// See `diagnostic::RenderSpan::Suggestion` for more information.
 192     pub fn span_suggestion(&self, sp: Span, msg: &str, suggestion: String) {
 193         self.diagnostic().span_suggestion(sp, msg, suggestion)
 194     }
 195     pub fn span_help(&self, sp: Span, msg: &str) {
 196         self.diagnostic().span_help(sp, msg)
 197     }
 198     pub fn fileline_note(&self, sp: Span, msg: &str) {
 199         self.diagnostic().fileline_note(sp, msg)
 200     }
 201     pub fn fileline_help(&self, sp: Span, msg: &str) {
 202         self.diagnostic().fileline_help(sp, msg)
 203     }
 204     pub fn note(&self, msg: &str) {
 205         self.diagnostic().handler().note(msg)
 206     }
 207     pub fn help(&self, msg: &str) {
 208         self.diagnostic().handler().help(msg)
 209     }
 210     pub fn opt_span_bug(&self, opt_sp: Option<Span>, msg: &str) -> ! {
 211         match opt_sp {
 212             Some(sp) => self.span_bug(sp, msg),
 213             None => self.bug(msg),
 214         }
 215     }
 216     /// Delay a span_bug() call until abort_if_errors()
 217     pub fn delay_span_bug(&self, sp: Span, msg: &str) {
 218         let mut delayed = self.delayed_span_bug.borrow_mut();
 219         *delayed = Some((sp, msg.to_string()));
 220     }
 221     pub fn span_bug(&self, sp: Span, msg: &str) -> ! {
 222         self.diagnostic().span_bug(sp, msg)
 223     }
 224     pub fn bug(&self, msg: &str) -> ! {
 225         self.diagnostic().handler().bug(msg)
 226     }
 227     pub fn span_unimpl(&self, sp: Span, msg: &str) -> ! {
 228         self.diagnostic().span_unimpl(sp, msg)
 229     }
 230     pub fn unimpl(&self, msg: &str) -> ! {
 231         self.diagnostic().handler().unimpl(msg)
 232     }
 233     pub fn add_lint(&self,
 234                     lint: &'static lint::Lint,
 235                     id: ast::NodeId,
 236                     sp: Span,
 237                     msg: String) {
 238         let lint_id = lint::LintId::of(lint);
 239         let mut lints = self.lints.borrow_mut();
 240         match lints.get_mut(&id) {
 241             Some(arr) => { arr.push((lint_id, sp, msg)); return; }
 242             None => {}
 243         }
 244         lints.insert(id, vec!((lint_id, sp, msg)));
 245     }
 246     pub fn reserve_node_ids(&self, count: ast::NodeId) -> ast::NodeId {
 247         let id = self.next_node_id.get();
 248
 249         match id.checked_add(count) {
 250             Some(next) => self.next_node_id.set(next),
 251             None => self.bug("Input too large, ran out of node ids!")
 252         }
 253
 254         id
 255     }
 256     pub fn diagnostic<'a>(&'a self) -> &'a diagnostic::SpanHandler {
 257         &self.parse_sess.span_diagnostic
 258     }
 259     pub fn codemap<'a>(&'a self) -> &'a codemap::CodeMap {
 260         self.parse_sess.codemap()
 261     }
 262     // This exists to help with refactoring to eliminate impossible
 263     // cases later on
 264     pub fn impossible_case(&self, sp: Span, msg: &str) -> ! {
 265         self.span_bug(sp,
 266                       &format!("impossible case reached: {}", msg));
 267     }
 268     pub fn verbose(&self) -> bool { self.opts.debugging_opts.verbose }
 269     pub fn time_passes(&self) -> bool { self.opts.debugging_opts.time_passes }
 270     pub fn count_llvm_insns(&self) -> bool {
 271         self.opts.debugging_opts.count_llvm_insns
 272     }
 273     pub fn count_type_sizes(&self) -> bool {
 274         self.opts.debugging_opts.count_type_sizes
 275     }
 276     pub fn time_llvm_passes(&self) -> bool {
 277         self.opts.debugging_opts.time_llvm_passes
 278     }
 279     pub fn trans_stats(&self) -> bool { self.opts.debugging_opts.trans_stats }
 280     pub fn meta_stats(&self) -> bool { self.opts.debugging_opts.meta_stats }
 281     pub fn asm_comments(&self) -> bool { self.opts.debugging_opts.asm_comments }
 282     pub fn no_verify(&self) -> bool { self.opts.debugging_opts.no_verify }
 283     pub fn borrowck_stats(&self) -> bool { self.opts.debugging_opts.borrowck_stats }
 284     pub fn print_llvm_passes(&self) -> bool {
 285         self.opts.debugging_opts.print_llvm_passes
 286     }
 287     pub fn lto(&self) -> bool {
 288         self.opts.cg.lto
 289     }
 290     pub fn no_landing_pads(&self) -> bool {
 291         self.opts.debugging_opts.no_landing_pads
 292     }
 293     pub fn unstable_options(&self) -> bool {
 294         self.opts.debugging_opts.unstable_options
 295     }
 296     pub fn print_enum_sizes(&self) -> bool {
 297         self.opts.debugging_opts.print_enum_sizes
 298     }
 299     pub fn nonzeroing_move_hints(&self) -> bool {
 300         self.opts.debugging_opts.enable_nonzeroing_move_hints
 301     }
 302     pub fn sysroot<'a>(&'a self) -> &'a Path {
 303         match self.opts.maybe_sysroot {
 304             Some (ref sysroot) => sysroot,
 305             None => self.default_sysroot.as_ref()
 306                         .expect("missing sysroot and default_sysroot in Session")
 307         }
 308     }
 309     pub fn target_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
 310         filesearch::FileSearch::new(self.sysroot(),
 311                                     &self.opts.target_triple,
 312                                     &self.opts.search_paths,
 313                                     kind)
 314     }
 315     pub fn host_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
 316         filesearch::FileSearch::new(
 317             self.sysroot(),
 318             config::host_triple(),
 319             &self.opts.search_paths,
 320             kind)
 321     }
 322 }
 323
 324 impl NodeIdAssigner for Session {
 325     fn next_node_id(&self) -> NodeId {
 326         self.reserve_node_ids(1)
 327     }
 328
 329     fn peek_node_id(&self) -> NodeId {
 330         self.next_node_id.get().checked_add(1).unwrap()
 331     }
 332 }
 333
 334 fn split_msg_into_multilines(msg: &str) -> Option<String> {
 335     // Conditions for enabling multi-line errors:
 336     if !msg.contains("mismatched types") &&
 337         !msg.contains("type mismatch resolving") &&
 338         !msg.contains("if and else have incompatible types") &&
 339         !msg.contains("if may be missing an else clause") &&
 340         !msg.contains("match arms have incompatible types") &&
 341         !msg.contains("structure constructor specifies a structure of type") &&
 342         !msg.contains("has an incompatible type for trait") {
 343             return None
 344     }
 345     let first = msg.match_indices("expected").filter(|s| {
 346         s.0 > 0 && (msg.char_at_reverse(s.0) == ' ' ||
 347                     msg.char_at_reverse(s.0) == '(')
 348     }).map(|(a, b)| (a - 1, a + b.len()));
 349     let second = msg.match_indices("found").filter(|s| {
 350         msg.char_at_reverse(s.0) == ' '
 351     }).map(|(a, b)| (a - 1, a + b.len()));
 352
 353     let mut new_msg = String::new();
 354     let mut head = 0;
 355
 356     // Insert `\n` before expected and found.
 357     for (pos1, pos2) in first.zip(second) {
 358         new_msg = new_msg +
 359         // A `(` may be preceded by a space and it should be trimmed
 360                   msg[head..pos1.0].trim_right() + // prefix
 361                   "\n" +                           // insert before first
 362                   &msg[pos1.0..pos1.1] +           // insert what first matched
 363                   &msg[pos1.1..pos2.0] +           // between matches
 364                   "\n   " +                        // insert before second
 365         //           123
 366         // `expected` is 3 char longer than `found`. To align the types,
 367         // `found` gets 3 spaces prepended.
 368                   &msg[pos2.0..pos2.1];            // insert what second matched
 369
 370         head = pos2.1;
 371     }
 372
 373     let mut tail = &msg[head..];
 374     let third = tail.find("(values differ")
 375                    .or(tail.find("(lifetime"))
 376                    .or(tail.find("(cyclic type of infinite size"));
 377     // Insert `\n` before any remaining messages which match.
 378     if let Some(pos) = third {
 379         // The end of the message may just be wrapped in `()` without
 380         // `expected`/`found`.  Push this also to a new line and add the
 381         // final tail after.
 382         new_msg = new_msg +
 383         // `(` is usually preceded by a space and should be trimmed.
 384                   tail[..pos].trim_right() + // prefix
 385                   "\n" +                     // insert before paren
 386                   &tail[pos..];              // append the tail
 387
 388         tail = "";
 389     }
 390
 391     new_msg.push_str(tail);
 392     return Some(new_msg);
 393 }
 394
 395 pub fn build_session(sopts: config::Options,
 396                      local_crate_source_file: Option<PathBuf>,
 397                      registry: diagnostics::registry::Registry,
 398                      cstore: Rc<for<'a> CrateStore<'a>>)
 399                      -> Session {
 400     // FIXME: This is not general enough to make the warning lint completely override
 401     // normal diagnostic warnings, since the warning lint can also be denied and changed
 402     // later via the source code.
 403     let can_print_warnings = sopts.lint_opts
 404         .iter()
 405         .filter(|&&(ref key, _)| *key == "warnings")
 406         .map(|&(_, ref level)| *level != lint::Allow)
 407         .last()
 408         .unwrap_or(true);
 409
 410     let codemap = codemap::CodeMap::new();
 411     let diagnostic_handler =
 412         diagnostic::Handler::new(sopts.color, Some(registry), can_print_warnings);
 413     let span_diagnostic_handler =
 414         diagnostic::SpanHandler::new(diagnostic_handler, codemap);
 415
 416     build_session_(sopts, local_crate_source_file, span_diagnostic_handler, cstore)
 417 }
 418
 419 pub fn build_session_(sopts: config::Options,
 420                       local_crate_source_file: Option<PathBuf>,
 421                       span_diagnostic: diagnostic::SpanHandler,
 422                       cstore: Rc<for<'a> CrateStore<'a>>)
 423                       -> Session {
 424     let host = match Target::search(config::host_triple()) {
 425         Ok(t) => t,
 426         Err(e) => {
 427             panic!(span_diagnostic.handler()
 428                                   .fatal(&format!("Error loading host specification: {}", e)));
 429     }
 430     };
 431     let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
 432     let p_s = parse::ParseSess::with_span_handler(span_diagnostic);
 433     let default_sysroot = match sopts.maybe_sysroot {
 434         Some(_) => None,
 435         None => Some(filesearch::get_or_default_sysroot())
 436     };
 437
 438     // Make the path absolute, if necessary
 439     let local_crate_source_file = local_crate_source_file.map(|path|
 440         if path.is_absolute() {
 441             path.clone()
 442         } else {
 443             env::current_dir().unwrap().join(&path)
 444         }
 445     );
 446
 447     let can_print_warnings = sopts.lint_opts
 448         .iter()
 449         .filter(|&&(ref key, _)| *key == "warnings")
 450         .map(|&(_, ref level)| *level != lint::Allow)
 451         .last()
 452         .unwrap_or(true);
 453
 454     let sess = Session {
 455         target: target_cfg,
 456         host: host,
 457         opts: sopts,
 458         cstore: cstore,
 459         parse_sess: p_s,
 460         // For a library crate, this is always none
 461         entry_fn: RefCell::new(None),
 462         entry_type: Cell::new(None),
 463         plugin_registrar_fn: Cell::new(None),
 464         default_sysroot: default_sysroot,
 465         local_crate_source_file: local_crate_source_file,
 466         working_dir: env::current_dir().unwrap(),
 467         lint_store: RefCell::new(lint::LintStore::new()),
 468         lints: RefCell::new(NodeMap()),
 469         plugin_llvm_passes: RefCell::new(Vec::new()),
 470         plugin_attributes: RefCell::new(Vec::new()),
 471         crate_types: RefCell::new(Vec::new()),
 472         dependency_formats: RefCell::new(FnvHashMap()),
 473         crate_metadata: RefCell::new(Vec::new()),
 474         delayed_span_bug: RefCell::new(None),
 475         features: RefCell::new(feature_gate::Features::new()),
 476         recursion_limit: Cell::new(64),
 477         can_print_warnings: can_print_warnings,
 478         next_node_id: Cell::new(1),
 479         injected_allocator: Cell::new(None),
 480         available_macros: RefCell::new(HashSet::new()),
 481     };
 482
 483     sess
 484 }
 485
 486 // Seems out of place, but it uses session, so I'm putting it here
 487 pub fn expect<T, M>(sess: &Session, opt: Option<T>, msg: M) -> T where
 488     M: FnOnce() -> String,
 489 {
 490     diagnostic::expect(sess.diagnostic(), opt, msg)
 491 }
 492
 493 pub fn early_error(color: diagnostic::ColorConfig, msg: &str) -> ! {
 494     let mut emitter = diagnostic::EmitterWriter::stderr(color, None);
 495     emitter.emit(None, msg, None, diagnostic::Fatal);
 496     panic!(diagnostic::FatalError);
 497 }
 498
 499 pub fn early_warn(color: diagnostic::ColorConfig, msg: &str) {
 500     let mut emitter = diagnostic::EmitterWriter::stderr(color, None);
 501     emitter.emit(None, msg, None, diagnostic::Warning);
 502 }