git.delta.rocks / jrsonnet / refs/commits / 3e814e5a718d

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs11.2 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		("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		("objectHasEx", builtin_object_has_ex::INST),142		// Manifest143		("escapeStringJson", builtin_escape_string_json::INST),144		("manifestJsonEx", builtin_manifest_json_ex::INST),145		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),146		("manifestTomlEx", builtin_manifest_toml_ex::INST),147		// Parsing148		("parseJson", builtin_parse_json::INST),149		("parseYaml", builtin_parse_yaml::INST),150		// Strings151		("codepoint", builtin_codepoint::INST),152		("substr", builtin_substr::INST),153		("char", builtin_char::INST),154		("strReplace", builtin_str_replace::INST),155		("isEmpty", builtin_is_empty::INST),156		("equalsIgnoreCase", builtin_equals_ignore_case::INST),157		("splitLimit", builtin_splitlimit::INST),158		("asciiUpper", builtin_ascii_upper::INST),159		("asciiLower", builtin_ascii_lower::INST),160		("findSubstr", builtin_find_substr::INST),161		("parseInt", builtin_parse_int::INST),162		#[cfg(feature = "exp-bigint")]163		("bigint", builtin_bigint::INST),164		("parseOctal", builtin_parse_octal::INST),165		("parseHex", builtin_parse_hex::INST),166		// Misc167		("length", builtin_length::INST),168		("startsWith", builtin_starts_with::INST),169		("endsWith", builtin_ends_with::INST),170		// Sets171		("setMember", builtin_set_member::INST),172		("setInter", builtin_set_inter::INST),173		// Compat174		("__compare", builtin___compare::INST),175	]176	.iter()177	.cloned()178	{179		builder180			.member(name.into())181			.hide()182			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))183			.expect("no conflict");184	}185186	builder187		.member("extVar".into())188		.hide()189		.value(Val::Func(FuncVal::builtin(builtin_ext_var {190			settings: settings.clone(),191		})))192		.expect("no conflict");193	builder194		.member("native".into())195		.hide()196		.value(Val::Func(FuncVal::builtin(builtin_native {197			settings: settings.clone(),198		})))199		.expect("no conflict");200	builder201		.member("trace".into())202		.hide()203		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))204		.expect("no conflict");205206	builder207		.member("id".into())208		.hide()209		.value(Val::Func(FuncVal::Id))210		.expect("no conflict");211212	builder.build()213}214215pub trait TracePrinter {216	fn print_trace(&self, loc: CallLocation, value: IStr);217}218219pub struct StdTracePrinter {220	resolver: PathResolver,221}222impl StdTracePrinter {223	pub fn new(resolver: PathResolver) -> Self {224		Self { resolver }225	}226}227impl TracePrinter for StdTracePrinter {228	fn print_trace(&self, loc: CallLocation, value: IStr) {229		eprint!("TRACE:");230		if let Some(loc) = loc.0 {231			let locs = loc.0.map_source_locations(&[loc.1]);232			eprint!(233				" {}:{}",234				match loc.0.source_path().path() {235					Some(p) => self.resolver.resolve(p),236					None => loc.0.source_path().to_string(),237				},238				locs[0].line239			);240		}241		eprintln!(" {value}");242	}243}244245pub struct Settings {246	/// Used for `std.extVar`247	pub ext_vars: HashMap<IStr, TlaArg>,248	/// Used for `std.native`249	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,250	/// Helper to add globals without implementing custom ContextInitializer251	pub globals: GcHashMap<IStr, Thunk<Val>>,252	/// Used for `std.trace`253	pub trace_printer: Box<dyn TracePrinter>,254	/// Used for `std.thisFile`255	pub path_resolver: PathResolver,256}257258fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {259	let source_name = format!("<extvar:{name}>");260	Source::new_virtual(source_name.into(), code.into())261}262263#[derive(Trace, Clone)]264pub struct ContextInitializer {265	// When we don't need to support legacy-this-file, we can reuse same context for all files266	#[cfg(not(feature = "legacy-this-file"))]267	context: Context,268	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it269	#[cfg(feature = "legacy-this-file")]270	stdlib_obj: ObjValue,271	settings: Rc<RefCell<Settings>>,272}273impl ContextInitializer {274	pub fn new(_s: State, resolver: PathResolver) -> Self {275		let settings = Settings {276			ext_vars: Default::default(),277			ext_natives: Default::default(),278			globals: Default::default(),279			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),280			path_resolver: resolver,281		};282		let settings = Rc::new(RefCell::new(settings));283		Self {284			#[cfg(not(feature = "legacy-this-file"))]285			context: {286				let mut context = ContextBuilder::with_capacity(_s, 1);287				context.bind(288					"std".into(),289					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),290				);291				context.build()292			},293			#[cfg(feature = "legacy-this-file")]294			stdlib_obj: stdlib_uncached(settings.clone()),295			settings,296		}297	}298	pub fn settings(&self) -> Ref<Settings> {299		self.settings.borrow()300	}301	pub fn settings_mut(&self) -> RefMut<Settings> {302		self.settings.borrow_mut()303	}304	pub fn add_ext_var(&self, name: IStr, value: Val) {305		self.settings_mut()306			.ext_vars307			.insert(name, TlaArg::Val(value));308	}309	pub fn add_ext_str(&self, name: IStr, value: IStr) {310		self.settings_mut()311			.ext_vars312			.insert(name, TlaArg::String(value));313	}314	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {315		let code = code.into();316		let source = extvar_source(name, code.clone());317		let parsed = jrsonnet_parser::parse(318			&code,319			&jrsonnet_parser::ParserSettings {320				source: source.clone(),321			},322		)323		.map_err(|e| ImportSyntaxError {324			path: source,325			error: Box::new(e),326		})?;327		// self.data_mut().volatile_files.insert(source_name, code);328		self.settings_mut()329			.ext_vars330			.insert(name.into(), TlaArg::Code(parsed));331		Ok(())332	}333	pub fn add_native(&self, name: IStr, cb: impl Builtin) {334		self.settings_mut()335			.ext_natives336			.insert(name, Cc::new(tb!(cb)));337	}338}339impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {340	#[cfg(not(feature = "legacy-this-file"))]341	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {342		let out = self.context.clone();343		let globals = &self.settings().globals;344		if globals.is_empty() {345			return out;346		}347348		let mut out = ContextBuilder::extend(out);349		for (k, v) in globals.iter() {350			out.bind(k.clone(), v.clone());351		}352		out.build()353	}354	#[cfg(feature = "legacy-this-file")]355	fn initialize(&self, s: State, source: Source) -> Context {356		use jrsonnet_evaluator::val::StrValue;357358		let mut builder = ObjValueBuilder::new();359		builder.with_super(self.stdlib_obj.clone());360		builder361			.member("thisFile".into())362			.hide()363			.value(Val::Str(StrValue::Flat(364				match source.source_path().path() {365					Some(p) => self.settings().path_resolver.resolve(p).into(),366					None => source.source_path().to_string().into(),367				},368			)))369			.expect("this object builder is empty");370		let stdlib_with_this_file = builder.build();371372		let mut context = ContextBuilder::with_capacity(s, 1);373		context.bind(374			"std".into(),375			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),376		);377		for (k, v) in self.settings().globals.iter() {378			context.bind(k.clone(), v.clone());379		}380		context.build()381	}382	fn as_any(&self) -> &dyn std::any::Any {383		self384	}385}386387pub trait StateExt {388	/// This method was previously implemented in jrsonnet-evaluator itself389	fn with_stdlib(&self);390	fn add_global(&self, name: IStr, value: Thunk<Val>);391}392393impl StateExt for State {394	fn with_stdlib(&self) {395		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());396		self.settings_mut().context_initializer = tb!(initializer)397	}398	fn add_global(&self, name: IStr, value: Thunk<Val>) {399		self.settings()400			.context_initializer401			.as_any()402			.downcast_ref::<ContextInitializer>()403			.expect("not standard context initializer")404			.settings_mut()405			.globals406			.insert(name, value);407	}408}