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

1use std::{2	cell::RefCell,3	cmp::Ordering,4	fmt::{self, Debug, Display},5	marker::PhantomData,6	mem::replace,7	num::NonZeroU32,8	ops::Deref,9	rc::Rc,10};1112use jrsonnet_gcmodule::{Acyclic, Cc, Trace, cc_dyn};13use jrsonnet_interner::IStr;14pub use jrsonnet_macros::Thunk;15use jrsonnet_types::ValType;16use rustc_hash::FxHashMap;17use thiserror::Error;1819pub use crate::arr::{ArrValue, ArrayLike};20use crate::{21	ObjValue, Result, SupThis, Unbound, WeakSupThis, bail,22	error::{Error, ErrorKind::*},23	function::FuncVal,24	gc::WithCapacityExt as _,25	manifest::{ManifestFormat, ToStringFormat},26	typed::{BoundedUsize, MAX_SAFE_INTEGER, MIN_SAFE_INTEGER},27};2829pub trait ThunkValue: Trace {30	type Output;31	fn get(&self) -> Result<Self::Output>;32}3334#[derive(Trace)]35enum MemoizedClusureThunkInner<D: Trace, T: Trace> {36	Computed(T),37	Errored(Error),38	Waiting {39		env: D,40		// Carries no data, as it is not a real closure, all the41		// captured environment is stored in `env` field.42		#[trace(skip)]43		closure: fn(D) -> Result<T>,44	},45	Pending,46}47#[derive(Trace)]48pub struct MemoizedClosureThunk<D: Trace, T: Trace>(RefCell<MemoizedClusureThunkInner<D, T>>);49impl<D: Trace, T: Trace> MemoizedClosureThunk<D, T> {50	pub fn new(env: D, closure: fn(D) -> Result<T>) -> Self {51		Self(RefCell::new(MemoizedClusureThunkInner::Waiting {52			env,53			closure,54		}))55	}56}5758impl<D: Trace, T: Trace + Clone> ThunkValue for MemoizedClosureThunk<D, T> {59	type Output = T;6061	fn get(&self) -> Result<Self::Output> {62		match &*self.0.borrow() {63			MemoizedClusureThunkInner::Computed(v) => return Ok(v.clone()),64			MemoizedClusureThunkInner::Errored(e) => return Err(e.clone()),65			MemoizedClusureThunkInner::Pending => return Err(InfiniteRecursionDetected.into()),66			MemoizedClusureThunkInner::Waiting { .. } => (),67		}68		let MemoizedClusureThunkInner::Waiting { env, closure } = replace(69			&mut *self.0.borrow_mut(),70			MemoizedClusureThunkInner::Pending,71		) else {72			unreachable!();73		};74		let new_value = match closure(env) {75			Ok(v) => v,76			Err(e) => {77				*self.0.borrow_mut() = MemoizedClusureThunkInner::Errored(e.clone());78				return Err(e);79			}80		};81		*self.0.borrow_mut() = MemoizedClusureThunkInner::Computed(new_value.clone());82		Ok(new_value)83	}84}8586cc_dyn!(87	/// Lazily evaluated value88	#[derive(Clone)] Thunk<V: Trace>,89	ThunkValue<Output = V>,90	pub fn new() {...}91);9293impl<T: Trace> Thunk<T> {94	pub fn evaluated(val: T) -> Self95	where96		T: Clone,97	{98		#[derive(Trace)]99		struct EvaluatedThunk<T: Trace>(T);100		impl<T> ThunkValue for EvaluatedThunk<T>101		where102			T: Clone + Trace,103		{104			type Output = T;105106			fn get(&self) -> Result<Self::Output> {107				Ok(self.0.clone())108			}109		}110		Self::new(EvaluatedThunk(val))111	}112	pub fn errored(e: Error) -> Self {113		#[derive(Trace)]114		struct ErroredThunk<T: Trace>(Error, PhantomData<T>);115		impl<T> ThunkValue for ErroredThunk<T>116		where117			T: Trace,118		{119			type Output = T;120121			fn get(&self) -> Result<Self::Output> {122				Err(self.0.clone())123			}124		}125		Self::new(ErroredThunk(e, PhantomData))126	}127	pub fn result(res: Result<T, Error>) -> Self128	where129		T: Clone,130	{131		match res {132			Ok(o) => Self::evaluated(o),133			Err(e) => Self::errored(e),134		}135	}136}137138impl<T> Thunk<T>139where140	T: Trace,141{142	pub fn force(&self) -> Result<()> {143		self.evaluate()?;144		Ok(())145	}146147	/// Evaluate thunk, or return cached value148	///149	/// # Errors150	///151	/// - Lazy value evaluation returned error152	/// - This method was called during inner value evaluation153	pub fn evaluate(&self) -> Result<T> {154		self.0.get()155	}156}157158pub trait ThunkMapper<Input>: Trace {159	type Output;160	fn map(self, from: Input) -> Result<Self::Output>;161}162impl<Input> Thunk<Input>163where164	Input: Trace,165{166	pub fn map<M>(self, mapper: M) -> Thunk<M::Output>167	where168		M: ThunkMapper<Input>,169		M::Output: Trace + Clone,170	{171		let inner = self;172		Thunk!(move || {173			let value = inner.evaluate()?;174			let mapped = mapper.map(value)?;175			Ok(mapped)176		})177	}178}179180impl<T: Trace + Clone> From<Result<T>> for Thunk<T> {181	fn from(value: Result<T>) -> Self {182		match value {183			Ok(o) => Self::evaluated(o),184			Err(e) => Self::errored(e),185		}186	}187}188impl<T, V: Trace> From<T> for Thunk<V>189where190	T: ThunkValue<Output = V>,191{192	fn from(value: T) -> Self {193		Self::new(value)194	}195}196197impl<T: Trace + Default + Clone> Default for Thunk<T> {198	fn default() -> Self {199		Self::evaluated(T::default())200	}201}202203#[derive(Trace, Clone)]204pub struct CachedUnbound<I, T>205where206	I: Unbound<Bound = T>,207	T: Trace,208{209	cache: Cc<RefCell<FxHashMap<WeakSupThis, T>>>,210	value: I,211}212impl<I: Unbound<Bound = T>, T: Trace> CachedUnbound<I, T> {213	pub fn new(value: I) -> Self {214		Self {215			cache: Cc::new(RefCell::new(FxHashMap::new())),216			value,217		}218	}219}220impl<I: Unbound<Bound = T>, T: Clone + Trace> Unbound for CachedUnbound<I, T> {221	type Bound = T;222	fn bind(&self, sup_this: SupThis) -> Result<T> {223		let cache_key = sup_this.clone().downgrade();224		{225			if let Some(t) = self.cache.borrow().get(&cache_key) {226				return Ok(t.clone());227			}228		}229		let bound = self.value.bind(sup_this)?;230231		{232			let mut cache = self.cache.borrow_mut();233			cache.insert(cache_key, bound.clone());234		}235236		Ok(bound)237	}238}239240impl<T: Debug + Trace> Debug for Thunk<T> {241	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {242		write!(f, "Lazy")243	}244}245impl<T: Trace> PartialEq for Thunk<T> {246	fn eq(&self, other: &Self) -> bool {247		Cc::ptr_eq(&self.0, &other.0)248	}249}250251/// Represents a Jsonnet value, which can be sliced or indexed (string or array).252#[allow(clippy::module_name_repetitions)]253pub enum IndexableVal {254	/// String.255	Str(IStr),256	/// Array.257	Arr(ArrValue),258}259impl IndexableVal {260	pub fn is_empty(&self) -> bool {261		match self {262			Self::Str(s) => s.is_empty(),263			Self::Arr(s) => s.is_empty(),264		}265	}266267	pub fn to_array(self) -> ArrValue {268		match self {269			Self::Str(s) => s.chars().collect(),270			Self::Arr(arr) => arr,271		}272	}273	/// Slice the value.274	///275	/// # Implementation276	///277	/// For strings, will create a copy of specified interval.278	///279	/// For arrays, nothing will be copied on this call, instead [`ArrValue::Slice`] view will be returned.280	pub fn slice(281		self,282		index: Option<i32>,283		end: Option<i32>,284		step: Option<BoundedUsize<1, { i32::MAX as usize }>>,285	) -> Result<Self> {286		match &self {287			Self::Str(s) => {288				let mut computed_len = None;289				let mut get_len = || {290					computed_len.unwrap_or_else(|| {291						let len = s.chars().count();292						let _ = computed_len.insert(len);293						len294					})295				};296				let mut get_idx = |pos: Option<i32>, default| {297					match pos {298						#[expect(clippy::cast_sign_loss, reason = "abs value is used")]299						Some(v) if v < 0 => get_len().saturating_sub((-v as isize) as usize),300						// No need to clamp, as iterator interface is used301						#[expect(clippy::cast_sign_loss, reason = "abs value is used")]302						Some(v) => v as usize,303						None => default,304					}305				};306307				let index = get_idx(index, 0);308				let end = get_idx(end, usize::MAX);309				let step = step.as_deref().copied().unwrap_or(1);310311				if index >= end {312					return Ok(Self::Str("".into()));313				}314315				Ok(Self::Str(316					(s.chars()317						.skip(index)318						.take(end - index)319						.step_by(step)320						.collect::<String>())321					.into(),322				))323			}324			Self::Arr(arr) => Ok(Self::Arr(arr.clone().slice(325				index,326				end,327				#[expect(328					clippy::cast_possible_truncation,329					reason = "overflow will result with skip too large which would be equivalent"330				)]331				step.map(|v| NonZeroU32::new(v.value() as u32).expect("bounded != 0")),332			))),333		}334	}335}336337#[derive(Debug, Clone, Acyclic)]338pub enum StrValue {339	Flat(IStr),340	Tree(Rc<(StrValue, StrValue, usize)>),341}342impl StrValue {343	pub fn concat(a: Self, b: Self) -> Self {344		// TODO: benchmark for an optimal value, currently just a arbitrary choice345		const STRING_EXTEND_THRESHOLD: usize = 100;346347		if a.is_empty() {348			b349		} else if b.is_empty() {350			a351		} else if a.len() + b.len() < STRING_EXTEND_THRESHOLD {352			Self::Flat(format!("{a}{b}").into())353		} else {354			let len = a.len() + b.len();355			Self::Tree(Rc::new((a, b, len)))356		}357	}358	pub fn into_flat(&self) -> IStr {359		#[cold]360		fn write_buf(s: &StrValue, out: &mut String) {361			match s {362				StrValue::Flat(f) => out.push_str(f),363				StrValue::Tree(t) => {364					write_buf(&t.0, out);365					write_buf(&t.1, out);366				}367			}368		}369		match self {370			Self::Flat(f) => f.clone(),371			Self::Tree(_) => {372				let mut buf = String::with_capacity(self.len());373				write_buf(self, &mut buf);374				buf.into()375			}376		}377	}378	pub fn len(&self) -> usize {379		match self {380			Self::Flat(v) => v.len(),381			Self::Tree(t) => t.2,382		}383	}384	pub fn is_empty(&self) -> bool {385		match self {386			Self::Flat(v) => v.is_empty(),387			// Can't create non-flat empty string388			Self::Tree(_) => false,389		}390	}391}392impl<T> From<T> for StrValue393where394	IStr: From<T>,395{396	fn from(value: T) -> Self {397		Self::Flat(IStr::from(value))398	}399}400impl Display for StrValue {401	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {402		match self {403			Self::Flat(v) => write!(f, "{v}"),404			Self::Tree(t) => {405				write!(f, "{}", t.0)?;406				write!(f, "{}", t.1)407			}408		}409	}410}411impl PartialEq for StrValue {412	// False positive, into_flat returns not StrValue, but IStr, thus no infinite recursion here.413	#[allow(clippy::unconditional_recursion)]414	fn eq(&self, other: &Self) -> bool {415		let a = self.clone().into_flat();416		let b = other.clone().into_flat();417		a == b418	}419}420impl Eq for StrValue {}421impl PartialOrd for StrValue {422	fn partial_cmp(&self, other: &Self) -> Option<Ordering> {423		Some(self.cmp(other))424	}425}426impl Ord for StrValue {427	fn cmp(&self, other: &Self) -> Ordering {428		let a = self.clone().into_flat();429		let b = other.clone().into_flat();430		a.cmp(&b)431	}432}433434/// Represents jsonnet number435/// Jsonnet numbers are finite f64, with NaNs disallowed436#[derive(Trace, Clone, Copy)]437#[repr(transparent)]438pub struct NumValue(f64);439impl NumValue {440	/// Creates a [`NumValue`], if value is finite and not NaN441	pub fn new(v: f64) -> Option<Self> {442		if !v.is_finite() {443			return None;444		}445		Some(Self(v))446	}447	#[inline]448	pub const fn get(&self) -> f64 {449		self.0450	}451	pub(crate) fn truncate_for_bitwise(self) -> Result<i64> {452		if self.0 < MIN_SAFE_INTEGER || self.0 > MAX_SAFE_INTEGER {453			bail!("numberic value outside of safe integer range for bitwise operation");454		}455		#[expect(clippy::cast_possible_truncation, reason = "intended")]456		Ok(self.0 as i64)457	}458}459impl PartialEq for NumValue {460	fn eq(&self, other: &Self) -> bool {461		self.0 == other.0462	}463}464impl Eq for NumValue {}465impl Ord for NumValue {466	#[inline]467	fn cmp(&self, other: &Self) -> Ordering {468		// Can't use `total_cmp`: its behavior for `-0` and `0`469		// is not following wanted.470		unsafe { self.0.partial_cmp(&other.0).unwrap_unchecked() }471	}472}473impl PartialOrd for NumValue {474	#[inline]475	fn partial_cmp(&self, other: &Self) -> Option<Ordering> {476		Some(self.cmp(other))477	}478}479impl Debug for NumValue {480	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {481		Debug::fmt(&self.0, f)482	}483}484impl Display for NumValue {485	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {486		Display::fmt(&self.0, f)487	}488}489impl Deref for NumValue {490	type Target = f64;491492	#[inline]493	fn deref(&self) -> &Self::Target {494		&self.0495	}496}497macro_rules! impl_num {498	($($ty:ty),+) => {$(499		impl From<$ty> for NumValue {500			#[inline]501			fn from(value: $ty) -> Self {502				Self(value.into())503			}504		}505	)+};506}507impl_num!(i8, u8, i16, u16, i32, u32);508509#[derive(Clone, Copy, Debug, Error, Trace)]510pub enum ConvertNumValueError {511	#[error("overflow")]512	Overflow,513	#[error("underflow")]514	Underflow,515	#[error("non-finite")]516	NonFinite,517}518impl From<ConvertNumValueError> for Error {519	fn from(e: ConvertNumValueError) -> Self {520		Self::new(e.into())521	}522}523524macro_rules! impl_try_num {525	($($ty:ty),+) => {$(526		impl TryFrom<$ty> for NumValue {527			type Error = ConvertNumValueError;528			#[inline]529			fn try_from(value: $ty) -> Result<Self, ConvertNumValueError> {530				#[expect(clippy::cast_precision_loss, reason = "precision loss is explicitly handled")]531				let value = value as f64;532				if value < MIN_SAFE_INTEGER {533					return Err(ConvertNumValueError::Underflow)534				} else if value > MAX_SAFE_INTEGER {535					return Err(ConvertNumValueError::Overflow)536				}537				// Number is finite.538				Ok(Self(value))539			}540		}541	)+};542}543impl_try_num!(usize, isize, i64, u64);544545impl TryFrom<f64> for NumValue {546	type Error = ConvertNumValueError;547548	#[inline]549	fn try_from(value: f64) -> Result<Self, Self::Error> {550		Self::new(value).ok_or(ConvertNumValueError::NonFinite)551	}552}553impl TryFrom<f32> for NumValue {554	type Error = ConvertNumValueError;555556	#[inline]557	fn try_from(value: f32) -> Result<Self, Self::Error> {558		Self::new(f64::from(value)).ok_or(ConvertNumValueError::NonFinite)559	}560}561562/// Represents any valid Jsonnet value.563#[derive(Debug, Clone, Trace, Default)]564pub enum Val {565	/// Represents a Jsonnet boolean.566	Bool(bool),567	/// Represents a Jsonnet null value.568	#[default]569	Null,570	/// Represents a Jsonnet string.571	Str(StrValue),572	/// Represents a Jsonnet number.573	/// Should be finite, and not NaN574	/// This restriction isn't enforced by enum, as enum field can't be marked as private575	Num(NumValue),576	/// Experimental bigint577	#[cfg(feature = "exp-bigint")]578	BigInt(#[trace(skip)] Box<num_bigint::BigInt>),579	/// Represents a Jsonnet array.580	Arr(ArrValue),581	/// Represents a Jsonnet object.582	Obj(ObjValue),583	/// Represents a Jsonnet function.584	Func(FuncVal),585}586587#[cfg(target_pointer_width = "64")]588static_assertions::assert_eq_size!(Val, [u8; 24]);589590impl From<IndexableVal> for Val {591	fn from(v: IndexableVal) -> Self {592		match v {593			IndexableVal::Str(s) => Self::string(s),594			IndexableVal::Arr(a) => Self::Arr(a),595		}596	}597}598599impl Val {600	pub const fn as_bool(&self) -> Option<bool> {601		match self {602			Self::Bool(v) => Some(*v),603			_ => None,604		}605	}606	pub const fn as_null(&self) -> Option<()> {607		match self {608			Self::Null => Some(()),609			_ => None,610		}611	}612	pub fn as_str(&self) -> Option<IStr> {613		match self {614			Self::Str(s) => Some(s.clone().into_flat()),615			_ => None,616		}617	}618	pub const fn as_num(&self) -> Option<f64> {619		match self {620			Self::Num(n) => Some(n.get()),621			_ => None,622		}623	}624	#[cfg(feature = "exp-bigint")]625	pub fn as_bigint(&self) -> Option<num_bigint::BigInt> {626		match self {627			Self::BigInt(n) => Some(*n.clone()),628			_ => None,629		}630	}631	pub fn as_arr(&self) -> Option<ArrValue> {632		match self {633			Self::Arr(a) => Some(a.clone()),634			_ => None,635		}636	}637	pub fn as_obj(&self) -> Option<ObjValue> {638		match self {639			Self::Obj(o) => Some(o.clone()),640			_ => None,641		}642	}643	pub fn as_func(&self) -> Option<FuncVal> {644		match self {645			Self::Func(f) => Some(f.clone()),646			_ => None,647		}648	}649650	pub const fn value_type(&self) -> ValType {651		match self {652			Self::Str(..) => ValType::Str,653			Self::Num(..) => ValType::Num,654			#[cfg(feature = "exp-bigint")]655			Self::BigInt(..) => ValType::BigInt,656			Self::Arr(..) => ValType::Arr,657			Self::Obj(..) => ValType::Obj,658			Self::Bool(_) => ValType::Bool,659			Self::Null => ValType::Null,660			Self::Func(..) => ValType::Func,661		}662	}663664	pub fn manifest(&self, format: impl ManifestFormat) -> Result<String> {665		fn manifest_dyn(val: &Val, manifest: &dyn ManifestFormat) -> Result<String> {666			manifest.manifest(val.clone())667		}668		manifest_dyn(self, &format)669	}670671	pub fn to_string(&self) -> Result<IStr> {672		Ok(match self {673			Self::Bool(true) => "true".into(),674			Self::Bool(false) => "false".into(),675			Self::Null => "null".into(),676			Self::Str(s) => s.clone().into_flat(),677			_ => self.manifest(ToStringFormat).map(IStr::from)?,678		})679	}680681	pub fn into_indexable(self) -> Result<IndexableVal> {682		Ok(match self {683			Self::Str(s) => IndexableVal::Str(s.into_flat()),684			Self::Arr(arr) => IndexableVal::Arr(arr),685			_ => bail!(ValueIsNotIndexable(self.value_type())),686		})687	}688689	pub fn function(function: impl Into<FuncVal>) -> Self {690		Self::Func(function.into())691	}692	pub fn string(string: impl Into<StrValue>) -> Self {693		Self::Str(string.into())694	}695	pub fn num(num: impl Into<NumValue>) -> Self {696		Self::Num(num.into())697	}698	pub fn try_num<V, E>(num: V) -> Result<Self, E>699	where700		NumValue: TryFrom<V, Error = E>,701	{702		Ok(Self::Num(num.try_into()?))703	}704	pub fn arr(a: impl ArrayLike) -> Self {705		Self::Arr(ArrValue::new(a))706	}707}708709impl From<IStr> for Val {710	fn from(value: IStr) -> Self {711		Self::string(value)712	}713}714impl From<String> for Val {715	fn from(value: String) -> Self {716		Self::string(value)717	}718}719impl From<&str> for Val {720	fn from(value: &str) -> Self {721		Self::string(value)722	}723}724impl From<ObjValue> for Val {725	fn from(value: ObjValue) -> Self {726		Self::Obj(value)727	}728}729730const fn is_function_like(val: &Val) -> bool {731	matches!(val, Val::Func(_))732}733734/// Native implementation of `std.primitiveEquals`735pub fn primitive_equals(val_a: &Val, val_b: &Val) -> Result<bool> {736	Ok(match (val_a, val_b) {737		(Val::Bool(a), Val::Bool(b)) => a == b,738		(Val::Null, Val::Null) => true,739		(Val::Str(a), Val::Str(b)) => a == b,740		(Val::Num(a), Val::Num(b)) => (a.get() - b.get()).abs() <= f64::EPSILON,741		#[cfg(feature = "exp-bigint")]742		(Val::BigInt(a), Val::BigInt(b)) => a == b,743		(Val::Arr(_), Val::Arr(_)) => {744			bail!("primitiveEquals operates on primitive types, got array")745		}746		(Val::Obj(_), Val::Obj(_)) => {747			bail!("primitiveEquals operates on primitive types, got object")748		}749		(a, b) if is_function_like(a) && is_function_like(b) => {750			bail!("cannot test equality of functions")751		}752		(_, _) => false,753	})754}755756/// Native implementation of `std.equals`757pub fn equals(val_a: &Val, val_b: &Val) -> Result<bool> {758	if val_a.value_type() != val_b.value_type() {759		return Ok(false);760	}761	match (val_a, val_b) {762		(Val::Arr(a), Val::Arr(b)) => {763			if ArrValue::ptr_eq(a, b) {764				return Ok(true);765			}766			if a.len() != b.len() {767				return Ok(false);768			}769			for (a, b) in a.iter().zip(b.iter()) {770				if !equals(&a?, &b?)? {771					return Ok(false);772				}773			}774			Ok(true)775		}776		(Val::Obj(a), Val::Obj(b)) => {777			if ObjValue::ptr_eq(a, b) {778				return Ok(true);779			}780			let fields = a.fields(781				#[cfg(feature = "exp-preserve-order")]782				false,783			);784			if fields785				!= b.fields(786					#[cfg(feature = "exp-preserve-order")]787					false,788				) {789				return Ok(false);790			}791			for field in fields {792				if !equals(793					&a.get(field.clone())?.expect("field exists"),794					&b.get(field)?.expect("field exists"),795				)? {796					return Ok(false);797				}798			}799			Ok(true)800		}801		(a, b) => Ok(primitive_equals(a, b)?),802	}803}