git.delta.rocks / jrsonnet / refs/commits / abd809cc16d2

1use std::{2	cmp::Ordering,3	fmt::{Debug, Display},4	path::PathBuf,5};67use jrsonnet_gcmodule::Trace;8use jrsonnet_interner::IStr;9use jrsonnet_parser::{BinaryOpType, ExprLocation, LocExpr, Source, SourcePath, UnaryOpType};10use jrsonnet_types::ValType;11use thiserror::Error;1213use crate::{function::CallLocation, stdlib::format::FormatError, typed::TypeLocError, ObjValue};1415pub(crate) fn format_found(list: &[IStr], what: &str) -> String {16	if list.is_empty() {17		return String::new();18	}19	let mut out = String::new();20	out.push_str("\nThere is ");21	out.push_str(what);22	if list.len() > 1 {23		out.push('s');24	}25	out.push_str(" with similar name");26	if list.len() > 1 {27		out.push('s');28	}29	out.push_str(" present: ");30	for (i, v) in list.iter().enumerate() {31		if i != 0 {32			out.push_str(", ");33		}34		out.push_str(v as &str);35	}36	out37}3839fn format_signature(sig: &FunctionSignature) -> String {40	let mut out = String::new();41	out.push_str("\nFunction has the following signature: ");42	out.push('(');43	if sig.is_empty() {44		out.push_str("/*no arguments*/");45	} else {46		for (i, (name, has_default)) in sig.iter().enumerate() {47			if i != 0 {48				out.push_str(", ");49			}50			if let Some(name) = name {51				out.push_str(name);52			} else {53				out.push_str("<unnamed>");54			}55			if *has_default {56				out.push_str(" = <default>");57			}58		}59	}60	out.push(')');61	out62}6364const fn format_empty_str(str: &str) -> &str {65	if str.is_empty() {66		"\"\" (empty string)"67	} else {68		str69	}70}7172pub(crate) fn suggest_object_fields(v: &ObjValue, key: IStr) -> Vec<IStr> {73	let mut heap = Vec::new();74	for field in v.fields_ex(75		true,76		#[cfg(feature = "exp-preserve-order")]77		false,78	) {79		let conf = strsim::jaro_winkler(field.as_str(), key.as_str());80		if conf < 0.8 {81			continue;82		}83		assert!(field.as_str() != key.as_str(), "looks like string pooling failure, please write any info regarding this crash to https://github.com/CertainLach/jrsonnet/issues/113, thanks!");8485		heap.push((conf, field));86	}87	heap.sort_by(|a, b| b.0.partial_cmp(&a.0).unwrap_or(Ordering::Equal));88	heap.into_iter().map(|v| v.1).collect()89}9091type FunctionSignature = Vec<(Option<IStr>, bool)>;9293/// Possible errors94#[allow(missing_docs)]95#[derive(Error, Debug, Clone, Trace)]96#[non_exhaustive]97pub enum ErrorKind {98	#[error("intrinsic not found: {0}")]99	IntrinsicNotFound(IStr),100101	#[error("operator {0} does not operate on type {1}")]102	UnaryOperatorDoesNotOperateOnType(UnaryOpType, ValType),103	#[error("binary operation {1} {0} {2} is not implemented")]104	BinaryOperatorDoesNotOperateOnValues(BinaryOpType, ValType, ValType),105106	#[error("no top level object in this context")]107	NoTopLevelObjectFound,108	#[error("self is only usable inside objects")]109	CantUseSelfOutsideOfObject,110	#[error("no super found")]111	NoSuperFound,112113	#[error("for loop can only iterate over arrays")]114	InComprehensionCanOnlyIterateOverArray,115116	#[error("array out of bounds: {0} is not within [0,{1})")]117	ArrayBoundsError(usize, usize),118	#[error("string out of bounds: {0} is not within [0,{1})")]119	StringBoundsError(usize, usize),120121	#[error("assert failed: {}", format_empty_str(.0))]122	AssertionFailed(IStr),123124	#[error("variable is not defined: {0}{}", format_found(.1, "variable"))]125	VariableIsNotDefined(IStr, Vec<IStr>),126	#[error("duplicate local var: {0}")]127	DuplicateLocalVar(IStr),128129	#[error("type mismatch: expected {}, got {2} {0}", .1.iter().map(|e| format!("{e}")).collect::<Vec<_>>().join(", "))]130	TypeMismatch(&'static str, Vec<ValType>, ValType),131	#[error("no such field: {}{}", format_empty_str(.0), format_found(.1, "field"))]132	NoSuchField(IStr, Vec<IStr>),133134	#[error("only functions can be called, got {0}")]135	OnlyFunctionsCanBeCalledGot(ValType),136	#[error("parameter {0} is not defined")]137	UnknownFunctionParameter(String),138	#[error("argument {0} is already bound")]139	BindingParameterASecondTime(IStr),140	#[error("too many args, function has {0}{}", format_signature(.1))]141	TooManyArgsFunctionHas(usize, FunctionSignature),142	#[error("function argument is not passed: {}{}", .0.as_ref().map_or("<unnamed>", IStr::as_str), format_signature(.1))]143	FunctionParameterNotBoundInCall(Option<IStr>, FunctionSignature),144145	#[error("external variable is not defined: {0}")]146	UndefinedExternalVariable(IStr),147148	#[error("field name should be string, got {0}")]149	FieldMustBeStringGot(ValType),150	#[error("duplicate field name: {}", format_empty_str(.0))]151	DuplicateFieldName(IStr),152153	#[error("attempted to index array with string {}", format_empty_str(.0))]154	AttemptedIndexAnArrayWithString(IStr),155	#[error("{0} index type should be {1}, got {2}")]156	ValueIndexMustBeTypeGot(ValType, ValType, ValType),157	#[error("cant index into {0}")]158	CantIndexInto(ValType),159	#[error("{0} is not indexable")]160	ValueIsNotIndexable(ValType),161162	#[error("super can't be used standalone")]163	StandaloneSuper,164165	#[error("can't resolve {1} from {0}")]166	ImportFileNotFound(SourcePath, String),167	#[error("can't resolve absolute {0}")]168	AbsoluteImportFileNotFound(PathBuf),169	#[error("resolved file not found: {:?}", .0)]170	ResolvedFileNotFound(SourcePath),171	#[error("can't import {0}: is a directory")]172	ImportIsADirectory(SourcePath),173	#[error("imported file is not valid utf-8: {0:?}")]174	ImportBadFileUtf8(SourcePath),175	#[error("import io error: {0}")]176	ImportIo(String),177	#[error("tried to import {1} from {0}, but imports are not supported")]178	ImportNotSupported(SourcePath, String),179	#[error("tried to import {0}, but absolute imports are not supported")]180	AbsoluteImportNotSupported(PathBuf),181	#[error("can't import from virtual file")]182	CantImportFromVirtualFile,183	#[error(184		"syntax error: {}",185		// Peg has no fancier way to handle critical parsing errors https://github.com/kevinmehall/rust-peg/issues/225186		{.error.expected.tokens().find(|t| t.starts_with("!!!")).map_or_else(|| {187			format!(188				"expected {}, got {:?}",189				.error.expected,190				.path.code().chars().nth(error.location.offset)191				.map_or_else(|| "EOF".into(), |c| c.to_string())192			)193		}, |v| v[3..].into())}194	)]195	ImportSyntaxError {196		path: Source,197		#[trace(skip)]198		error: Box<jrsonnet_parser::ParseError>,199	},200201	#[error("runtime error: {}", format_empty_str(.0))]202	RuntimeError(IStr),203	#[error("stack overflow, try to reduce recursion, or set --max-stack to bigger value")]204	StackOverflow,205	#[error("infinite recursion detected")]206	InfiniteRecursionDetected,207	#[error("tried to index by fractional value")]208	FractionalIndex,209	#[error("attempted to divide by zero")]210	DivisionByZero,211212	#[error("string manifest output is not an string")]213	StringManifestOutputIsNotAString,214	#[error("stream manifest output is not an array")]215	StreamManifestOutputIsNotAArray,216	#[error("multi manifest output is not an object")]217	MultiManifestOutputIsNotAObject,218219	#[error("cant recurse stream manifest")]220	StreamManifestOutputCannotBeRecursed,221	#[error("stream manifest output cannot consist of raw strings")]222	StreamManifestCannotNestString,223224	#[error("{}", format_empty_str(.0))]225	ImportCallbackError(String),226	#[error("invalid unicode codepoint: {0}")]227	InvalidUnicodeCodepointGot(u32),228229	#[error("format error: {0}")]230	Format(#[from] FormatError),231	#[error("type error: {0}")]232	TypeError(TypeLocError),233234	#[cfg(feature = "anyhow-error")]235	#[error(transparent)]236	Other(#[trace(skip)] std::rc::Rc<anyhow::Error>),237}238239#[cfg(feature = "anyhow-error")]240impl From<anyhow::Error> for Error {241	fn from(e: anyhow::Error) -> Self {242		Self::new(ErrorKind::Other(std::rc::Rc::new(e)))243	}244}245246impl From<ErrorKind> for Error {247	fn from(e: ErrorKind) -> Self {248		Self::new(e)249	}250}251252/// Single stack trace frame253#[derive(Clone, Debug, Trace)]254pub struct StackTraceElement {255	/// Source of this frame256	/// Some frames only act as description, without attached source257	pub location: Option<ExprLocation>,258	/// Frame description259	pub desc: String,260}261#[derive(Debug, Clone, Trace)]262pub struct StackTrace(pub Vec<StackTraceElement>);263264#[derive(Clone, Trace)]265pub struct Error(Box<(ErrorKind, StackTrace)>);266impl Error {267	pub fn new(e: ErrorKind) -> Self {268		Self(Box::new((e, StackTrace(vec![]))))269	}270271	pub const fn error(&self) -> &ErrorKind {272		&(self.0).0273	}274	pub fn error_mut(&mut self) -> &mut ErrorKind {275		&mut (self.0).0276	}277	pub const fn trace(&self) -> &StackTrace {278		&(self.0).1279	}280	pub fn trace_mut(&mut self) -> &mut StackTrace {281		&mut (self.0).1282	}283}284impl Display for Error {285	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {286		writeln!(f, "{}", self.0 .0)?;287		for el in &self.0 .1 .0 {288			write!(f, "\t{}", el.desc)?;289			if let Some(loc) = &el.location {290				write!(f, "at {}", loc.0 .0 .0)?;291				loc.0.map_source_locations(&[loc.1, loc.2]);292			}293			writeln!(f)?;294		}295		Ok(())296	}297}298impl Debug for Error {299	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {300		f.debug_tuple("LocError").field(&self.0).finish()301	}302}303impl std::error::Error for Error {}304305pub trait ErrorSource {306	fn to_location(self) -> Option<ExprLocation>;307}308impl ErrorSource for &LocExpr {309	fn to_location(self) -> Option<ExprLocation> {310		Some(self.1.clone())311	}312}313impl ErrorSource for &ExprLocation {314	fn to_location(self) -> Option<ExprLocation> {315		Some(self.clone())316	}317}318impl ErrorSource for CallLocation<'_> {319	fn to_location(self) -> Option<ExprLocation> {320		self.0.cloned()321	}322}323324pub type Result<V, E = Error> = std::result::Result<V, E>;325pub trait ResultExt: Sized {326	#[must_use]327	fn with_description<O: Into<String>>(self, msg: impl FnOnce() -> O) -> Self;328	#[must_use]329	fn description(self, msg: &str) -> Self {330		self.with_description(|| msg)331	}332333	#[must_use]334	fn with_description_src<O: Into<String>>(335		self,336		src: impl ErrorSource,337		msg: impl FnOnce() -> O,338	) -> Self;339	#[must_use]340	fn description_src(self, src: impl ErrorSource, msg: &str) -> Self {341		self.with_description_src(src, || msg)342	}343}344impl<T> ResultExt for Result<T, Error> {345	fn with_description<O: Into<String>>(mut self, msg: impl FnOnce() -> O) -> Self {346		if let Err(e) = &mut self {347			let trace = e.trace_mut();348			trace.0.push(StackTraceElement {349				location: None,350				desc: msg().into(),351			});352		}353		self354	}355356	fn with_description_src<O: Into<String>>(357		mut self,358		src: impl ErrorSource,359		msg: impl FnOnce() -> O,360	) -> Self {361		if let Err(e) = &mut self {362			let trace = e.trace_mut();363			trace.0.push(StackTraceElement {364				location: src.to_location(),365				desc: msg().into(),366			});367		}368		self369	}370}371372#[macro_export]373macro_rules! bail {374	($w:ident$(::$i:ident)*$(($($tt:tt)*))?) => {375		return Err($w$(::$i)*$(($($tt)*))?.into())376	};377	($w:ident$(::$i:ident)*$({$($tt:tt)*})?) => {378		return Err($w$(::$i)*$({$($tt)*})?.into())379	};380	($l:literal$(, $($tt:tt)*)?) => {381		return Err($crate::error::ErrorKind::RuntimeError($crate::jrsonnet_macros::format_istr!($l$(, $($tt)*)?)).into())382	};383}384385#[macro_export]386macro_rules! runtime_error {387	($l:literal$(, $($tt:tt)*)?) => {388		$crate::error::Error::from($crate::error::ErrorKind::RuntimeError($crate::jrsonnet_macros::format_istr!($l$(, $($tt)*)?)))389	};390}