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

1use std::fmt::Debug;23pub use arglike::{ArgLike, ArgsLike, TlaArg};4use jrsonnet_gcmodule::{Cc, Trace};5use jrsonnet_interner::IStr;6pub use jrsonnet_macros::builtin;7use jrsonnet_parser::{Destruct, Expr, ExprLocation, LocExpr, ParamsDesc};89use self::{10	arglike::OptionalContext,11	builtin::{Builtin, StaticBuiltin},12	native::NativeDesc,13	parse::{parse_default_function_call, parse_function_call},14};15use crate::{evaluate, gc::TraceBox, typed::Any, Context, ContextBuilder, Result, Val};1617pub mod arglike;18pub mod builtin;19pub mod native;20pub mod parse;2122/// Function callsite location.23/// Either from other jsonnet code, specified by expression location, or from native (without location).24#[derive(Clone, Copy)]25pub struct CallLocation<'l>(pub Option<&'l ExprLocation>);26impl<'l> CallLocation<'l> {27	/// Construct new location for calls coming from specified jsonnet expression location.28	pub const fn new(loc: &'l ExprLocation) -> Self {29		Self(Some(loc))30	}31}32impl CallLocation<'static> {33	/// Construct new location for calls coming from native code.34	pub const fn native() -> Self {35		Self(None)36	}37}3839/// Represents Jsonnet function defined in code.40#[derive(Debug, PartialEq, Trace)]41pub struct FuncDesc {42	/// # Example43	///44	/// In expressions like this, deducted to `a`, unspecified otherwise.45	/// ```jsonnet46	/// local a = function() ...47	/// local a() ...48	/// { a: function() ... }49	/// { a() = ... }50	/// ```51	pub name: IStr,52	/// Context, in which this function was evaluated.53	///54	/// # Example55	/// In56	/// ```jsonnet57	/// local a = 2;58	/// function() ...59	/// ```60	/// context will contain `a`.61	pub ctx: Context,6263	/// Function parameter definition64	pub params: ParamsDesc,65	/// Function body66	pub body: LocExpr,67}68impl FuncDesc {69	/// Create body context, but fill arguments without defaults with lazy error70	pub fn default_body_context(&self) -> Result<Context> {71		parse_default_function_call(self.ctx.clone(), &self.params)72	}7374	/// Create context, with which body code will run75	pub fn call_body_context(76		&self,77		call_ctx: Context,78		args: &dyn ArgsLike,79		tailstrict: bool,80	) -> Result<Context> {81		parse_function_call(call_ctx, self.ctx.clone(), &self.params, args, tailstrict)82	}83}8485/// Represents a Jsonnet function value, including plain functions and user-provided builtins.86#[allow(clippy::module_name_repetitions)]87#[derive(Trace, Clone)]88pub enum FuncVal {89	/// Identity function, kept this way for comparsions.90	Id,91	/// Plain function implemented in jsonnet.92	Normal(Cc<FuncDesc>),93	/// Standard library function.94	StaticBuiltin(#[trace(skip)] &'static dyn StaticBuiltin),95	/// User-provided function.96	Builtin(Cc<TraceBox<dyn Builtin>>),97}9899impl Debug for FuncVal {100	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {101		match self {102			Self::Id => f.debug_tuple("Id").finish(),103			Self::Normal(arg0) => f.debug_tuple("Normal").field(arg0).finish(),104			Self::StaticBuiltin(arg0) => {105				f.debug_tuple("StaticBuiltin").field(&arg0.name()).finish()106			}107			Self::Builtin(arg0) => f.debug_tuple("Builtin").field(&arg0.name()).finish(),108		}109	}110}111112impl FuncVal {113	/// Amount of non-default required arguments114	pub fn params_len(&self) -> usize {115		match self {116			Self::Id => 1,117			Self::Normal(n) => n.params.iter().filter(|p| p.1.is_none()).count(),118			Self::StaticBuiltin(i) => i.params().iter().filter(|p| !p.has_default).count(),119			Self::Builtin(i) => i.params().iter().filter(|p| !p.has_default).count(),120		}121	}122	/// Function name, as defined in code.123	pub fn name(&self) -> IStr {124		match self {125			Self::Id => "id".into(),126			Self::Normal(normal) => normal.name.clone(),127			Self::StaticBuiltin(builtin) => builtin.name().into(),128			Self::Builtin(builtin) => builtin.name().into(),129		}130	}131	/// Call function using arguments evaluated in specified `call_ctx` [`Context`].132	///133	/// If `tailstrict` is specified - then arguments will be evaluated before being passed to function body.134	pub fn evaluate(135		&self,136		call_ctx: Context,137		loc: CallLocation<'_>,138		args: &dyn ArgsLike,139		tailstrict: bool,140	) -> Result<Val> {141		match self {142			Self::Id => {143				#[allow(clippy::unnecessary_wraps)]144				#[builtin]145				const fn builtin_id(v: Any) -> Result<Any> {146					Ok(v)147				}148				static ID: &builtin_id = &builtin_id {};149150				ID.call(call_ctx, loc, args)151			}152			Self::Normal(func) => {153				let body_ctx = func.call_body_context(call_ctx, args, tailstrict)?;154				evaluate(body_ctx, &func.body)155			}156			Self::StaticBuiltin(b) => b.call(call_ctx, loc, args),157			Self::Builtin(b) => b.call(call_ctx, loc, args),158		}159	}160	pub fn evaluate_simple<A: ArgsLike + OptionalContext>(&self, args: &A) -> Result<Val> {161		self.evaluate(162			ContextBuilder::dangerous_empty_state().build(),163			CallLocation::native(),164			args,165			true,166		)167	}168	/// Convert jsonnet function to plain `Fn` value.169	pub fn into_native<D: NativeDesc>(self) -> D::Value {170		D::into_native(self)171	}172173	/// Is this function an indentity function.174	///175	/// Currently only works for builtin `std.id`, aka `Self::Id` value, and `function(x) x`.176	///177	/// This function should only be used for optimization, not for the conditional logic, i.e code should work with syntetic identity function too178	pub fn is_identity(&self) -> bool {179		match self {180			Self::Id => true,181			Self::Normal(desc) => {182				if desc.params.len() != 1 {183					return false;184				}185				let param = &desc.params[0];186				if param.1.is_some() {187					return false;188				}189				#[allow(clippy::infallible_destructuring_match)]190				let id = match &param.0 {191					Destruct::Full(id) => id,192					#[cfg(feature = "exp-destruct")]193					_ => return false,194				};195				&desc.body.0 as &Expr == &Expr::Var(id.clone())196			}197			_ => false,198		}199	}200	/// Identity function value.201	pub const fn identity() -> Self {202		Self::Id203	}204}