git.delta.rocks / jrsonnet / refs/commits / 6639b028f560

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs10.6 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		("count", builtin_count::INST),84		// Math85		("abs", builtin_abs::INST),86		("sign", builtin_sign::INST),87		("max", builtin_max::INST),88		("min", builtin_min::INST),89		("sum", builtin_sum::INST),90		("modulo", builtin_modulo::INST),91		("floor", builtin_floor::INST),92		("ceil", builtin_ceil::INST),93		("log", builtin_log::INST),94		("pow", builtin_pow::INST),95		("sqrt", builtin_sqrt::INST),96		("sin", builtin_sin::INST),97		("cos", builtin_cos::INST),98		("tan", builtin_tan::INST),99		("asin", builtin_asin::INST),100		("acos", builtin_acos::INST),101		("atan", builtin_atan::INST),102		("exp", builtin_exp::INST),103		("mantissa", builtin_mantissa::INST),104		("exponent", builtin_exponent::INST),105		// Operator106		("mod", builtin_mod::INST),107		("primitiveEquals", builtin_primitive_equals::INST),108		("equals", builtin_equals::INST),109		("xor", builtin_xor::INST),110		("format", builtin_format::INST),111		// Sort112		("sort", builtin_sort::INST),113		("uniq", builtin_uniq::INST),114		("set", builtin_set::INST),115		// Hash116		("md5", builtin_md5::INST),117		("sha256", builtin_sha256::INST),118		// Encoding119		("encodeUTF8", builtin_encode_utf8::INST),120		("decodeUTF8", builtin_decode_utf8::INST),121		("base64", builtin_base64::INST),122		("base64Decode", builtin_base64_decode::INST),123		("base64DecodeBytes", builtin_base64_decode_bytes::INST),124		// Objects125		("objectFieldsEx", builtin_object_fields_ex::INST),126		("objectHasEx", builtin_object_has_ex::INST),127		// Manifest128		("escapeStringJson", builtin_escape_string_json::INST),129		("manifestJsonEx", builtin_manifest_json_ex::INST),130		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),131		("manifestTomlEx", builtin_manifest_toml_ex::INST),132		// Parsing133		("parseJson", builtin_parse_json::INST),134		("parseYaml", builtin_parse_yaml::INST),135		// Strings136		("codepoint", builtin_codepoint::INST),137		("substr", builtin_substr::INST),138		("char", builtin_char::INST),139		("strReplace", builtin_str_replace::INST),140		("splitLimit", builtin_splitlimit::INST),141		("asciiUpper", builtin_ascii_upper::INST),142		("asciiLower", builtin_ascii_lower::INST),143		("findSubstr", builtin_find_substr::INST),144		("parseInt", builtin_parse_int::INST),145		#[cfg(feature = "exp-bigint")]146		("bigint", builtin_bigint::INST),147		("parseOctal", builtin_parse_octal::INST),148		("parseHex", builtin_parse_hex::INST),149		// Misc150		("length", builtin_length::INST),151		("startsWith", builtin_starts_with::INST),152		("endsWith", builtin_ends_with::INST),153		// Sets154		("setMember", builtin_set_member::INST),155		("setInter", builtin_set_inter::INST),156		// Compat157		("__compare", builtin___compare::INST),158	]159	.iter()160	.cloned()161	{162		builder163			.member(name.into())164			.hide()165			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))166			.expect("no conflict");167	}168169	builder170		.member("extVar".into())171		.hide()172		.value(Val::Func(FuncVal::builtin(builtin_ext_var {173			settings: settings.clone(),174		})))175		.expect("no conflict");176	builder177		.member("native".into())178		.hide()179		.value(Val::Func(FuncVal::builtin(builtin_native {180			settings: settings.clone(),181		})))182		.expect("no conflict");183	builder184		.member("trace".into())185		.hide()186		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))187		.expect("no conflict");188189	builder190		.member("id".into())191		.hide()192		.value(Val::Func(FuncVal::Id))193		.expect("no conflict");194195	builder.build()196}197198pub trait TracePrinter {199	fn print_trace(&self, loc: CallLocation, value: IStr);200}201202pub struct StdTracePrinter {203	resolver: PathResolver,204}205impl StdTracePrinter {206	pub fn new(resolver: PathResolver) -> Self {207		Self { resolver }208	}209}210impl TracePrinter for StdTracePrinter {211	fn print_trace(&self, loc: CallLocation, value: IStr) {212		eprint!("TRACE:");213		if let Some(loc) = loc.0 {214			let locs = loc.0.map_source_locations(&[loc.1]);215			eprint!(216				" {}:{}",217				match loc.0.source_path().path() {218					Some(p) => self.resolver.resolve(p),219					None => loc.0.source_path().to_string(),220				},221				locs[0].line222			);223		}224		eprintln!(" {value}");225	}226}227228pub struct Settings {229	/// Used for `std.extVar`230	pub ext_vars: HashMap<IStr, TlaArg>,231	/// Used for `std.native`232	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,233	/// Helper to add globals without implementing custom ContextInitializer234	pub globals: GcHashMap<IStr, Thunk<Val>>,235	/// Used for `std.trace`236	pub trace_printer: Box<dyn TracePrinter>,237	/// Used for `std.thisFile`238	pub path_resolver: PathResolver,239}240241fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {242	let source_name = format!("<extvar:{name}>");243	Source::new_virtual(source_name.into(), code.into())244}245246#[derive(Trace, Clone)]247pub struct ContextInitializer {248	// When we don't need to support legacy-this-file, we can reuse same context for all files249	#[cfg(not(feature = "legacy-this-file"))]250	context: Context,251	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it252	#[cfg(feature = "legacy-this-file")]253	stdlib_obj: ObjValue,254	settings: Rc<RefCell<Settings>>,255}256impl ContextInitializer {257	pub fn new(_s: State, resolver: PathResolver) -> Self {258		let settings = Settings {259			ext_vars: Default::default(),260			ext_natives: Default::default(),261			globals: Default::default(),262			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),263			path_resolver: resolver,264		};265		let settings = Rc::new(RefCell::new(settings));266		Self {267			#[cfg(not(feature = "legacy-this-file"))]268			context: {269				let mut context = ContextBuilder::with_capacity(_s, 1);270				context.bind(271					"std".into(),272					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),273				);274				context.build()275			},276			#[cfg(feature = "legacy-this-file")]277			stdlib_obj: stdlib_uncached(settings.clone()),278			settings,279		}280	}281	pub fn settings(&self) -> Ref<Settings> {282		self.settings.borrow()283	}284	pub fn settings_mut(&self) -> RefMut<Settings> {285		self.settings.borrow_mut()286	}287	pub fn add_ext_var(&self, name: IStr, value: Val) {288		self.settings_mut()289			.ext_vars290			.insert(name, TlaArg::Val(value));291	}292	pub fn add_ext_str(&self, name: IStr, value: IStr) {293		self.settings_mut()294			.ext_vars295			.insert(name, TlaArg::String(value));296	}297	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {298		let code = code.into();299		let source = extvar_source(name, code.clone());300		let parsed = jrsonnet_parser::parse(301			&code,302			&jrsonnet_parser::ParserSettings {303				source: source.clone(),304			},305		)306		.map_err(|e| ImportSyntaxError {307			path: source,308			error: Box::new(e),309		})?;310		// self.data_mut().volatile_files.insert(source_name, code);311		self.settings_mut()312			.ext_vars313			.insert(name.into(), TlaArg::Code(parsed));314		Ok(())315	}316	pub fn add_native(&self, name: IStr, cb: impl Builtin) {317		self.settings_mut()318			.ext_natives319			.insert(name, Cc::new(tb!(cb)));320	}321}322impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {323	#[cfg(not(feature = "legacy-this-file"))]324	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {325		let out = self.context.clone();326		let globals = &self.settings().globals;327		if globals.is_empty() {328			return out;329		}330331		let mut out = ContextBuilder::extend(out);332		for (k, v) in globals.iter() {333			out.bind(k.clone(), v.clone());334		}335		out.build()336	}337	#[cfg(feature = "legacy-this-file")]338	fn initialize(&self, s: State, source: Source) -> Context {339		use jrsonnet_evaluator::val::StrValue;340341		let mut builder = ObjValueBuilder::new();342		builder.with_super(self.stdlib_obj.clone());343		builder344			.member("thisFile".into())345			.hide()346			.value(Val::Str(StrValue::Flat(347				match source.source_path().path() {348					Some(p) => self.settings().path_resolver.resolve(p).into(),349					None => source.source_path().to_string().into(),350				},351			)))352			.expect("this object builder is empty");353		let stdlib_with_this_file = builder.build();354355		let mut context = ContextBuilder::with_capacity(s, 1);356		context.bind(357			"std".into(),358			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),359		);360		for (k, v) in self.settings().globals.iter() {361			context.bind(k.clone(), v.clone());362		}363		context.build()364	}365	fn as_any(&self) -> &dyn std::any::Any {366		self367	}368}369370pub trait StateExt {371	/// This method was previously implemented in jrsonnet-evaluator itself372	fn with_stdlib(&self);373	fn add_global(&self, name: IStr, value: Thunk<Val>);374}375376impl StateExt for State {377	fn with_stdlib(&self) {378		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());379		self.settings_mut().context_initializer = tb!(initializer)380	}381	fn add_global(&self, name: IStr, value: Thunk<Val>) {382		self.settings()383			.context_initializer384			.as_any()385			.downcast_ref::<ContextInitializer>()386			.expect("not standard context initializer")387			.settings_mut()388			.globals389			.insert(name, value);390	}391}