git.delta.rocks / jrsonnet / refs/commits / 0d4913596ab0

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs11.7 KiBsourcehistory
1use std::{2	cell::{Ref, RefCell, RefMut},3	collections::HashMap,4	rc::Rc,5};67use jrsonnet_evaluator::{8	error::{ErrorKind::*, Result},9	function::{CallLocation, FuncVal, TlaArg},10	tb,11	trace::PathResolver,12	ContextBuilder, IStr, ObjValue, ObjValueBuilder, State, Thunk, Val,13};14use jrsonnet_gcmodule::Trace;15use jrsonnet_parser::Source;1617mod expr;18mod types;19pub use types::*;20mod arrays;21pub use arrays::*;22mod math;23pub use math::*;24mod operator;25pub use operator::*;26mod sort;27pub use sort::*;28mod hash;29pub use hash::*;30mod encoding;31pub use encoding::*;32mod objects;33pub use objects::*;34mod manifest;35pub use manifest::*;36mod parse;37pub use parse::*;38mod strings;39pub use strings::*;40mod misc;41pub use misc::*;42mod sets;43pub use sets::*;44mod compat;45pub use compat::*;46#[cfg(feature = "exp-regex")]47mod regex;48#[cfg(feature = "exp-regex")]49pub use crate::regex::*;5051pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {52	let mut builder = ObjValueBuilder::new();5354	let expr = expr::stdlib_expr();55	let eval = jrsonnet_evaluator::evaluate(ContextBuilder::dangerous_empty_state().build(), &expr)56		.expect("stdlib.jsonnet should have no errors")57		.as_obj()58		.expect("stdlib.jsonnet should evaluate to object");5960	builder.with_super(eval);6162	for (name, builtin) in [63		// Types64		("type", builtin_type::INST),65		("isString", builtin_is_string::INST),66		("isNumber", builtin_is_number::INST),67		("isBoolean", builtin_is_boolean::INST),68		("isObject", builtin_is_object::INST),69		("isArray", builtin_is_array::INST),70		("isFunction", builtin_is_function::INST),71		// Arrays72		("makeArray", builtin_make_array::INST),73		("repeat", builtin_repeat::INST),74		("slice", builtin_slice::INST),75		("map", builtin_map::INST),76		("flatMap", builtin_flatmap::INST),77		("filter", builtin_filter::INST),78		("foldl", builtin_foldl::INST),79		("foldr", builtin_foldr::INST),80		("range", builtin_range::INST),81		("join", builtin_join::INST),82		("reverse", builtin_reverse::INST),83		("any", builtin_any::INST),84		("all", builtin_all::INST),85		("member", builtin_member::INST),86		("contains", builtin_contains::INST),87		("count", builtin_count::INST),88		("avg", builtin_avg::INST),89		("removeAt", builtin_remove_at::INST),90		("remove", builtin_remove::INST),91		("flattenArrays", builtin_flatten_arrays::INST),92		("filterMap", builtin_filter_map::INST),93		// Math94		("abs", builtin_abs::INST),95		("sign", builtin_sign::INST),96		("max", builtin_max::INST),97		("min", builtin_min::INST),98		("sum", builtin_sum::INST),99		("modulo", builtin_modulo::INST),100		("floor", builtin_floor::INST),101		("ceil", builtin_ceil::INST),102		("log", builtin_log::INST),103		("pow", builtin_pow::INST),104		("sqrt", builtin_sqrt::INST),105		("sin", builtin_sin::INST),106		("cos", builtin_cos::INST),107		("tan", builtin_tan::INST),108		("asin", builtin_asin::INST),109		("acos", builtin_acos::INST),110		("atan", builtin_atan::INST),111		("atan2", builtin_atan2::INST),112		("exp", builtin_exp::INST),113		("mantissa", builtin_mantissa::INST),114		("exponent", builtin_exponent::INST),115		("round", builtin_round::INST),116		("isEven", builtin_is_even::INST),117		("isOdd", builtin_is_odd::INST),118		("isInteger", builtin_is_integer::INST),119		("isDecimal", builtin_is_decimal::INST),120		// Operator121		("mod", builtin_mod::INST),122		("primitiveEquals", builtin_primitive_equals::INST),123		("equals", builtin_equals::INST),124		("xor", builtin_xor::INST),125		("xnor", builtin_xnor::INST),126		("format", builtin_format::INST),127		// Sort128		("sort", builtin_sort::INST),129		("uniq", builtin_uniq::INST),130		("set", builtin_set::INST),131		("minArray", builtin_min_array::INST),132		("maxArray", builtin_max_array::INST),133		// Hash134		("md5", builtin_md5::INST),135		("sha1", builtin_sha1::INST),136		("sha256", builtin_sha256::INST),137		("sha512", builtin_sha512::INST),138		("sha3", builtin_sha3::INST),139		// Encoding140		("encodeUTF8", builtin_encode_utf8::INST),141		("decodeUTF8", builtin_decode_utf8::INST),142		("base64", builtin_base64::INST),143		("base64Decode", builtin_base64_decode::INST),144		("base64DecodeBytes", builtin_base64_decode_bytes::INST),145		// Objects146		("objectFieldsEx", builtin_object_fields_ex::INST),147		("objectFields", builtin_object_fields::INST),148		("objectFieldsAll", builtin_object_fields_all::INST),149		("objectValues", builtin_object_values::INST),150		("objectValuesAll", builtin_object_values_all::INST),151		("objectKeysValues", builtin_object_keys_values::INST),152		("objectKeysValuesAll", builtin_object_keys_values_all::INST),153		("objectHasEx", builtin_object_has_ex::INST),154		("objectHas", builtin_object_has::INST),155		("objectHasAll", builtin_object_has_all::INST),156		("objectRemoveKey", builtin_object_remove_key::INST),157		// Manifest158		("escapeStringJson", builtin_escape_string_json::INST),159		("manifestJsonEx", builtin_manifest_json_ex::INST),160		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),161		("manifestTomlEx", builtin_manifest_toml_ex::INST),162		("toString", builtin_to_string::INST),163		// Parsing164		("parseJson", builtin_parse_json::INST),165		("parseYaml", builtin_parse_yaml::INST),166		// Strings167		("codepoint", builtin_codepoint::INST),168		("substr", builtin_substr::INST),169		("char", builtin_char::INST),170		("strReplace", builtin_str_replace::INST),171		("isEmpty", builtin_is_empty::INST),172		("equalsIgnoreCase", builtin_equals_ignore_case::INST),173		("splitLimit", builtin_splitlimit::INST),174		("asciiUpper", builtin_ascii_upper::INST),175		("asciiLower", builtin_ascii_lower::INST),176		("findSubstr", builtin_find_substr::INST),177		("parseInt", builtin_parse_int::INST),178		#[cfg(feature = "exp-bigint")]179		("bigint", builtin_bigint::INST),180		("parseOctal", builtin_parse_octal::INST),181		("parseHex", builtin_parse_hex::INST),182		("stringChars", builtin_string_chars::INST),183		// Misc184		("length", builtin_length::INST),185		("startsWith", builtin_starts_with::INST),186		("endsWith", builtin_ends_with::INST),187		// Sets188		("setMember", builtin_set_member::INST),189		("setInter", builtin_set_inter::INST),190		("setDiff", builtin_set_diff::INST),191		("setUnion", builtin_set_union::INST),192		// Regex193		#[cfg(feature = "exp-regex")]194		("regexQuoteMeta", builtin_regex_quote_meta::INST),195		// Compat196		("__compare", builtin___compare::INST),197	]198	.iter()199	.cloned()200	{201		builder.method(name, builtin);202	}203204	builder.method(205		"extVar",206		builtin_ext_var {207			settings: settings.clone(),208		},209	);210	builder.method(211		"native",212		builtin_native {213			settings: settings.clone(),214		},215	);216	builder.method("trace", builtin_trace { settings });217	builder.method("id", FuncVal::Id);218219	#[cfg(feature = "exp-regex")]220	{221		// Regex222		let regex_cache = RegexCache::default();223		builder.method(224			"regexFullMatch",225			builtin_regex_full_match {226				cache: regex_cache.clone(),227			},228		);229		builder.method(230			"regexPartialMatch",231			builtin_regex_partial_match {232				cache: regex_cache.clone(),233			},234		);235		builder.method(236			"regexReplace",237			builtin_regex_replace {238				cache: regex_cache.clone(),239			},240		);241		builder.method(242			"regexGlobalReplace",243			builtin_regex_global_replace {244				cache: regex_cache.clone(),245			},246		);247	};248249	builder.build()250}251252pub trait TracePrinter {253	fn print_trace(&self, loc: CallLocation, value: IStr);254}255256pub struct StdTracePrinter {257	resolver: PathResolver,258}259impl StdTracePrinter {260	pub fn new(resolver: PathResolver) -> Self {261		Self { resolver }262	}263}264impl TracePrinter for StdTracePrinter {265	fn print_trace(&self, loc: CallLocation, value: IStr) {266		eprint!("TRACE:");267		if let Some(loc) = loc.0 {268			let locs = loc.0.map_source_locations(&[loc.1]);269			eprint!(270				" {}:{}",271				match loc.0.source_path().path() {272					Some(p) => self.resolver.resolve(p),273					None => loc.0.source_path().to_string(),274				},275				locs[0].line276			);277		}278		eprintln!(" {value}");279	}280}281282pub struct Settings {283	/// Used for `std.extVar`284	pub ext_vars: HashMap<IStr, TlaArg>,285	/// Used for `std.native`286	pub ext_natives: HashMap<IStr, FuncVal>,287	/// Used for `std.trace`288	pub trace_printer: Box<dyn TracePrinter>,289	/// Used for `std.thisFile`290	pub path_resolver: PathResolver,291}292293fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {294	let source_name = format!("<extvar:{name}>");295	Source::new_virtual(source_name.into(), code.into())296}297298#[derive(Trace, Clone)]299pub struct ContextInitializer {300	/// When we don't need to support legacy-this-file, we can reuse same context for all files301	#[cfg(not(feature = "legacy-this-file"))]302	context: jrsonnet_evaluator::Context,303	/// For `populate`304	#[cfg(not(feature = "legacy-this-file"))]305	stdlib_thunk: Thunk<Val>,306	/// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it307	#[cfg(feature = "legacy-this-file")]308	stdlib_obj: ObjValue,309	settings: Rc<RefCell<Settings>>,310}311impl ContextInitializer {312	pub fn new(_s: State, resolver: PathResolver) -> Self {313		let settings = Settings {314			ext_vars: Default::default(),315			ext_natives: Default::default(),316			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),317			path_resolver: resolver,318		};319		let settings = Rc::new(RefCell::new(settings));320		let stdlib_obj = stdlib_uncached(settings.clone());321		#[cfg(not(feature = "legacy-this-file"))]322		let stdlib_thunk = Thunk::evaluated(Val::Obj(stdlib_obj));323		Self {324			#[cfg(not(feature = "legacy-this-file"))]325			context: {326				let mut context = ContextBuilder::with_capacity(_s, 1);327				context.bind("std", stdlib_thunk.clone());328				context.build()329			},330			#[cfg(not(feature = "legacy-this-file"))]331			stdlib_thunk,332			#[cfg(feature = "legacy-this-file")]333			stdlib_obj,334			settings,335		}336	}337	pub fn settings(&self) -> Ref<Settings> {338		self.settings.borrow()339	}340	pub fn settings_mut(&self) -> RefMut<Settings> {341		self.settings.borrow_mut()342	}343	pub fn add_ext_var(&self, name: IStr, value: Val) {344		self.settings_mut()345			.ext_vars346			.insert(name, TlaArg::Val(value));347	}348	pub fn add_ext_str(&self, name: IStr, value: IStr) {349		self.settings_mut()350			.ext_vars351			.insert(name, TlaArg::String(value));352	}353	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {354		let code = code.into();355		let source = extvar_source(name, code.clone());356		let parsed = jrsonnet_parser::parse(357			&code,358			&jrsonnet_parser::ParserSettings {359				source: source.clone(),360			},361		)362		.map_err(|e| ImportSyntaxError {363			path: source,364			error: Box::new(e),365		})?;366		// self.data_mut().volatile_files.insert(source_name, code);367		self.settings_mut()368			.ext_vars369			.insert(name.into(), TlaArg::Code(parsed));370		Ok(())371	}372	pub fn add_native(&self, name: impl Into<IStr>, cb: impl Into<FuncVal>) {373		self.settings_mut()374			.ext_natives375			.insert(name.into(), cb.into());376	}377}378impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {379	fn reserve_vars(&self) -> usize {380		1381	}382	#[cfg(not(feature = "legacy-this-file"))]383	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {384		self.context.clone()385	}386	#[cfg(not(feature = "legacy-this-file"))]387	fn populate(&self, _for_file: Source, builder: &mut ContextBuilder) {388		builder.bind("std", self.stdlib_thunk.clone());389	}390	#[cfg(feature = "legacy-this-file")]391	fn populate(&self, source: Source, builder: &mut ContextBuilder) {392		use jrsonnet_evaluator::val::StrValue;393394		let mut std = ObjValueBuilder::new();395		std.with_super(self.stdlib_obj.clone());396		std.field("thisFile")397			.hide()398			.value(match source.source_path().path() {399				Some(p) => self.settings().path_resolver.resolve(p),400				None => source.source_path().to_string(),401			});402		let stdlib_with_this_file = std.build();403404		builder.bind("std", Thunk::evaluated(Val::Obj(stdlib_with_this_file)));405	}406	fn as_any(&self) -> &dyn std::any::Any {407		self408	}409}410411pub trait StateExt {412	/// This method was previously implemented in jrsonnet-evaluator itself413	fn with_stdlib(&self);414}415416impl StateExt for State {417	fn with_stdlib(&self) {418		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());419		self.settings_mut().context_initializer = tb!(initializer)420	}421}