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

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs10.9 KiBsourcehistory
1use std::{2	cell::{Ref, RefCell, RefMut},3	collections::HashMap,4	rc::Rc,5};67use jrsonnet_evaluator::{8	error::{ErrorKind::*, Result},9	function::{builtin::Builtin, CallLocation, FuncVal, TlaArg},10	gc::{GcHashMap, TraceBox},11	tb,12	trace::PathResolver,13	Context, ContextBuilder, IStr, ObjValue, ObjValueBuilder, State, Thunk, Val,14};15use jrsonnet_gcmodule::{Cc, Trace};16use jrsonnet_parser::Source;1718mod expr;19mod types;20pub use types::*;21mod arrays;22pub use arrays::*;23mod math;24pub use math::*;25mod operator;26pub use operator::*;27mod sort;28pub use sort::*;29mod hash;30pub use hash::*;31mod encoding;32pub use encoding::*;33mod objects;34pub use objects::*;35mod manifest;36pub use manifest::*;37mod parse;38pub use parse::*;39mod strings;40pub use strings::*;41mod misc;42pub use misc::*;43mod sets;44pub use sets::*;45mod compat;46pub use compat::*;4748pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {49	let mut builder = ObjValueBuilder::new();5051	let expr = expr::stdlib_expr();52	let eval = jrsonnet_evaluator::evaluate(ContextBuilder::dangerous_empty_state().build(), &expr)53		.expect("stdlib.jsonnet should have no errors")54		.as_obj()55		.expect("stdlib.jsonnet should evaluate to object");5657	builder.with_super(eval);5859	for (name, builtin) in [60		// Types61		("type", builtin_type::INST),62		("isString", builtin_is_string::INST),63		("isNumber", builtin_is_number::INST),64		("isBoolean", builtin_is_boolean::INST),65		("isObject", builtin_is_object::INST),66		("isArray", builtin_is_array::INST),67		("isFunction", builtin_is_function::INST),68		// Arrays69		("makeArray", builtin_make_array::INST),70		("repeat", builtin_repeat::INST),71		("slice", builtin_slice::INST),72		("map", builtin_map::INST),73		("flatMap", builtin_flatmap::INST),74		("filter", builtin_filter::INST),75		("foldl", builtin_foldl::INST),76		("foldr", builtin_foldr::INST),77		("range", builtin_range::INST),78		("join", builtin_join::INST),79		("reverse", builtin_reverse::INST),80		("any", builtin_any::INST),81		("all", builtin_all::INST),82		("member", builtin_member::INST),83		("contains", builtin_member::INST),84		("count", builtin_count::INST),85		("avg", builtin_avg::INST),86		// Math87		("abs", builtin_abs::INST),88		("sign", builtin_sign::INST),89		("max", builtin_max::INST),90		("min", builtin_min::INST),91		("sum", builtin_sum::INST),92		("modulo", builtin_modulo::INST),93		("floor", builtin_floor::INST),94		("ceil", builtin_ceil::INST),95		("log", builtin_log::INST),96		("pow", builtin_pow::INST),97		("sqrt", builtin_sqrt::INST),98		("sin", builtin_sin::INST),99		("cos", builtin_cos::INST),100		("tan", builtin_tan::INST),101		("asin", builtin_asin::INST),102		("acos", builtin_acos::INST),103		("atan", builtin_atan::INST),104		("exp", builtin_exp::INST),105		("mantissa", builtin_mantissa::INST),106		("exponent", builtin_exponent::INST),107		("round", builtin_round::INST),108		("isEven", builtin_is_even::INST),109		("isOdd", builtin_is_odd::INST),110		("isInteger", builtin_is_integer::INST),111		("isDecimal", builtin_is_decimal::INST),112		// Operator113		("mod", builtin_mod::INST),114		("primitiveEquals", builtin_primitive_equals::INST),115		("equals", builtin_equals::INST),116		("xor", builtin_xor::INST),117		("format", builtin_format::INST),118		// Sort119		("sort", builtin_sort::INST),120		("uniq", builtin_uniq::INST),121		("set", builtin_set::INST),122		("minArray", builtin_min_array::INST),123		("maxArray", builtin_max_array::INST),124		// Hash125		("md5", builtin_md5::INST),126		("sha256", builtin_sha256::INST),127		("sha512", builtin_sha512::INST),128		// Encoding129		("encodeUTF8", builtin_encode_utf8::INST),130		("decodeUTF8", builtin_decode_utf8::INST),131		("base64", builtin_base64::INST),132		("base64Decode", builtin_base64_decode::INST),133		("base64DecodeBytes", builtin_base64_decode_bytes::INST),134		// Objects135		("objectFieldsEx", builtin_object_fields_ex::INST),136		("objectHasEx", builtin_object_has_ex::INST),137		// Manifest138		("escapeStringJson", builtin_escape_string_json::INST),139		("manifestJsonEx", builtin_manifest_json_ex::INST),140		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),141		("manifestTomlEx", builtin_manifest_toml_ex::INST),142		// Parsing143		("parseJson", builtin_parse_json::INST),144		("parseYaml", builtin_parse_yaml::INST),145		// Strings146		("codepoint", builtin_codepoint::INST),147		("substr", builtin_substr::INST),148		("char", builtin_char::INST),149		("strReplace", builtin_str_replace::INST),150		("splitLimit", builtin_splitlimit::INST),151		("asciiUpper", builtin_ascii_upper::INST),152		("asciiLower", builtin_ascii_lower::INST),153		("findSubstr", builtin_find_substr::INST),154		("parseInt", builtin_parse_int::INST),155		#[cfg(feature = "exp-bigint")]156		("bigint", builtin_bigint::INST),157		("parseOctal", builtin_parse_octal::INST),158		("parseHex", builtin_parse_hex::INST),159		// Misc160		("length", builtin_length::INST),161		("startsWith", builtin_starts_with::INST),162		("endsWith", builtin_ends_with::INST),163		// Sets164		("setMember", builtin_set_member::INST),165		("setInter", builtin_set_inter::INST),166		// Compat167		("__compare", builtin___compare::INST),168	]169	.iter()170	.cloned()171	{172		builder173			.member(name.into())174			.hide()175			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))176			.expect("no conflict");177	}178179	builder180		.member("extVar".into())181		.hide()182		.value(Val::Func(FuncVal::builtin(builtin_ext_var {183			settings: settings.clone(),184		})))185		.expect("no conflict");186	builder187		.member("native".into())188		.hide()189		.value(Val::Func(FuncVal::builtin(builtin_native {190			settings: settings.clone(),191		})))192		.expect("no conflict");193	builder194		.member("trace".into())195		.hide()196		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))197		.expect("no conflict");198199	builder200		.member("id".into())201		.hide()202		.value(Val::Func(FuncVal::Id))203		.expect("no conflict");204205	builder.build()206}207208pub trait TracePrinter {209	fn print_trace(&self, loc: CallLocation, value: IStr);210}211212pub struct StdTracePrinter {213	resolver: PathResolver,214}215impl StdTracePrinter {216	pub fn new(resolver: PathResolver) -> Self {217		Self { resolver }218	}219}220impl TracePrinter for StdTracePrinter {221	fn print_trace(&self, loc: CallLocation, value: IStr) {222		eprint!("TRACE:");223		if let Some(loc) = loc.0 {224			let locs = loc.0.map_source_locations(&[loc.1]);225			eprint!(226				" {}:{}",227				match loc.0.source_path().path() {228					Some(p) => self.resolver.resolve(p),229					None => loc.0.source_path().to_string(),230				},231				locs[0].line232			);233		}234		eprintln!(" {value}");235	}236}237238pub struct Settings {239	/// Used for `std.extVar`240	pub ext_vars: HashMap<IStr, TlaArg>,241	/// Used for `std.native`242	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,243	/// Helper to add globals without implementing custom ContextInitializer244	pub globals: GcHashMap<IStr, Thunk<Val>>,245	/// Used for `std.trace`246	pub trace_printer: Box<dyn TracePrinter>,247	/// Used for `std.thisFile`248	pub path_resolver: PathResolver,249}250251fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {252	let source_name = format!("<extvar:{name}>");253	Source::new_virtual(source_name.into(), code.into())254}255256#[derive(Trace, Clone)]257pub struct ContextInitializer {258	// When we don't need to support legacy-this-file, we can reuse same context for all files259	#[cfg(not(feature = "legacy-this-file"))]260	context: Context,261	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it262	#[cfg(feature = "legacy-this-file")]263	stdlib_obj: ObjValue,264	settings: Rc<RefCell<Settings>>,265}266impl ContextInitializer {267	pub fn new(_s: State, resolver: PathResolver) -> Self {268		let settings = Settings {269			ext_vars: Default::default(),270			ext_natives: Default::default(),271			globals: Default::default(),272			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),273			path_resolver: resolver,274		};275		let settings = Rc::new(RefCell::new(settings));276		Self {277			#[cfg(not(feature = "legacy-this-file"))]278			context: {279				let mut context = ContextBuilder::with_capacity(_s, 1);280				context.bind(281					"std".into(),282					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),283				);284				context.build()285			},286			#[cfg(feature = "legacy-this-file")]287			stdlib_obj: stdlib_uncached(settings.clone()),288			settings,289		}290	}291	pub fn settings(&self) -> Ref<Settings> {292		self.settings.borrow()293	}294	pub fn settings_mut(&self) -> RefMut<Settings> {295		self.settings.borrow_mut()296	}297	pub fn add_ext_var(&self, name: IStr, value: Val) {298		self.settings_mut()299			.ext_vars300			.insert(name, TlaArg::Val(value));301	}302	pub fn add_ext_str(&self, name: IStr, value: IStr) {303		self.settings_mut()304			.ext_vars305			.insert(name, TlaArg::String(value));306	}307	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {308		let code = code.into();309		let source = extvar_source(name, code.clone());310		let parsed = jrsonnet_parser::parse(311			&code,312			&jrsonnet_parser::ParserSettings {313				source: source.clone(),314			},315		)316		.map_err(|e| ImportSyntaxError {317			path: source,318			error: Box::new(e),319		})?;320		// self.data_mut().volatile_files.insert(source_name, code);321		self.settings_mut()322			.ext_vars323			.insert(name.into(), TlaArg::Code(parsed));324		Ok(())325	}326	pub fn add_native(&self, name: IStr, cb: impl Builtin) {327		self.settings_mut()328			.ext_natives329			.insert(name, Cc::new(tb!(cb)));330	}331}332impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {333	#[cfg(not(feature = "legacy-this-file"))]334	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {335		let out = self.context.clone();336		let globals = &self.settings().globals;337		if globals.is_empty() {338			return out;339		}340341		let mut out = ContextBuilder::extend(out);342		for (k, v) in globals.iter() {343			out.bind(k.clone(), v.clone());344		}345		out.build()346	}347	#[cfg(feature = "legacy-this-file")]348	fn initialize(&self, s: State, source: Source) -> Context {349		use jrsonnet_evaluator::val::StrValue;350351		let mut builder = ObjValueBuilder::new();352		builder.with_super(self.stdlib_obj.clone());353		builder354			.member("thisFile".into())355			.hide()356			.value(Val::Str(StrValue::Flat(357				match source.source_path().path() {358					Some(p) => self.settings().path_resolver.resolve(p).into(),359					None => source.source_path().to_string().into(),360				},361			)))362			.expect("this object builder is empty");363		let stdlib_with_this_file = builder.build();364365		let mut context = ContextBuilder::with_capacity(s, 1);366		context.bind(367			"std".into(),368			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),369		);370		for (k, v) in self.settings().globals.iter() {371			context.bind(k.clone(), v.clone());372		}373		context.build()374	}375	fn as_any(&self) -> &dyn std::any::Any {376		self377	}378}379380pub trait StateExt {381	/// This method was previously implemented in jrsonnet-evaluator itself382	fn with_stdlib(&self);383	fn add_global(&self, name: IStr, value: Thunk<Val>);384}385386impl StateExt for State {387	fn with_stdlib(&self) {388		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());389		self.settings_mut().context_initializer = tb!(initializer)390	}391	fn add_global(&self, name: IStr, value: Thunk<Val>) {392		self.settings()393			.context_initializer394			.as_any()395			.downcast_ref::<ContextInitializer>()396			.expect("not standard context initializer")397			.settings_mut()398			.globals399			.insert(name, value);400	}401}