Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Box DiagnosticBuilder. #64374

Merged
merged 1 commit into from
Sep 14, 2019
Merged

Box DiagnosticBuilder. #64374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/librustc_errors/annotate_snippet_emitter_writer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ impl Emitter for AnnotateSnippetEmitterWriter {
&mut primary_span,
&mut children,
&db.level,
db.handler.flags.external_macro_backtrace);
db.handler().flags.external_macro_backtrace);

self.emit_messages_default(&db.level,
db.message(),
Expand Down
81 changes: 46 additions & 35 deletions src/librustc_errors/diagnostic_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,17 @@ use log::debug;
/// extending `HandlerFlags`, accessed via `self.handler.flags`.
#[must_use]
#[derive(Clone)]
pub struct DiagnosticBuilder<'a> {
pub handler: &'a Handler,
pub struct DiagnosticBuilder<'a>(Box<DiagnosticBuilderInner<'a>>);

/// This is a large type, and often used as a return value, especially within
/// the frequently-used `PResult` type. In theory, return value optimization
/// (RVO) should avoid unnecessary copying. In practice, it does not (at the
/// time of writing). The split between `DiagnosticBuilder` and
/// `DiagnosticBuilderInner` exists to avoid many `memcpy` calls.
#[must_use]
#[derive(Clone)]
struct DiagnosticBuilderInner<'a> {
handler: &'a Handler,
diagnostic: Diagnostic,
allow_suggestions: bool,
}
Expand Down Expand Up @@ -52,7 +61,7 @@ macro_rules! forward {
) => {
$(#[$attrs])*
pub fn $n(&mut self, $($name: $ty),*) -> &mut Self {
self.diagnostic.$n($($name),*);
self.0.diagnostic.$n($($name),*);
self
}
};
Expand All @@ -69,7 +78,7 @@ macro_rules! forward {
) => {
$(#[$attrs])*
pub fn $n<S: Into<MultiSpan>>(&mut self, $($name: $ty),*) -> &mut Self {
self.diagnostic.$n($($name),*);
self.0.diagnostic.$n($($name),*);
self
}
};
Expand All @@ -79,24 +88,28 @@ impl<'a> Deref for DiagnosticBuilder<'a> {
type Target = Diagnostic;

fn deref(&self) -> &Diagnostic {
&self.diagnostic
&self.0.diagnostic
}
}

impl<'a> DerefMut for DiagnosticBuilder<'a> {
fn deref_mut(&mut self) -> &mut Diagnostic {
&mut self.diagnostic
&mut self.0.diagnostic
}
}

impl<'a> DiagnosticBuilder<'a> {
pub fn handler(&self) -> &'a Handler{
self.0.handler
}

/// Emit the diagnostic.
pub fn emit(&mut self) {
if self.cancelled() {
return;
}

self.handler.emit_db(&self);
self.0.handler.emit_db(&self);
self.cancel();
}

Expand All @@ -115,8 +128,8 @@ impl<'a> DiagnosticBuilder<'a> {
/// Buffers the diagnostic for later emission, unless handler
/// has disabled such buffering.
pub fn buffer(mut self, buffered_diagnostics: &mut Vec<Diagnostic>) {
if self.handler.flags.dont_buffer_diagnostics ||
self.handler.flags.treat_err_as_bug.is_some()
if self.0.handler.flags.dont_buffer_diagnostics ||
self.0.handler.flags.treat_err_as_bug.is_some()
{
self.emit();
return;
Expand All @@ -126,7 +139,7 @@ impl<'a> DiagnosticBuilder<'a> {
// implements `Drop`.
let diagnostic;
unsafe {
diagnostic = std::ptr::read(&self.diagnostic);
diagnostic = std::ptr::read(&self.0.diagnostic);
std::mem::forget(self);
};
// Logging here is useful to help track down where in logs an error was
Expand All @@ -144,7 +157,7 @@ impl<'a> DiagnosticBuilder<'a> {
span: Option<S>,
) -> &mut Self {
let span = span.map(|s| s.into()).unwrap_or_else(|| MultiSpan::new());
self.diagnostic.sub(level, message, span, None);
self.0.diagnostic.sub(level, message, span, None);
self
}

Expand All @@ -160,7 +173,7 @@ impl<'a> DiagnosticBuilder<'a> {
/// locally in whichever way makes the most sense.
pub fn delay_as_bug(&mut self) {
self.level = Level::Bug;
self.handler.delay_as_bug(self.diagnostic.clone());
self.0.handler.delay_as_bug(self.0.diagnostic.clone());
self.cancel();
}

Expand All @@ -171,7 +184,7 @@ impl<'a> DiagnosticBuilder<'a> {
/// then the snippet will just include that `Span`, which is
/// called the primary span.
pub fn span_label<T: Into<String>>(&mut self, span: Span, label: T) -> &mut Self {
self.diagnostic.span_label(span, label);
self.0.diagnostic.span_label(span, label);
self
}

Expand Down Expand Up @@ -208,10 +221,10 @@ impl<'a> DiagnosticBuilder<'a> {
suggestion: Vec<(Span, String)>,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.multipart_suggestion(
self.0.diagnostic.multipart_suggestion(
msg,
suggestion,
applicability,
Expand All @@ -225,29 +238,28 @@ impl<'a> DiagnosticBuilder<'a> {
suggestion: Vec<(Span, String)>,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.tool_only_multipart_suggestion(
self.0.diagnostic.tool_only_multipart_suggestion(
msg,
suggestion,
applicability,
);
self
}


pub fn span_suggestion(
&mut self,
sp: Span,
msg: &str,
suggestion: String,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.span_suggestion(
self.0.diagnostic.span_suggestion(
sp,
msg,
suggestion,
Expand All @@ -263,10 +275,10 @@ impl<'a> DiagnosticBuilder<'a> {
suggestions: impl Iterator<Item = String>,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.span_suggestions(
self.0.diagnostic.span_suggestions(
sp,
msg,
suggestions,
Expand All @@ -282,10 +294,10 @@ impl<'a> DiagnosticBuilder<'a> {
suggestion: String,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.span_suggestion_short(
self.0.diagnostic.span_suggestion_short(
sp,
msg,
suggestion,
Expand All @@ -301,10 +313,10 @@ impl<'a> DiagnosticBuilder<'a> {
suggestion: String,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.span_suggestion_hidden(
self.0.diagnostic.span_suggestion_hidden(
sp,
msg,
suggestion,
Expand All @@ -320,10 +332,10 @@ impl<'a> DiagnosticBuilder<'a> {
suggestion: String,
applicability: Applicability,
) -> &mut Self {
if !self.allow_suggestions {
if !self.0.allow_suggestions {
return self
}
self.diagnostic.tool_only_span_suggestion(
self.0.diagnostic.tool_only_span_suggestion(
sp,
msg,
suggestion,
Expand All @@ -336,7 +348,7 @@ impl<'a> DiagnosticBuilder<'a> {
forward!(pub fn code(&mut self, s: DiagnosticId) -> &mut Self);

pub fn allow_suggestions(&mut self, allow: bool) -> &mut Self {
self.allow_suggestions = allow;
self.0.allow_suggestions = allow;
self
}

Expand All @@ -359,19 +371,18 @@ impl<'a> DiagnosticBuilder<'a> {

/// Creates a new `DiagnosticBuilder` with an already constructed
/// diagnostic.
pub fn new_diagnostic(handler: &'a Handler, diagnostic: Diagnostic)
-> DiagnosticBuilder<'a> {
DiagnosticBuilder {
pub fn new_diagnostic(handler: &'a Handler, diagnostic: Diagnostic) -> DiagnosticBuilder<'a> {
DiagnosticBuilder(Box::new(DiagnosticBuilderInner {
handler,
diagnostic,
allow_suggestions: true,
}
}))
}
}

impl<'a> Debug for DiagnosticBuilder<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.diagnostic.fmt(f)
self.0.diagnostic.fmt(f)
}
}

Expand All @@ -381,7 +392,7 @@ impl<'a> Drop for DiagnosticBuilder<'a> {
fn drop(&mut self) {
if !panicking() && !self.cancelled() {
let mut db = DiagnosticBuilder::new(
self.handler,
self.0.handler,
Level::Bug,
"the following error was constructed but not emitted",
);
Expand Down
2 changes: 1 addition & 1 deletion src/librustc_errors/emitter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ impl Emitter for EmitterWriter {
&mut primary_span,
&mut children,
&db.level,
db.handler.flags.external_macro_backtrace);
db.handler().flags.external_macro_backtrace);

self.emit_messages_default(&db.level,
&db.styled_message(),
Expand Down
7 changes: 7 additions & 0 deletions src/libsyntax/parse/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ use crate::symbol::Symbol;

use errors::{Applicability, FatalError, Level, Handler, ColorConfig, Diagnostic, DiagnosticBuilder};
use rustc_data_structures::fx::{FxHashSet, FxHashMap};
#[cfg(target_arch = "x86_64")]
use rustc_data_structures::static_assert_size;
use rustc_data_structures::sync::{Lrc, Lock, Once};
use syntax_pos::{Span, SourceFile, FileName, MultiSpan};
use syntax_pos::edition::Edition;
Expand All @@ -38,6 +40,11 @@ crate mod unescape_error_reporting;

pub type PResult<'a, T> = Result<T, DiagnosticBuilder<'a>>;

// `PResult` is used a lot. Make sure it doesn't unintentionally get bigger.
// (See also the comment on `DiagnosticBuilderInner`.)
#[cfg(target_arch = "x86_64")]
static_assert_size!(PResult<'_, bool>, 16);

/// Collected spans during parsing for places where a certain feature was
/// used and should be feature gated accordingly in `check_crate`.
#[derive(Default)]
Expand Down