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

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs10.4 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::*;4546pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {47	let mut builder = ObjValueBuilder::new();4849	let expr = expr::stdlib_expr();50	let eval = jrsonnet_evaluator::evaluate(ContextBuilder::dangerous_empty_state().build(), &expr)51		.expect("stdlib.jsonnet should have no errors")52		.as_obj()53		.expect("stdlib.jsonnet should evaluate to object");5455	builder.with_super(eval);5657	for (name, builtin) in [58		// Types59		("type", builtin_type::INST),60		("isString", builtin_is_string::INST),61		("isNumber", builtin_is_number::INST),62		("isBoolean", builtin_is_boolean::INST),63		("isObject", builtin_is_object::INST),64		("isArray", builtin_is_array::INST),65		("isFunction", builtin_is_function::INST),66		// Arrays67		("makeArray", builtin_make_array::INST),68		("repeat", builtin_repeat::INST),69		("slice", builtin_slice::INST),70		("map", builtin_map::INST),71		("flatMap", builtin_flatmap::INST),72		("filter", builtin_filter::INST),73		("foldl", builtin_foldl::INST),74		("foldr", builtin_foldr::INST),75		("range", builtin_range::INST),76		("join", builtin_join::INST),77		("reverse", builtin_reverse::INST),78		("any", builtin_any::INST),79		("all", builtin_all::INST),80		("member", builtin_member::INST),81		("count", builtin_count::INST),82		// Math83		("abs", builtin_abs::INST),84		("sign", builtin_sign::INST),85		("max", builtin_max::INST),86		("min", builtin_min::INST),87		("modulo", builtin_modulo::INST),88		("floor", builtin_floor::INST),89		("ceil", builtin_ceil::INST),90		("log", builtin_log::INST),91		("pow", builtin_pow::INST),92		("sqrt", builtin_sqrt::INST),93		("sin", builtin_sin::INST),94		("cos", builtin_cos::INST),95		("tan", builtin_tan::INST),96		("asin", builtin_asin::INST),97		("acos", builtin_acos::INST),98		("atan", builtin_atan::INST),99		("exp", builtin_exp::INST),100		("mantissa", builtin_mantissa::INST),101		("exponent", builtin_exponent::INST),102		// Operator103		("mod", builtin_mod::INST),104		("primitiveEquals", builtin_primitive_equals::INST),105		("equals", builtin_equals::INST),106		("format", builtin_format::INST),107		// Sort108		("sort", builtin_sort::INST),109		("uniq", builtin_uniq::INST),110		("set", builtin_set::INST),111		// Hash112		("md5", builtin_md5::INST),113		#[cfg(feature = "exp-more-hashes")]114		("sha256", builtin_sha256::INST),115		// Encoding116		("encodeUTF8", builtin_encode_utf8::INST),117		("decodeUTF8", builtin_decode_utf8::INST),118		("base64", builtin_base64::INST),119		("base64Decode", builtin_base64_decode::INST),120		("base64DecodeBytes", builtin_base64_decode_bytes::INST),121		// Objects122		("objectFieldsEx", builtin_object_fields_ex::INST),123		("objectHasEx", builtin_object_has_ex::INST),124		// Manifest125		("escapeStringJson", builtin_escape_string_json::INST),126		("manifestJsonEx", builtin_manifest_json_ex::INST),127		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),128		("manifestTomlEx", builtin_manifest_toml_ex::INST),129		// Parsing130		("parseJson", builtin_parse_json::INST),131		("parseYaml", builtin_parse_yaml::INST),132		// Strings133		("codepoint", builtin_codepoint::INST),134		("substr", builtin_substr::INST),135		("char", builtin_char::INST),136		("strReplace", builtin_str_replace::INST),137		("splitLimit", builtin_splitlimit::INST),138		("asciiUpper", builtin_ascii_upper::INST),139		("asciiLower", builtin_ascii_lower::INST),140		("findSubstr", builtin_find_substr::INST),141		("parseInt", builtin_parse_int::INST),142		("parseOctal", builtin_parse_octal::INST),143		("parseHex", builtin_parse_hex::INST),144		// Misc145		("length", builtin_length::INST),146		("startsWith", builtin_starts_with::INST),147		("endsWith", builtin_ends_with::INST),148		// Sets149		("setMember", builtin_set_member::INST),150	]151	.iter()152	.cloned()153	{154		builder155			.member(name.into())156			.hide()157			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))158			.expect("no conflict");159	}160161	builder162		.member("extVar".into())163		.hide()164		.value(Val::Func(FuncVal::builtin(builtin_ext_var {165			settings: settings.clone(),166		})))167		.expect("no conflict");168	builder169		.member("native".into())170		.hide()171		.value(Val::Func(FuncVal::builtin(builtin_native {172			settings: settings.clone(),173		})))174		.expect("no conflict");175	builder176		.member("trace".into())177		.hide()178		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))179		.expect("no conflict");180181	builder182		.member("id".into())183		.hide()184		.value(Val::Func(FuncVal::Id))185		.expect("no conflict");186187	builder.build()188}189190pub trait TracePrinter {191	fn print_trace(&self, loc: CallLocation, value: IStr);192}193194pub struct StdTracePrinter {195	resolver: PathResolver,196}197impl StdTracePrinter {198	pub fn new(resolver: PathResolver) -> Self {199		Self { resolver }200	}201}202impl TracePrinter for StdTracePrinter {203	fn print_trace(&self, loc: CallLocation, value: IStr) {204		eprint!("TRACE:");205		if let Some(loc) = loc.0 {206			let locs = loc.0.map_source_locations(&[loc.1]);207			eprint!(208				" {}:{}",209				match loc.0.source_path().path() {210					Some(p) => self.resolver.resolve(p),211					None => loc.0.source_path().to_string(),212				},213				locs[0].line214			);215		}216		eprintln!(" {value}");217	}218}219220pub struct Settings {221	/// Used for `std.extVar`222	pub ext_vars: HashMap<IStr, TlaArg>,223	/// Used for `std.native`224	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,225	/// Helper to add globals without implementing custom ContextInitializer226	pub globals: GcHashMap<IStr, Thunk<Val>>,227	/// Used for `std.trace`228	pub trace_printer: Box<dyn TracePrinter>,229	/// Used for `std.thisFile`230	pub path_resolver: PathResolver,231}232233fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {234	let source_name = format!("<extvar:{name}>");235	Source::new_virtual(source_name.into(), code.into())236}237238#[derive(Trace, Clone)]239pub struct ContextInitializer {240	// When we don't need to support legacy-this-file, we can reuse same context for all files241	#[cfg(not(feature = "legacy-this-file"))]242	context: Context,243	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it244	#[cfg(feature = "legacy-this-file")]245	stdlib_obj: ObjValue,246	settings: Rc<RefCell<Settings>>,247}248impl ContextInitializer {249	pub fn new(_s: State, resolver: PathResolver) -> Self {250		let settings = Settings {251			ext_vars: Default::default(),252			ext_natives: Default::default(),253			globals: Default::default(),254			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),255			path_resolver: resolver,256		};257		let settings = Rc::new(RefCell::new(settings));258		Self {259			#[cfg(not(feature = "legacy-this-file"))]260			context: {261				let mut context = ContextBuilder::with_capacity(_s, 1);262				context.bind(263					"std".into(),264					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),265				);266				context.build()267			},268			#[cfg(feature = "legacy-this-file")]269			stdlib_obj: stdlib_uncached(settings.clone()),270			settings,271		}272	}273	pub fn settings(&self) -> Ref<Settings> {274		self.settings.borrow()275	}276	pub fn settings_mut(&self) -> RefMut<Settings> {277		self.settings.borrow_mut()278	}279	pub fn add_ext_var(&self, name: IStr, value: Val) {280		self.settings_mut()281			.ext_vars282			.insert(name, TlaArg::Val(value));283	}284	pub fn add_ext_str(&self, name: IStr, value: IStr) {285		self.settings_mut()286			.ext_vars287			.insert(name, TlaArg::String(value));288	}289	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {290		let code = code.into();291		let source = extvar_source(name, code.clone());292		let parsed = jrsonnet_parser::parse(293			&code,294			&jrsonnet_parser::ParserSettings {295				source: source.clone(),296			},297		)298		.map_err(|e| ImportSyntaxError {299			path: source,300			error: Box::new(e),301		})?;302		// self.data_mut().volatile_files.insert(source_name, code);303		self.settings_mut()304			.ext_vars305			.insert(name.into(), TlaArg::Code(parsed));306		Ok(())307	}308	pub fn add_native(&self, name: IStr, cb: impl Builtin) {309		self.settings_mut()310			.ext_natives311			.insert(name, Cc::new(tb!(cb)));312	}313}314impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {315	#[cfg(not(feature = "legacy-this-file"))]316	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {317		let out = self.context.clone();318		let globals = &self.settings().globals;319		if globals.is_empty() {320			return out;321		}322323		let mut out = ContextBuilder::extend(out);324		for (k, v) in globals.iter() {325			out.bind(k.clone(), v.clone());326		}327		out.build()328	}329	#[cfg(feature = "legacy-this-file")]330	fn initialize(&self, s: State, source: Source) -> Context {331		use jrsonnet_evaluator::val::StrValue;332333		let mut builder = ObjValueBuilder::new();334		builder.with_super(self.stdlib_obj.clone());335		builder336			.member("thisFile".into())337			.hide()338			.value(Val::Str(StrValue::Flat(339				match source.source_path().path() {340					Some(p) => self.settings().path_resolver.resolve(p).into(),341					None => source.source_path().to_string().into(),342				},343			)))344			.expect("this object builder is empty");345		let stdlib_with_this_file = builder.build();346347		let mut context = ContextBuilder::with_capacity(s, 1);348		context.bind(349			"std".into(),350			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),351		);352		for (k, v) in self.settings().globals.iter() {353			context.bind(k.clone(), v.clone());354		}355		context.build()356	}357	fn as_any(&self) -> &dyn std::any::Any {358		self359	}360}361362pub trait StateExt {363	/// This method was previously implemented in jrsonnet-evaluator itself364	fn with_stdlib(&self);365	fn add_global(&self, name: IStr, value: Thunk<Val>);366}367368impl StateExt for State {369	fn with_stdlib(&self) {370		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());371		self.settings_mut().context_initializer = tb!(initializer)372	}373	fn add_global(&self, name: IStr, value: Thunk<Val>) {374		self.settings()375			.context_initializer376			.as_any()377			.downcast_ref::<ContextInitializer>()378			.expect("not standard context initializer")379			.settings_mut()380			.globals381			.insert(name, value);382	}383}