feat: added compiler_diagbacktraces feature to enable backtraces on diagnostics

Author: Zffu

compiler/diagnostics/Cargo.toml

@@ -5,4 +5,7 @@ edition = "2024"
 
 [dependencies]
 compiler_utils = { path = "../compiler_utils" }
-colored = "3.1.1"
+colored = "3.1.1"
+
+[features]
+compiler_diagbacktraces = []

compiler/diagnostics/src/diagnostic.rs

@@ -1,6 +1,9 @@
 //! The core of diagnostics
 
-use std::{backtrace::Backtrace, fmt::Display, fs, io::Error};
+#[cfg(feature = "compiler_diagbacktraces")]
+use std::backtrace::Backtrace;
+
+use std::{fmt::Display, fs, io::Error};
 
 use colored::{ColoredString, Colorize};
 use compiler_utils::Position;
@@ -68,47 +71,43 @@ pub struct Diagnostic {
 	pub note: Vec<String>,
 	pub help: Vec<String>,
 
-	pub backtrace: Option<Backtrace>
+	#[cfg(feature = "compiler_diagbacktraces")]
+	pub backtrace: Backtrace
 }
 
 impl Clone for Diagnostic {
 	fn clone(&self) -> Self {
-		Diagnostic { level: self.level.clone(), code: self.code, message: self.message.clone(), primary_span: self.primary_span.clone(), spans: self.spans.clone(), note: self.note.clone(), help: self.help.clone(), backtrace: Diagnostic::capture_backtrace() }
+		#[cfg(feature = "compiler_diagbacktraces")]
+		return Diagnostic { level: self.level.clone(), code: self.code, message: self.message.clone(), primary_span: self.primary_span.clone(), spans: self.spans.clone(), note: self.note.clone(), help: self.help.clone(), backtrace: Diagnostic::capture_backtrace() };
+		
+		#[cfg(not(feature = "compiler_diagbacktraces"))]
+		return Diagnostic { level: self.level.clone(), code: self.code, message: self.message.clone(), primary_span: self.primary_span.clone(), spans: self.spans.clone(), note: self.note.clone(), help: self.help.clone() };
 	}
 }
 
 impl Diagnostic {
-	pub fn capture_backtrace() -> Option<Backtrace> {
-		if cfg!(debug_assertions) {
-            Some(Backtrace::capture())
-        } else {
-            None
-        }
-	}
-
-	pub fn maybe_display_backtrace(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-		if cfg!(debug_assertions) {
-			writeln!(fmt, "Internally captured in:")?;
-			writeln!(fmt, "{}", self.backtrace.as_ref().unwrap())?;
-		}
-
-		Ok(())
-	}
-
 	pub fn new(level: Level, decl: (usize, &str), primary_span: Span, spans: Vec<Span>, note: Vec<String>, help: Vec<String>) -> Self {
-		let d = Diagnostic { level, code: decl.0, message: decl.1.to_string(), primary_span, spans, note, help, backtrace: Diagnostic::capture_backtrace() };
+		#[cfg(feature = "compiler_diagbacktraces")]
+		let d = Diagnostic { level, code: decl.0, message: decl.1.to_string(), primary_span, spans, note, help, backtrace: Backtrace::capture() };
 
+		#[cfg(not(feature = "compiler_diagbacktraces"))]
+		let d = Diagnostic { level, code: decl.0, message: decl.1.to_string(), primary_span, spans, note, help };
+
 		d.push_to_storage();
 
-		d
+		return d
  	}
 
 	pub fn new_base(level: Level, code: usize, message: String, primary_span: Span, spans: Vec<Span>, note: Vec<String>, help: Vec<String>) -> Self {
-		let d = Diagnostic { level, code, message, primary_span, spans, note, help, backtrace: Diagnostic::capture_backtrace() };
+		#[cfg(feature = "compiler_diagbacktraces")]
+		let d = Diagnostic { level, code, message, primary_span, spans, note, help, backtrace: Backtrace::capture() };
+
+		#[cfg(not(feature = "compiler_diagbacktraces"))] 
+		let d = Diagnostic { level, code, message, primary_span, spans, note, help };
 
 		d.push_to_storage();
 
-		d
+		return d
 	}
 
 	fn push_to_storage(&self) {		
@@ -249,8 +248,11 @@ impl Display for Diagnostic {
 			ind += 1;
 		}
 
-		self.maybe_display_backtrace(f)?;
-		
+		#[cfg(feature = "compiler_diagbacktraces")] {
+			writeln!(f, "Internally captured in:")?;
+			writeln!(f, "{}", self.backtrace)?;
+		}
+
 		Ok(())
 	}
 }