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.
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.
12 use middle::cstore::CrateStore;
13 use middle::dependency_format;
14 use session::search_paths::PathKind;
15 use util::nodemap::{NodeMap, FnvHashMap};
17 use syntax::ast::{NodeId, NodeIdAssigner, Name};
18 use syntax::codemap::Span;
20 use syntax::errors::emitter::{Emitter, BasicEmitter};
21 use syntax::diagnostics;
22 use syntax::feature_gate;
24 use syntax::parse::ParseSess;
25 use syntax::{ast, codemap};
26 use syntax::feature_gate::AttributeType;
28 use rustc_back::target::Target;
30 use std::path::{Path, PathBuf};
31 use std::cell::{Cell, RefCell};
32 use std::collections::HashSet;
40 // Represents the data associated with a compilation
41 // session for a single crate.
43 pub target: config::Config,
45 pub opts: config::Options,
46 pub cstore: Rc<for<'a> CrateStore<'a>>,
47 pub parse_sess: ParseSess,
48 // For a library crate, this is always none
49 pub entry_fn: RefCell<Option<(NodeId, codemap::Span)>>,
50 pub entry_type: Cell<Option<config::EntryFnType>>,
51 pub plugin_registrar_fn: Cell<Option<ast::NodeId>>,
52 pub default_sysroot: Option<PathBuf>,
53 // The name of the root source file of the crate, in the local file system.
54 // The path is always expected to be absolute. `None` means that there is no
56 pub local_crate_source_file: Option<PathBuf>,
57 pub working_dir: PathBuf,
58 pub lint_store: RefCell<lint::LintStore>,
59 pub lints: RefCell<NodeMap<Vec<(lint::LintId, codemap::Span, String)>>>,
60 pub plugin_llvm_passes: RefCell<Vec<String>>,
61 pub plugin_attributes: RefCell<Vec<(String, AttributeType)>>,
62 pub crate_types: RefCell<Vec<config::CrateType>>,
63 pub dependency_formats: RefCell<dependency_format::Dependencies>,
64 pub crate_metadata: RefCell<Vec<String>>,
65 pub features: RefCell<feature_gate::Features>,
67 /// The maximum recursion limit for potentially infinitely recursive
68 /// operations such as auto-dereference and monomorphization.
69 pub recursion_limit: Cell<usize>,
71 /// The metadata::creader module may inject an allocator dependency if it
72 /// didn't already find one, and this tracks what was injected.
73 pub injected_allocator: Cell<Option<ast::CrateNum>>,
75 /// Names of all bang-style macros and syntax extensions
76 /// available in this crate
77 pub available_macros: RefCell<HashSet<Name>>,
79 next_node_id: Cell<ast::NodeId>,
83 pub fn span_fatal(&self, sp: Span, msg: &str) -> ! {
84 panic!(self.diagnostic().span_fatal(sp, msg))
86 pub fn span_fatal_with_code(&self, sp: Span, msg: &str, code: &str) -> ! {
87 panic!(self.diagnostic().span_fatal_with_code(sp, msg, code))
89 pub fn fatal(&self, msg: &str) -> ! {
90 panic!(self.diagnostic().fatal(msg))
92 pub fn span_err_or_warn(&self, is_warning: bool, sp: Span, msg: &str) {
94 self.span_warn(sp, msg);
96 self.span_err(sp, msg);
99 pub fn span_err(&self, sp: Span, msg: &str) {
100 match split_msg_into_multilines(msg) {
101 Some(msg) => self.diagnostic().span_err(sp, &msg[..]),
102 None => self.diagnostic().span_err(sp, msg)
105 pub fn span_err_with_code(&self, sp: Span, msg: &str, code: &str) {
106 match split_msg_into_multilines(msg) {
107 Some(msg) => self.diagnostic().span_err_with_code(sp, &msg[..], code),
108 None => self.diagnostic().span_err_with_code(sp, msg, code)
111 pub fn err(&self, msg: &str) {
112 self.diagnostic().err(msg)
114 pub fn err_count(&self) -> usize {
115 self.diagnostic().err_count()
117 pub fn has_errors(&self) -> bool {
118 self.diagnostic().has_errors()
120 pub fn abort_if_errors(&self) {
121 self.diagnostic().abort_if_errors();
123 pub fn abort_if_new_errors<F>(&self, mut f: F)
126 let count = self.err_count();
128 if self.err_count() > count {
129 self.abort_if_errors();
132 pub fn span_warn(&self, sp: Span, msg: &str) {
133 self.diagnostic().span_warn(sp, msg)
135 pub fn span_warn_with_code(&self, sp: Span, msg: &str, code: &str) {
136 self.diagnostic().span_warn_with_code(sp, msg, code)
138 pub fn warn(&self, msg: &str) {
139 self.diagnostic().warn(msg)
141 pub fn opt_span_warn(&self, opt_sp: Option<Span>, msg: &str) {
143 Some(sp) => self.span_warn(sp, msg),
144 None => self.warn(msg),
147 pub fn span_note(&self, sp: Span, msg: &str) {
148 self.diagnostic().span_note(sp, msg)
150 pub fn span_end_note(&self, sp: Span, msg: &str) {
151 self.diagnostic().span_end_note(sp, msg)
154 /// Prints out a message with a suggested edit of the code.
156 /// See `errors::RenderSpan::Suggestion` for more information.
157 pub fn span_suggestion(&self, sp: Span, msg: &str, suggestion: String) {
158 self.diagnostic().span_suggestion(sp, msg, suggestion)
160 pub fn span_help(&self, sp: Span, msg: &str) {
161 self.diagnostic().span_help(sp, msg)
163 pub fn fileline_note(&self, sp: Span, msg: &str) {
164 self.diagnostic().fileline_note(sp, msg)
166 pub fn fileline_help(&self, sp: Span, msg: &str) {
167 self.diagnostic().fileline_help(sp, msg)
169 pub fn note(&self, msg: &str) {
170 self.diagnostic().note(msg)
172 pub fn help(&self, msg: &str) {
173 self.diagnostic().help(msg)
175 pub fn opt_span_bug(&self, opt_sp: Option<Span>, msg: &str) -> ! {
177 Some(sp) => self.span_bug(sp, msg),
178 None => self.bug(msg),
181 /// Delay a span_bug() call until abort_if_errors()
182 pub fn delay_span_bug(&self, sp: Span, msg: &str) {
183 self.diagnostic().delay_span_bug(sp, msg)
185 pub fn span_bug(&self, sp: Span, msg: &str) -> ! {
186 self.diagnostic().span_bug(sp, msg)
188 pub fn bug(&self, msg: &str) -> ! {
189 self.diagnostic().bug(msg)
191 pub fn span_unimpl(&self, sp: Span, msg: &str) -> ! {
192 self.diagnostic().span_unimpl(sp, msg)
194 pub fn unimpl(&self, msg: &str) -> ! {
195 self.diagnostic().unimpl(msg)
197 pub fn add_lint(&self,
198 lint: &'static lint::Lint,
202 let lint_id = lint::LintId::of(lint);
203 let mut lints = self.lints.borrow_mut();
204 match lints.get_mut(&id) {
205 Some(arr) => { arr.push((lint_id, sp, msg)); return; }
208 lints.insert(id, vec!((lint_id, sp, msg)));
210 pub fn reserve_node_ids(&self, count: ast::NodeId) -> ast::NodeId {
211 let id = self.next_node_id.get();
213 match id.checked_add(count) {
214 Some(next) => self.next_node_id.set(next),
215 None => self.bug("Input too large, ran out of node ids!")
220 pub fn diagnostic<'a>(&'a self) -> &'a errors::Handler {
221 &self.parse_sess.span_diagnostic
223 pub fn codemap<'a>(&'a self) -> &'a codemap::CodeMap {
224 self.parse_sess.codemap()
226 // This exists to help with refactoring to eliminate impossible
228 pub fn impossible_case(&self, sp: Span, msg: &str) -> ! {
229 self.span_bug(sp, &format!("impossible case reached: {}", msg));
231 pub fn verbose(&self) -> bool { self.opts.debugging_opts.verbose }
232 pub fn time_passes(&self) -> bool { self.opts.debugging_opts.time_passes }
233 pub fn count_llvm_insns(&self) -> bool {
234 self.opts.debugging_opts.count_llvm_insns
236 pub fn count_type_sizes(&self) -> bool {
237 self.opts.debugging_opts.count_type_sizes
239 pub fn time_llvm_passes(&self) -> bool {
240 self.opts.debugging_opts.time_llvm_passes
242 pub fn trans_stats(&self) -> bool { self.opts.debugging_opts.trans_stats }
243 pub fn meta_stats(&self) -> bool { self.opts.debugging_opts.meta_stats }
244 pub fn asm_comments(&self) -> bool { self.opts.debugging_opts.asm_comments }
245 pub fn no_verify(&self) -> bool { self.opts.debugging_opts.no_verify }
246 pub fn borrowck_stats(&self) -> bool { self.opts.debugging_opts.borrowck_stats }
247 pub fn print_llvm_passes(&self) -> bool {
248 self.opts.debugging_opts.print_llvm_passes
250 pub fn lto(&self) -> bool {
253 pub fn no_landing_pads(&self) -> bool {
254 self.opts.debugging_opts.no_landing_pads
256 pub fn unstable_options(&self) -> bool {
257 self.opts.debugging_opts.unstable_options
259 pub fn print_enum_sizes(&self) -> bool {
260 self.opts.debugging_opts.print_enum_sizes
262 pub fn nonzeroing_move_hints(&self) -> bool {
263 self.opts.debugging_opts.enable_nonzeroing_move_hints
265 pub fn sysroot<'a>(&'a self) -> &'a Path {
266 match self.opts.maybe_sysroot {
267 Some (ref sysroot) => sysroot,
268 None => self.default_sysroot.as_ref()
269 .expect("missing sysroot and default_sysroot in Session")
272 pub fn target_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
273 filesearch::FileSearch::new(self.sysroot(),
274 &self.opts.target_triple,
275 &self.opts.search_paths,
278 pub fn host_filesearch(&self, kind: PathKind) -> filesearch::FileSearch {
279 filesearch::FileSearch::new(
281 config::host_triple(),
282 &self.opts.search_paths,
287 impl NodeIdAssigner for Session {
288 fn next_node_id(&self) -> NodeId {
289 self.reserve_node_ids(1)
292 fn peek_node_id(&self) -> NodeId {
293 self.next_node_id.get().checked_add(1).unwrap()
297 fn split_msg_into_multilines(msg: &str) -> Option<String> {
298 // Conditions for enabling multi-line errors:
299 if !msg.contains("mismatched types") &&
300 !msg.contains("type mismatch resolving") &&
301 !msg.contains("if and else have incompatible types") &&
302 !msg.contains("if may be missing an else clause") &&
303 !msg.contains("match arms have incompatible types") &&
304 !msg.contains("structure constructor specifies a structure of type") &&
305 !msg.contains("has an incompatible type for trait") {
308 let first = msg.match_indices("expected").filter(|s| {
309 s.0 > 0 && (msg.char_at_reverse(s.0) == ' ' ||
310 msg.char_at_reverse(s.0) == '(')
311 }).map(|(a, b)| (a - 1, a + b.len()));
312 let second = msg.match_indices("found").filter(|s| {
313 msg.char_at_reverse(s.0) == ' '
314 }).map(|(a, b)| (a - 1, a + b.len()));
316 let mut new_msg = String::new();
319 // Insert `\n` before expected and found.
320 for (pos1, pos2) in first.zip(second) {
322 // A `(` may be preceded by a space and it should be trimmed
323 msg[head..pos1.0].trim_right() + // prefix
324 "\n" + // insert before first
325 &msg[pos1.0..pos1.1] + // insert what first matched
326 &msg[pos1.1..pos2.0] + // between matches
327 "\n " + // insert before second
329 // `expected` is 3 char longer than `found`. To align the types,
330 // `found` gets 3 spaces prepended.
331 &msg[pos2.0..pos2.1]; // insert what second matched
336 let mut tail = &msg[head..];
337 let third = tail.find("(values differ")
338 .or(tail.find("(lifetime"))
339 .or(tail.find("(cyclic type of infinite size"));
340 // Insert `\n` before any remaining messages which match.
341 if let Some(pos) = third {
342 // The end of the message may just be wrapped in `()` without
343 // `expected`/`found`. Push this also to a new line and add the
346 // `(` is usually preceded by a space and should be trimmed.
347 tail[..pos].trim_right() + // prefix
348 "\n" + // insert before paren
349 &tail[pos..]; // append the tail
354 new_msg.push_str(tail);
355 return Some(new_msg);
358 pub fn build_session(sopts: config::Options,
359 local_crate_source_file: Option<PathBuf>,
360 registry: diagnostics::registry::Registry,
361 cstore: Rc<for<'a> CrateStore<'a>>)
363 // FIXME: This is not general enough to make the warning lint completely override
364 // normal diagnostic warnings, since the warning lint can also be denied and changed
365 // later via the source code.
366 let can_print_warnings = sopts.lint_opts
368 .filter(|&&(ref key, _)| *key == "warnings")
369 .map(|&(_, ref level)| *level != lint::Allow)
372 let treat_err_as_bug = sopts.treat_err_as_bug;
374 let codemap = Rc::new(codemap::CodeMap::new());
375 let diagnostic_handler =
376 errors::Handler::new(sopts.color,
382 build_session_(sopts, local_crate_source_file, diagnostic_handler, codemap, cstore)
385 pub fn build_session_(sopts: config::Options,
386 local_crate_source_file: Option<PathBuf>,
387 span_diagnostic: errors::Handler,
388 codemap: Rc<codemap::CodeMap>,
389 cstore: Rc<for<'a> CrateStore<'a>>)
391 let host = match Target::search(config::host_triple()) {
394 panic!(span_diagnostic.fatal(&format!("Error loading host specification: {}", e)));
397 let target_cfg = config::build_target_config(&sopts, &span_diagnostic);
398 let p_s = parse::ParseSess::with_span_handler(span_diagnostic, codemap);
399 let default_sysroot = match sopts.maybe_sysroot {
401 None => Some(filesearch::get_or_default_sysroot())
404 // Make the path absolute, if necessary
405 let local_crate_source_file = local_crate_source_file.map(|path|
406 if path.is_absolute() {
409 env::current_dir().unwrap().join(&path)
419 // For a library crate, this is always none
420 entry_fn: RefCell::new(None),
421 entry_type: Cell::new(None),
422 plugin_registrar_fn: Cell::new(None),
423 default_sysroot: default_sysroot,
424 local_crate_source_file: local_crate_source_file,
425 working_dir: env::current_dir().unwrap(),
426 lint_store: RefCell::new(lint::LintStore::new()),
427 lints: RefCell::new(NodeMap()),
428 plugin_llvm_passes: RefCell::new(Vec::new()),
429 plugin_attributes: RefCell::new(Vec::new()),
430 crate_types: RefCell::new(Vec::new()),
431 dependency_formats: RefCell::new(FnvHashMap()),
432 crate_metadata: RefCell::new(Vec::new()),
433 features: RefCell::new(feature_gate::Features::new()),
434 recursion_limit: Cell::new(64),
435 next_node_id: Cell::new(1),
436 injected_allocator: Cell::new(None),
437 available_macros: RefCell::new(HashSet::new()),
443 pub fn early_error(color: errors::ColorConfig, msg: &str) -> ! {
444 let mut emitter = BasicEmitter::stderr(color);
445 emitter.emit(None, msg, None, errors::Level::Fatal);
446 panic!(errors::FatalError);
449 pub fn early_warn(color: errors::ColorConfig, msg: &str) {
450 let mut emitter = BasicEmitter::stderr(color);
451 emitter.emit(None, msg, None, errors::Level::Warning);