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

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::TraceBox,11	tb,12	trace::PathResolver,13	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		("removeAt", builtin_remove_at::INST),87		("remove", builtin_remove::INST),88		// Math89		("abs", builtin_abs::INST),90		("sign", builtin_sign::INST),91		("max", builtin_max::INST),92		("min", builtin_min::INST),93		("sum", builtin_sum::INST),94		("modulo", builtin_modulo::INST),95		("floor", builtin_floor::INST),96		("ceil", builtin_ceil::INST),97		("log", builtin_log::INST),98		("pow", builtin_pow::INST),99		("sqrt", builtin_sqrt::INST),100		("sin", builtin_sin::INST),101		("cos", builtin_cos::INST),102		("tan", builtin_tan::INST),103		("asin", builtin_asin::INST),104		("acos", builtin_acos::INST),105		("atan", builtin_atan::INST),106		("exp", builtin_exp::INST),107		("mantissa", builtin_mantissa::INST),108		("exponent", builtin_exponent::INST),109		("round", builtin_round::INST),110		("isEven", builtin_is_even::INST),111		("isOdd", builtin_is_odd::INST),112		("isInteger", builtin_is_integer::INST),113		("isDecimal", builtin_is_decimal::INST),114		// Operator115		("mod", builtin_mod::INST),116		("primitiveEquals", builtin_primitive_equals::INST),117		("equals", builtin_equals::INST),118		("xor", builtin_xor::INST),119		("xnor", builtin_xnor::INST),120		("format", builtin_format::INST),121		// Sort122		("sort", builtin_sort::INST),123		("uniq", builtin_uniq::INST),124		("set", builtin_set::INST),125		("minArray", builtin_min_array::INST),126		("maxArray", builtin_max_array::INST),127		// Hash128		("md5", builtin_md5::INST),129		("sha1", builtin_sha1::INST),130		("sha256", builtin_sha256::INST),131		("sha512", builtin_sha512::INST),132		("sha3", builtin_sha3::INST),133		// Encoding134		("encodeUTF8", builtin_encode_utf8::INST),135		("decodeUTF8", builtin_decode_utf8::INST),136		("base64", builtin_base64::INST),137		("base64Decode", builtin_base64_decode::INST),138		("base64DecodeBytes", builtin_base64_decode_bytes::INST),139		// Objects140		("objectFieldsEx", builtin_object_fields_ex::INST),141		("objectValues", builtin_object_values::INST),142		("objectValuesAll", builtin_object_values_all::INST),143		("objectKeysValues", builtin_object_keys_values::INST),144		("objectKeysValuesAll", builtin_object_keys_values_all::INST),145		("objectHasEx", builtin_object_has_ex::INST),146		("objectRemoveKey", builtin_object_remove_key::INST),147		// Manifest148		("escapeStringJson", builtin_escape_string_json::INST),149		("manifestJsonEx", builtin_manifest_json_ex::INST),150		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),151		("manifestTomlEx", builtin_manifest_toml_ex::INST),152		// Parsing153		("parseJson", builtin_parse_json::INST),154		("parseYaml", builtin_parse_yaml::INST),155		// Strings156		("codepoint", builtin_codepoint::INST),157		("substr", builtin_substr::INST),158		("char", builtin_char::INST),159		("strReplace", builtin_str_replace::INST),160		("isEmpty", builtin_is_empty::INST),161		("equalsIgnoreCase", builtin_equals_ignore_case::INST),162		("splitLimit", builtin_splitlimit::INST),163		("asciiUpper", builtin_ascii_upper::INST),164		("asciiLower", builtin_ascii_lower::INST),165		("findSubstr", builtin_find_substr::INST),166		("parseInt", builtin_parse_int::INST),167		#[cfg(feature = "exp-bigint")]168		("bigint", builtin_bigint::INST),169		("parseOctal", builtin_parse_octal::INST),170		("parseHex", builtin_parse_hex::INST),171		// Misc172		("length", builtin_length::INST),173		("startsWith", builtin_starts_with::INST),174		("endsWith", builtin_ends_with::INST),175		// Sets176		("setMember", builtin_set_member::INST),177		("setInter", builtin_set_inter::INST),178		// Compat179		("__compare", builtin___compare::INST),180	]181	.iter()182	.cloned()183	{184		builder185			.member(name.into())186			.hide()187			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))188			.expect("no conflict");189	}190191	builder192		.member("extVar".into())193		.hide()194		.value(Val::Func(FuncVal::builtin(builtin_ext_var {195			settings: settings.clone(),196		})))197		.expect("no conflict");198	builder199		.member("native".into())200		.hide()201		.value(Val::Func(FuncVal::builtin(builtin_native {202			settings: settings.clone(),203		})))204		.expect("no conflict");205	builder206		.member("trace".into())207		.hide()208		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))209		.expect("no conflict");210211	builder212		.member("id".into())213		.hide()214		.value(Val::Func(FuncVal::Id))215		.expect("no conflict");216217	builder.build()218}219220pub trait TracePrinter {221	fn print_trace(&self, loc: CallLocation, value: IStr);222}223224pub struct StdTracePrinter {225	resolver: PathResolver,226}227impl StdTracePrinter {228	pub fn new(resolver: PathResolver) -> Self {229		Self { resolver }230	}231}232impl TracePrinter for StdTracePrinter {233	fn print_trace(&self, loc: CallLocation, value: IStr) {234		eprint!("TRACE:");235		if let Some(loc) = loc.0 {236			let locs = loc.0.map_source_locations(&[loc.1]);237			eprint!(238				" {}:{}",239				match loc.0.source_path().path() {240					Some(p) => self.resolver.resolve(p),241					None => loc.0.source_path().to_string(),242				},243				locs[0].line244			);245		}246		eprintln!(" {value}");247	}248}249250pub struct Settings {251	/// Used for `std.extVar`252	pub ext_vars: HashMap<IStr, TlaArg>,253	/// Used for `std.native`254	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,255	/// Used for `std.trace`256	pub trace_printer: Box<dyn TracePrinter>,257	/// Used for `std.thisFile`258	pub path_resolver: PathResolver,259}260261fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {262	let source_name = format!("<extvar:{name}>");263	Source::new_virtual(source_name.into(), code.into())264}265266#[derive(Trace, Clone)]267pub struct ContextInitializer {268	/// When we don't need to support legacy-this-file, we can reuse same context for all files269	#[cfg(not(feature = "legacy-this-file"))]270	context: jrsonnet_evaluator::Context,271	/// For `populate`272	#[cfg(not(feature = "legacy-this-file"))]273	stdlib_thunk: Thunk<Val>,274	/// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it275	#[cfg(feature = "legacy-this-file")]276	stdlib_obj: ObjValue,277	settings: Rc<RefCell<Settings>>,278}279impl ContextInitializer {280	pub fn new(_s: State, resolver: PathResolver) -> Self {281		let settings = Settings {282			ext_vars: Default::default(),283			ext_natives: Default::default(),284			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),285			path_resolver: resolver,286		};287		let settings = Rc::new(RefCell::new(settings));288		let stdlib_obj = stdlib_uncached(settings.clone());289		#[cfg(not(feature = "legacy-this-file"))]290		let stdlib_thunk = Thunk::evaluated(Val::Obj(stdlib_obj));291		Self {292			#[cfg(not(feature = "legacy-this-file"))]293			context: {294				let mut context = ContextBuilder::with_capacity(_s, 1);295				context.bind("std".into(), stdlib_thunk.clone());296				context.build()297			},298			#[cfg(not(feature = "legacy-this-file"))]299			stdlib_thunk,300			#[cfg(feature = "legacy-this-file")]301			stdlib_obj,302			settings,303		}304	}305	pub fn settings(&self) -> Ref<Settings> {306		self.settings.borrow()307	}308	pub fn settings_mut(&self) -> RefMut<Settings> {309		self.settings.borrow_mut()310	}311	pub fn add_ext_var(&self, name: IStr, value: Val) {312		self.settings_mut()313			.ext_vars314			.insert(name, TlaArg::Val(value));315	}316	pub fn add_ext_str(&self, name: IStr, value: IStr) {317		self.settings_mut()318			.ext_vars319			.insert(name, TlaArg::String(value));320	}321	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {322		let code = code.into();323		let source = extvar_source(name, code.clone());324		let parsed = jrsonnet_parser::parse(325			&code,326			&jrsonnet_parser::ParserSettings {327				source: source.clone(),328			},329		)330		.map_err(|e| ImportSyntaxError {331			path: source,332			error: Box::new(e),333		})?;334		// self.data_mut().volatile_files.insert(source_name, code);335		self.settings_mut()336			.ext_vars337			.insert(name.into(), TlaArg::Code(parsed));338		Ok(())339	}340	pub fn add_native(&self, name: IStr, cb: impl Builtin) {341		self.settings_mut()342			.ext_natives343			.insert(name, Cc::new(tb!(cb)));344	}345}346impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {347	fn reserve_vars(&self) -> usize {348		1349	}350	#[cfg(not(feature = "legacy-this-file"))]351	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {352		self.context.clone()353	}354	#[cfg(not(feature = "legacy-this-file"))]355	fn populate(&self, _for_file: Source, builder: &mut ContextBuilder) {356		builder.bind("std".into(), self.stdlib_thunk.clone());357	}358	#[cfg(feature = "legacy-this-file")]359	fn populate(&self, source: Source, builder: &mut ContextBuilder) {360		use jrsonnet_evaluator::val::StrValue;361362		let mut std = ObjValueBuilder::new();363		std.with_super(self.stdlib_obj.clone());364		std.member("thisFile".into())365			.hide()366			.value(Val::Str(StrValue::Flat(367				match source.source_path().path() {368					Some(p) => self.settings().path_resolver.resolve(p).into(),369					None => source.source_path().to_string().into(),370				},371			)))372			.expect("this object builder is empty");373		let stdlib_with_this_file = std.build();374375		builder.bind(376			"std".into(),377			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),378		);379	}380	fn as_any(&self) -> &dyn std::any::Any {381		self382	}383}384385pub trait StateExt {386	/// This method was previously implemented in jrsonnet-evaluator itself387	fn with_stdlib(&self);388}389390impl StateExt for State {391	fn with_stdlib(&self) {392		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());393		self.settings_mut().context_initializer = tb!(initializer)394	}395}