git.delta.rocks / jrsonnet / refs/commits / 83c939e4fa0b

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs11.0 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		("xnor", builtin_xnor::INST),118		("format", builtin_format::INST),119		// Sort120		("sort", builtin_sort::INST),121		("uniq", builtin_uniq::INST),122		("set", builtin_set::INST),123		("minArray", builtin_min_array::INST),124		("maxArray", builtin_max_array::INST),125		// Hash126		("md5", builtin_md5::INST),127		("sha256", builtin_sha256::INST),128		("sha512", builtin_sha512::INST),129		// Encoding130		("encodeUTF8", builtin_encode_utf8::INST),131		("decodeUTF8", builtin_decode_utf8::INST),132		("base64", builtin_base64::INST),133		("base64Decode", builtin_base64_decode::INST),134		("base64DecodeBytes", builtin_base64_decode_bytes::INST),135		// Objects136		("objectFieldsEx", builtin_object_fields_ex::INST),137		("objectHasEx", builtin_object_has_ex::INST),138		// Manifest139		("escapeStringJson", builtin_escape_string_json::INST),140		("manifestJsonEx", builtin_manifest_json_ex::INST),141		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),142		("manifestTomlEx", builtin_manifest_toml_ex::INST),143		// Parsing144		("parseJson", builtin_parse_json::INST),145		("parseYaml", builtin_parse_yaml::INST),146		// Strings147		("codepoint", builtin_codepoint::INST),148		("substr", builtin_substr::INST),149		("char", builtin_char::INST),150		("strReplace", builtin_str_replace::INST),151		("isEmpty", builtin_is_empty::INST),152		("splitLimit", builtin_splitlimit::INST),153		("asciiUpper", builtin_ascii_upper::INST),154		("asciiLower", builtin_ascii_lower::INST),155		("findSubstr", builtin_find_substr::INST),156		("parseInt", builtin_parse_int::INST),157		#[cfg(feature = "exp-bigint")]158		("bigint", builtin_bigint::INST),159		("parseOctal", builtin_parse_octal::INST),160		("parseHex", builtin_parse_hex::INST),161		// Misc162		("length", builtin_length::INST),163		("startsWith", builtin_starts_with::INST),164		("endsWith", builtin_ends_with::INST),165		// Sets166		("setMember", builtin_set_member::INST),167		("setInter", builtin_set_inter::INST),168		// Compat169		("__compare", builtin___compare::INST),170	]171	.iter()172	.cloned()173	{174		builder175			.member(name.into())176			.hide()177			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))178			.expect("no conflict");179	}180181	builder182		.member("extVar".into())183		.hide()184		.value(Val::Func(FuncVal::builtin(builtin_ext_var {185			settings: settings.clone(),186		})))187		.expect("no conflict");188	builder189		.member("native".into())190		.hide()191		.value(Val::Func(FuncVal::builtin(builtin_native {192			settings: settings.clone(),193		})))194		.expect("no conflict");195	builder196		.member("trace".into())197		.hide()198		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))199		.expect("no conflict");200201	builder202		.member("id".into())203		.hide()204		.value(Val::Func(FuncVal::Id))205		.expect("no conflict");206207	builder.build()208}209210pub trait TracePrinter {211	fn print_trace(&self, loc: CallLocation, value: IStr);212}213214pub struct StdTracePrinter {215	resolver: PathResolver,216}217impl StdTracePrinter {218	pub fn new(resolver: PathResolver) -> Self {219		Self { resolver }220	}221}222impl TracePrinter for StdTracePrinter {223	fn print_trace(&self, loc: CallLocation, value: IStr) {224		eprint!("TRACE:");225		if let Some(loc) = loc.0 {226			let locs = loc.0.map_source_locations(&[loc.1]);227			eprint!(228				" {}:{}",229				match loc.0.source_path().path() {230					Some(p) => self.resolver.resolve(p),231					None => loc.0.source_path().to_string(),232				},233				locs[0].line234			);235		}236		eprintln!(" {value}");237	}238}239240pub struct Settings {241	/// Used for `std.extVar`242	pub ext_vars: HashMap<IStr, TlaArg>,243	/// Used for `std.native`244	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,245	/// Helper to add globals without implementing custom ContextInitializer246	pub globals: GcHashMap<IStr, Thunk<Val>>,247	/// Used for `std.trace`248	pub trace_printer: Box<dyn TracePrinter>,249	/// Used for `std.thisFile`250	pub path_resolver: PathResolver,251}252253fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {254	let source_name = format!("<extvar:{name}>");255	Source::new_virtual(source_name.into(), code.into())256}257258#[derive(Trace, Clone)]259pub struct ContextInitializer {260	// When we don't need to support legacy-this-file, we can reuse same context for all files261	#[cfg(not(feature = "legacy-this-file"))]262	context: Context,263	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it264	#[cfg(feature = "legacy-this-file")]265	stdlib_obj: ObjValue,266	settings: Rc<RefCell<Settings>>,267}268impl ContextInitializer {269	pub fn new(_s: State, resolver: PathResolver) -> Self {270		let settings = Settings {271			ext_vars: Default::default(),272			ext_natives: Default::default(),273			globals: Default::default(),274			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),275			path_resolver: resolver,276		};277		let settings = Rc::new(RefCell::new(settings));278		Self {279			#[cfg(not(feature = "legacy-this-file"))]280			context: {281				let mut context = ContextBuilder::with_capacity(_s, 1);282				context.bind(283					"std".into(),284					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),285				);286				context.build()287			},288			#[cfg(feature = "legacy-this-file")]289			stdlib_obj: stdlib_uncached(settings.clone()),290			settings,291		}292	}293	pub fn settings(&self) -> Ref<Settings> {294		self.settings.borrow()295	}296	pub fn settings_mut(&self) -> RefMut<Settings> {297		self.settings.borrow_mut()298	}299	pub fn add_ext_var(&self, name: IStr, value: Val) {300		self.settings_mut()301			.ext_vars302			.insert(name, TlaArg::Val(value));303	}304	pub fn add_ext_str(&self, name: IStr, value: IStr) {305		self.settings_mut()306			.ext_vars307			.insert(name, TlaArg::String(value));308	}309	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {310		let code = code.into();311		let source = extvar_source(name, code.clone());312		let parsed = jrsonnet_parser::parse(313			&code,314			&jrsonnet_parser::ParserSettings {315				source: source.clone(),316			},317		)318		.map_err(|e| ImportSyntaxError {319			path: source,320			error: Box::new(e),321		})?;322		// self.data_mut().volatile_files.insert(source_name, code);323		self.settings_mut()324			.ext_vars325			.insert(name.into(), TlaArg::Code(parsed));326		Ok(())327	}328	pub fn add_native(&self, name: IStr, cb: impl Builtin) {329		self.settings_mut()330			.ext_natives331			.insert(name, Cc::new(tb!(cb)));332	}333}334impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {335	#[cfg(not(feature = "legacy-this-file"))]336	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {337		let out = self.context.clone();338		let globals = &self.settings().globals;339		if globals.is_empty() {340			return out;341		}342343		let mut out = ContextBuilder::extend(out);344		for (k, v) in globals.iter() {345			out.bind(k.clone(), v.clone());346		}347		out.build()348	}349	#[cfg(feature = "legacy-this-file")]350	fn initialize(&self, s: State, source: Source) -> Context {351		use jrsonnet_evaluator::val::StrValue;352353		let mut builder = ObjValueBuilder::new();354		builder.with_super(self.stdlib_obj.clone());355		builder356			.member("thisFile".into())357			.hide()358			.value(Val::Str(StrValue::Flat(359				match source.source_path().path() {360					Some(p) => self.settings().path_resolver.resolve(p).into(),361					None => source.source_path().to_string().into(),362				},363			)))364			.expect("this object builder is empty");365		let stdlib_with_this_file = builder.build();366367		let mut context = ContextBuilder::with_capacity(s, 1);368		context.bind(369			"std".into(),370			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),371		);372		for (k, v) in self.settings().globals.iter() {373			context.bind(k.clone(), v.clone());374		}375		context.build()376	}377	fn as_any(&self) -> &dyn std::any::Any {378		self379	}380}381382pub trait StateExt {383	/// This method was previously implemented in jrsonnet-evaluator itself384	fn with_stdlib(&self);385	fn add_global(&self, name: IStr, value: Thunk<Val>);386}387388impl StateExt for State {389	fn with_stdlib(&self) {390		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());391		self.settings_mut().context_initializer = tb!(initializer)392	}393	fn add_global(&self, name: IStr, value: Thunk<Val>) {394		self.settings()395			.context_initializer396			.as_any()397			.downcast_ref::<ContextInitializer>()398			.expect("not standard context initializer")399			.settings_mut()400			.globals401			.insert(name, value);402	}403}