git.delta.rocks / jrsonnet / refs/commits / 4c21363ed30a

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs13.0 KiBsourcehistory
1use std::{2	borrow::Cow,3	cell::{Ref, RefCell, RefMut},4	collections::HashMap,5	rc::Rc,6};78use jrsonnet_evaluator::{9	error::{Error::*, Result},10	function::{builtin::Builtin, ArgLike, CallLocation, FuncVal, TlaArg},11	gc::TraceBox,12	tb, throw_runtime,13	typed::{Any, Either, Either2, Either4, VecVal, M1},14	val::{equals, ArrValue},15	Context, ContextBuilder, IStr, ObjValue, ObjValueBuilder, State, Thunk, Val,16};17use jrsonnet_gcmodule::Cc;18use jrsonnet_macros::builtin;19use jrsonnet_parser::Source;2021mod expr;22mod types;23pub use types::*;24mod arrays;25pub use arrays::*;26mod math;27pub use math::*;28mod operator;29pub use operator::*;30mod sort;31pub use sort::*;32mod hash;33pub use hash::*;34mod encoding;35pub use encoding::*;36mod objects;37pub use objects::*;38mod manifest;39pub use manifest::*;40mod parse;41pub use parse::*;4243pub fn stdlib_uncached(s: State, settings: Rc<RefCell<Settings>>) -> ObjValue {44	let mut builder = ObjValueBuilder::new();4546	let expr = expr::stdlib_expr();47	let eval = jrsonnet_evaluator::evaluate(s.clone(), Context::default(), &expr)48		.expect("stdlib.jsonnet should have no errors")49		.as_obj()50		.expect("stdlib.jsonnet should evaluate to object");5152	builder.with_super(eval);5354	for (name, builtin) in [55		("length".into(), builtin_length::INST),56		// Types57		("type".into(), builtin_type::INST),58		("isString".into(), builtin_is_string::INST),59		("isNumber".into(), builtin_is_number::INST),60		("isBoolean".into(), builtin_is_boolean::INST),61		("isObject".into(), builtin_is_object::INST),62		("isArray".into(), builtin_is_array::INST),63		("isFunction".into(), builtin_is_function::INST),64		// Arrays65		("makeArray".into(), builtin_make_array::INST),66		("slice".into(), builtin_slice::INST),67		("map".into(), builtin_map::INST),68		("flatMap".into(), builtin_flatmap::INST),69		("filter".into(), builtin_filter::INST),70		("foldl".into(), builtin_foldl::INST),71		("foldr".into(), builtin_foldr::INST),72		("range".into(), builtin_range::INST),73		("join".into(), builtin_join::INST),74		("reverse".into(), builtin_reverse::INST),75		("any".into(), builtin_any::INST),76		("all".into(), builtin_all::INST),77		("member".into(), builtin_member::INST),78		("count".into(), builtin_count::INST),79		// Math80		("modulo".into(), builtin_modulo::INST),81		("floor".into(), builtin_floor::INST),82		("ceil".into(), builtin_ceil::INST),83		("log".into(), builtin_log::INST),84		("pow".into(), builtin_pow::INST),85		("sqrt".into(), builtin_sqrt::INST),86		("sin".into(), builtin_sin::INST),87		("cos".into(), builtin_cos::INST),88		("tan".into(), builtin_tan::INST),89		("asin".into(), builtin_asin::INST),90		("acos".into(), builtin_acos::INST),91		("atan".into(), builtin_atan::INST),92		("exp".into(), builtin_exp::INST),93		("mantissa".into(), builtin_mantissa::INST),94		("exponent".into(), builtin_exponent::INST),95		// Operator96		("mod".into(), builtin_mod::INST),97		("primitiveEquals".into(), builtin_primitive_equals::INST),98		("equals".into(), builtin_equals::INST),99		("format".into(), builtin_format::INST),100		// Sort101		("sort".into(), builtin_sort::INST),102		// Hash103		("md5".into(), builtin_md5::INST),104		// Encoding105		("encodeUTF8".into(), builtin_encode_utf8::INST),106		("decodeUTF8".into(), builtin_decode_utf8::INST),107		("base64".into(), builtin_base64::INST),108		("base64Decode".into(), builtin_base64_decode::INST),109		(110			"base64DecodeBytes".into(),111			builtin_base64_decode_bytes::INST,112		),113		// Objects114		("objectFieldsEx".into(), builtin_object_fields_ex::INST),115		("objectHasEx".into(), builtin_object_has_ex::INST),116		// Manifest117		("escapeStringJson".into(), builtin_escape_string_json::INST),118		("manifestJsonEx".into(), builtin_manifest_json_ex::INST),119		("manifestYamlDoc".into(), builtin_manifest_yaml_doc::INST),120		// Parsing121		("parseJson".into(), builtin_parse_json::INST),122		("parseYaml".into(), builtin_parse_yaml::INST),123		// Misc124		("codepoint".into(), builtin_codepoint::INST),125		("substr".into(), builtin_substr::INST),126		("char".into(), builtin_char::INST),127		("strReplace".into(), builtin_str_replace::INST),128		("splitLimit".into(), builtin_splitlimit::INST),129		("asciiUpper".into(), builtin_ascii_upper::INST),130		("asciiLower".into(), builtin_ascii_lower::INST),131		("findSubstr".into(), builtin_find_substr::INST),132		("startsWith".into(), builtin_starts_with::INST),133		("endsWith".into(), builtin_ends_with::INST),134	]135	.iter()136	.cloned()137	{138		builder139			.member(name)140			.hide()141			.value(s.clone(), Val::Func(FuncVal::StaticBuiltin(builtin)))142			.expect("no conflict");143	}144145	builder146		.member("extVar".into())147		.hide()148		.value(149			s.clone(),150			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_ext_var {151				settings: settings.clone()152			})))),153		)154		.expect("no conflict");155	builder156		.member("native".into())157		.hide()158		.value(159			s.clone(),160			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_native {161				settings: settings.clone()162			})))),163		)164		.expect("no conflict");165	builder166		.member("trace".into())167		.hide()168		.value(169			s.clone(),170			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_trace { settings })))),171		)172		.expect("no conflict");173174	builder175		.member("id".into())176		.hide()177		.value(s, Val::Func(FuncVal::Id))178		.expect("no conflict");179180	builder.build()181}182183pub trait TracePrinter {184	fn print_trace(&self, s: State, loc: CallLocation, value: IStr);185}186187pub struct StdTracePrinter;188impl TracePrinter for StdTracePrinter {189	fn print_trace(&self, _s: State, loc: CallLocation, value: IStr) {190		eprint!("TRACE:");191		if let Some(loc) = loc.0 {192			let locs = loc.0.map_source_locations(&[loc.1]);193			eprint!(" {}:{}", loc.0.short_display(), locs[0].line);194		}195		eprintln!(" {}", value);196	}197}198199pub struct Settings {200	/// Used for `std.extVar`201	pub ext_vars: HashMap<IStr, TlaArg>,202	/// Used for `std.native`203	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,204	/// Used for `std.trace`205	pub trace_printer: Box<dyn TracePrinter>,206}207208impl Default for Settings {209	fn default() -> Self {210		Self {211			ext_vars: Default::default(),212			ext_natives: Default::default(),213			trace_printer: Box::new(StdTracePrinter),214		}215	}216}217218pub fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {219	let source_name = format!("<extvar:{}>", name);220	Source::new_virtual(Cow::Owned(source_name), code.into())221}222223pub struct ContextInitializer {224	// When we don't need to support legacy-this-file, we can reuse same context for all files225	#[cfg(not(feature = "legacy-this-file"))]226	context: Context,227	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it228	#[cfg(feature = "legacy-this-file")]229	stdlib_obj: ObjValue,230	settings: Rc<RefCell<Settings>>,231}232impl ContextInitializer {233	pub fn new(s: State) -> Self {234		let settings = Rc::new(RefCell::new(Settings::default()));235		Self {236			#[cfg(not(feature = "legacy-this-file"))]237			context: {238				let mut context = ContextBuilder::with_capacity(1);239				context.bind(240					"std".into(),241					Thunk::evaluated(Val::Obj(stdlib_uncached(s, settings.clone()))),242				);243				context.build()244			},245			#[cfg(feature = "legacy-this-file")]246			stdlib_obj: stdlib_uncached(s, settings.clone()),247			settings,248		}249	}250	pub fn settings(&self) -> Ref<Settings> {251		self.settings.borrow()252	}253	pub fn settings_mut(&self) -> RefMut<Settings> {254		self.settings.borrow_mut()255	}256	pub fn add_ext_var(&self, name: IStr, value: Val) {257		self.settings_mut()258			.ext_vars259			.insert(name, TlaArg::Val(value));260	}261	pub fn add_ext_str(&self, name: IStr, value: IStr) {262		self.settings_mut()263			.ext_vars264			.insert(name, TlaArg::String(value));265	}266	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {267		let code = code.into();268		let source = extvar_source(name, code.clone());269		let parsed = jrsonnet_parser::parse(270			&code,271			&jrsonnet_parser::ParserSettings {272				file_name: source.clone(),273			},274		)275		.map_err(|e| ImportSyntaxError {276			path: source,277			error: Box::new(e),278		})?;279		// self.data_mut().volatile_files.insert(source_name, code);280		self.settings_mut()281			.ext_vars282			.insert(name.into(), TlaArg::Code(parsed));283		Ok(())284	}285	pub fn add_native(&self, name: IStr, cb: Cc<TraceBox<dyn Builtin>>) {286		self.settings_mut().ext_natives.insert(name, cb);287	}288}289impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {290	#[cfg(not(feature = "legacy-this-file"))]291	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {292		self.context.clone()293	}294	#[cfg(feature = "legacy-this-file")]295	fn initialize(&self, s: State, source: Source) -> jrsonnet_evaluator::Context {296		let mut builder = ObjValueBuilder::new();297		builder.with_super(self.stdlib_obj.clone());298		builder299			.member("thisFile".into())300			.hide()301			.value(302				s,303				Val::Str(304					source305						.path()306						.map(|p| p.display().to_string())307						.unwrap_or_else(String::new)308						.into(),309				),310			)311			.expect("this object builder is empty");312		let stdlib_with_this_file = builder.build();313314		let mut context = ContextBuilder::with_capacity(1);315		context.bind(316			"std".into(),317			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),318		);319		context.build()320	}321	unsafe fn as_any(&self) -> &dyn std::any::Any {322		self323	}324}325326#[builtin]327fn builtin_length(x: Either![IStr, ArrValue, ObjValue, FuncVal]) -> Result<usize> {328	use Either4::*;329	Ok(match x {330		A(x) => x.chars().count(),331		B(x) => x.len(),332		C(x) => x.len(),333		D(f) => f.params_len(),334	})335}336337#[builtin]338const fn builtin_codepoint(str: char) -> Result<u32> {339	Ok(str as u32)340}341342#[builtin]343fn builtin_substr(str: IStr, from: usize, len: usize) -> Result<String> {344	Ok(str.chars().skip(from as usize).take(len as usize).collect())345}346347#[builtin(fields(348	settings: Rc<RefCell<Settings>>,349))]350fn builtin_ext_var(this: &builtin_ext_var, s: State, x: IStr) -> Result<Any> {351	let ctx = s.create_default_context(extvar_source(&x, ""));352	Ok(Any(this353		.settings354		.borrow()355		.ext_vars356		.get(&x)357		.cloned()358		.ok_or(UndefinedExternalVariable(x))?359		.evaluate_arg(s.clone(), ctx, true)?360		.evaluate(s)?))361}362363#[builtin(fields(364	settings: Rc<RefCell<Settings>>,365))]366fn builtin_native(this: &builtin_native, name: IStr) -> Result<Any> {367	Ok(Any(this368		.settings369		.borrow()370		.ext_natives371		.get(&name)372		.cloned()373		.map_or(Val::Null, |v| {374			Val::Func(FuncVal::Builtin(v.clone()))375		})))376}377378#[builtin]379fn builtin_char(n: u32) -> Result<char> {380	Ok(std::char::from_u32(n as u32).ok_or(InvalidUnicodeCodepointGot(n as u32))?)381}382383#[builtin(fields(384	settings: Rc<RefCell<Settings>>,385))]386fn builtin_trace(387	this: &builtin_trace,388	s: State,389	loc: CallLocation,390	str: IStr,391	rest: Thunk<Val>,392) -> Result<Any> {393	this.settings394		.borrow()395		.trace_printer396		.print_trace(s.clone(), loc, str);397	Ok(Any(rest.evaluate(s)?))398}399400#[builtin]401fn builtin_str_replace(str: String, from: IStr, to: IStr) -> Result<String> {402	Ok(str.replace(&from as &str, &to as &str))403}404405#[builtin]406fn builtin_splitlimit(str: IStr, c: IStr, maxsplits: Either![usize, M1]) -> Result<VecVal> {407	use Either2::*;408	Ok(VecVal(Cc::new(match maxsplits {409		A(n) => str410			.splitn(n + 1, &c as &str)411			.map(|s| Val::Str(s.into()))412			.collect(),413		B(_) => str.split(&c as &str).map(|s| Val::Str(s.into())).collect(),414	})))415}416417#[builtin]418fn builtin_ascii_upper(str: IStr) -> Result<String> {419	Ok(str.to_ascii_uppercase())420}421422#[builtin]423fn builtin_ascii_lower(str: IStr) -> Result<String> {424	Ok(str.to_ascii_lowercase())425}426427#[builtin]428fn builtin_find_substr(pat: IStr, str: IStr) -> Result<ArrValue> {429	if pat.is_empty() || str.is_empty() || pat.len() > str.len() {430		return Ok(ArrValue::empty());431	}432433	let str = str.as_str();434	let pat = pat.as_bytes();435	let strb = str.as_bytes();436437	let max_pos = str.len() - pat.len();438439	let mut out: Vec<Val> = Vec::new();440	for (ch_idx, (i, _)) in str441		.char_indices()442		.take_while(|(i, _)| i <= &max_pos)443		.enumerate()444	{445		if &strb[i..i + pat.len()] == pat {446			out.push(Val::Num(ch_idx as f64))447		}448	}449	Ok(out.into())450}451452#[builtin]453fn builtin_starts_with(454	s: State,455	a: Either![IStr, ArrValue],456	b: Either![IStr, ArrValue],457) -> Result<bool> {458	Ok(match (a, b) {459		(Either2::A(a), Either2::A(b)) => a.starts_with(b.as_str()),460		(Either2::B(a), Either2::B(b)) => {461			if b.len() > a.len() {462				return Ok(false);463			} else if b.len() == a.len() {464				return equals(s, &Val::Arr(a), &Val::Arr(b));465			} else {466				for (a, b) in a467					.slice(None, Some(b.len()), None)468					.iter(s.clone())469					.zip(b.iter(s.clone()))470				{471					let a = a?;472					let b = b?;473					if !equals(s.clone(), &a, &b)? {474						return Ok(false);475					}476				}477				true478			}479		}480		_ => throw_runtime!("both arguments should be of the same type"),481	})482}483484#[builtin]485fn builtin_ends_with(486	s: State,487	a: Either![IStr, ArrValue],488	b: Either![IStr, ArrValue],489) -> Result<bool> {490	Ok(match (a, b) {491		(Either2::A(a), Either2::A(b)) => a.ends_with(b.as_str()),492		(Either2::B(a), Either2::B(b)) => {493			if b.len() > a.len() {494				return Ok(false);495			} else if b.len() == a.len() {496				return equals(s, &Val::Arr(a), &Val::Arr(b));497			} else {498				let a_len = a.len();499				for (a, b) in a500					.slice(Some(a_len - b.len()), None, None)501					.iter(s.clone())502					.zip(b.iter(s.clone()))503				{504					let a = a?;505					let b = b?;506					if !equals(s.clone(), &a, &b)? {507						return Ok(false);508					}509				}510				true511			}512		}513		_ => throw_runtime!("both arguments should be of the same type"),514	})515}