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

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs11.9 KiBsourcehistory
1#![allow(clippy::similar_names)]23use std::{4	cell::{Ref, RefCell, RefMut},5	collections::HashMap,6	rc::Rc,7};89pub use arrays::*;10pub use compat::*;11pub use encoding::*;12pub use hash::*;13use jrsonnet_evaluator::{14	error::{ErrorKind::*, Result},15	function::{CallLocation, FuncVal, TlaArg},16	tb,17	trace::PathResolver,18	ContextBuilder, IStr, ObjValue, ObjValueBuilder, State, Thunk, Val,19};20use jrsonnet_gcmodule::Trace;21use jrsonnet_parser::Source;22pub use manifest::*;23pub use math::*;24pub use misc::*;25pub use objects::*;26pub use operator::*;27pub use parse::*;28pub use sets::*;29pub use sort::*;30pub use strings::*;31pub use types::*;3233#[cfg(feature = "exp-regex")]34pub use crate::regex::*;3536mod arrays;37mod compat;38mod encoding;39mod expr;40mod hash;41mod manifest;42mod math;43mod misc;44mod objects;45mod operator;46mod parse;47#[cfg(feature = "exp-regex")]48mod regex;49mod sets;50mod sort;51mod strings;52mod types;5354#[allow(clippy::too_many_lines)]55pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {56	let mut builder = ObjValueBuilder::new();5758	let expr = expr::stdlib_expr();59	let eval = jrsonnet_evaluator::evaluate(ContextBuilder::dangerous_empty_state().build(), &expr)60		.expect("stdlib.jsonnet should have no errors")61		.as_obj()62		.expect("stdlib.jsonnet should evaluate to object");6364	builder.with_super(eval);6566	// FIXME: Use PHF67	for (name, builtin) in [68		// Types69		("type", builtin_type::INST),70		("isString", builtin_is_string::INST),71		("isNumber", builtin_is_number::INST),72		("isBoolean", builtin_is_boolean::INST),73		("isObject", builtin_is_object::INST),74		("isArray", builtin_is_array::INST),75		("isFunction", builtin_is_function::INST),76		// Arrays77		("makeArray", builtin_make_array::INST),78		("repeat", builtin_repeat::INST),79		("slice", builtin_slice::INST),80		("map", builtin_map::INST),81		("flatMap", builtin_flatmap::INST),82		("filter", builtin_filter::INST),83		("foldl", builtin_foldl::INST),84		("foldr", builtin_foldr::INST),85		("range", builtin_range::INST),86		("join", builtin_join::INST),87		("reverse", builtin_reverse::INST),88		("any", builtin_any::INST),89		("all", builtin_all::INST),90		("member", builtin_member::INST),91		("contains", builtin_contains::INST),92		("count", builtin_count::INST),93		("avg", builtin_avg::INST),94		("removeAt", builtin_remove_at::INST),95		("remove", builtin_remove::INST),96		("flattenArrays", builtin_flatten_arrays::INST),97		("flattenDeepArray", builtin_flatten_deep_array::INST),98		("prune", builtin_prune::INST),99		("filterMap", builtin_filter_map::INST),100		// Math101		("abs", builtin_abs::INST),102		("sign", builtin_sign::INST),103		("max", builtin_max::INST),104		("min", builtin_min::INST),105		("sum", builtin_sum::INST),106		("modulo", builtin_modulo::INST),107		("floor", builtin_floor::INST),108		("ceil", builtin_ceil::INST),109		("log", builtin_log::INST),110		("pow", builtin_pow::INST),111		("sqrt", builtin_sqrt::INST),112		("sin", builtin_sin::INST),113		("cos", builtin_cos::INST),114		("tan", builtin_tan::INST),115		("asin", builtin_asin::INST),116		("acos", builtin_acos::INST),117		("atan", builtin_atan::INST),118		("atan2", builtin_atan2::INST),119		("exp", builtin_exp::INST),120		("mantissa", builtin_mantissa::INST),121		("exponent", builtin_exponent::INST),122		("round", builtin_round::INST),123		("isEven", builtin_is_even::INST),124		("isOdd", builtin_is_odd::INST),125		("isInteger", builtin_is_integer::INST),126		("isDecimal", builtin_is_decimal::INST),127		// Operator128		("mod", builtin_mod::INST),129		("primitiveEquals", builtin_primitive_equals::INST),130		("equals", builtin_equals::INST),131		("xor", builtin_xor::INST),132		("xnor", builtin_xnor::INST),133		("format", builtin_format::INST),134		// Sort135		("sort", builtin_sort::INST),136		("uniq", builtin_uniq::INST),137		("set", builtin_set::INST),138		("minArray", builtin_min_array::INST),139		("maxArray", builtin_max_array::INST),140		// Hash141		("md5", builtin_md5::INST),142		("sha1", builtin_sha1::INST),143		("sha256", builtin_sha256::INST),144		("sha512", builtin_sha512::INST),145		("sha3", builtin_sha3::INST),146		// Encoding147		("encodeUTF8", builtin_encode_utf8::INST),148		("decodeUTF8", builtin_decode_utf8::INST),149		("base64", builtin_base64::INST),150		("base64Decode", builtin_base64_decode::INST),151		("base64DecodeBytes", builtin_base64_decode_bytes::INST),152		// Objects153		("objectFieldsEx", builtin_object_fields_ex::INST),154		("objectFields", builtin_object_fields::INST),155		("objectFieldsAll", builtin_object_fields_all::INST),156		("objectValues", builtin_object_values::INST),157		("objectValuesAll", builtin_object_values_all::INST),158		("objectKeysValues", builtin_object_keys_values::INST),159		("objectKeysValuesAll", builtin_object_keys_values_all::INST),160		("objectHasEx", builtin_object_has_ex::INST),161		("objectHas", builtin_object_has::INST),162		("objectHasAll", builtin_object_has_all::INST),163		("objectRemoveKey", builtin_object_remove_key::INST),164		// Manifest165		("escapeStringJson", builtin_escape_string_json::INST),166		("manifestJsonEx", builtin_manifest_json_ex::INST),167		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),168		("manifestTomlEx", builtin_manifest_toml_ex::INST),169		("toString", builtin_to_string::INST),170		// Parsing171		("parseJson", builtin_parse_json::INST),172		("parseYaml", builtin_parse_yaml::INST),173		// Strings174		("codepoint", builtin_codepoint::INST),175		("substr", builtin_substr::INST),176		("char", builtin_char::INST),177		("strReplace", builtin_str_replace::INST),178		("isEmpty", builtin_is_empty::INST),179		("equalsIgnoreCase", builtin_equals_ignore_case::INST),180		("splitLimit", builtin_splitlimit::INST),181		("splitLimitR", builtin_splitlimitr::INST),182		("asciiUpper", builtin_ascii_upper::INST),183		("asciiLower", builtin_ascii_lower::INST),184		("findSubstr", builtin_find_substr::INST),185		("parseInt", builtin_parse_int::INST),186		#[cfg(feature = "exp-bigint")]187		("bigint", builtin_bigint::INST),188		("parseOctal", builtin_parse_octal::INST),189		("parseHex", builtin_parse_hex::INST),190		("stringChars", builtin_string_chars::INST),191		// Misc192		("length", builtin_length::INST),193		("startsWith", builtin_starts_with::INST),194		("endsWith", builtin_ends_with::INST),195		// Sets196		("setMember", builtin_set_member::INST),197		("setInter", builtin_set_inter::INST),198		("setDiff", builtin_set_diff::INST),199		("setUnion", builtin_set_union::INST),200		// Regex201		#[cfg(feature = "exp-regex")]202		("regexQuoteMeta", builtin_regex_quote_meta::INST),203		// Compat204		("__compare", builtin___compare::INST),205	]206	.iter()207	.copied()208	{209		builder.method(name, builtin);210	}211212	builder.method(213		"extVar",214		builtin_ext_var {215			settings: settings.clone(),216		},217	);218	builder.method(219		"native",220		builtin_native {221			settings: settings.clone(),222		},223	);224	builder.method("trace", builtin_trace { settings });225	builder.method("id", FuncVal::Id);226227	#[cfg(feature = "exp-regex")]228	{229		// Regex230		let regex_cache = RegexCache::default();231		builder.method(232			"regexFullMatch",233			builtin_regex_full_match {234				cache: regex_cache.clone(),235			},236		);237		builder.method(238			"regexPartialMatch",239			builtin_regex_partial_match {240				cache: regex_cache.clone(),241			},242		);243		builder.method(244			"regexReplace",245			builtin_regex_replace {246				cache: regex_cache.clone(),247			},248		);249		builder.method(250			"regexGlobalReplace",251			builtin_regex_global_replace { cache: regex_cache },252		);253	};254255	builder.build()256}257258pub trait TracePrinter {259	fn print_trace(&self, loc: CallLocation, value: IStr);260}261262pub struct StdTracePrinter {263	resolver: PathResolver,264}265impl StdTracePrinter {266	pub fn new(resolver: PathResolver) -> Self {267		Self { resolver }268	}269}270impl TracePrinter for StdTracePrinter {271	fn print_trace(&self, loc: CallLocation, value: IStr) {272		eprint!("TRACE:");273		if let Some(loc) = loc.0 {274			let locs = loc.0.map_source_locations(&[loc.1]);275			eprint!(276				" {}:{}",277				loc.0.source_path().path().map_or_else(278					|| loc.0.source_path().to_string(),279					|p| self.resolver.resolve(p)280				),281				locs[0].line282			);283		}284		eprintln!(" {value}");285	}286}287288pub struct Settings {289	/// Used for `std.extVar`290	pub ext_vars: HashMap<IStr, TlaArg>,291	/// Used for `std.native`292	pub ext_natives: HashMap<IStr, FuncVal>,293	/// Used for `std.trace`294	pub trace_printer: Box<dyn TracePrinter>,295	/// Used for `std.thisFile`296	pub path_resolver: PathResolver,297}298299fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {300	let source_name = format!("<extvar:{name}>");301	Source::new_virtual(source_name.into(), code.into())302}303304#[derive(Trace, Clone)]305pub struct ContextInitializer {306	/// When we don't need to support legacy-this-file, we can reuse same context for all files307	#[cfg(not(feature = "legacy-this-file"))]308	context: jrsonnet_evaluator::Context,309	/// For `populate`310	#[cfg(not(feature = "legacy-this-file"))]311	stdlib_thunk: Thunk<Val>,312	/// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it313	#[cfg(feature = "legacy-this-file")]314	stdlib_obj: ObjValue,315	settings: Rc<RefCell<Settings>>,316}317impl ContextInitializer {318	pub fn new(s: State, resolver: PathResolver) -> Self {319		let settings = Settings {320			ext_vars: HashMap::new(),321			ext_natives: HashMap::new(),322			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),323			path_resolver: resolver,324		};325		let settings = Rc::new(RefCell::new(settings));326		let stdlib_obj = stdlib_uncached(settings.clone());327		#[cfg(not(feature = "legacy-this-file"))]328		let stdlib_thunk = Thunk::evaluated(Val::Obj(stdlib_obj));329		#[cfg(feature = "legacy-this-file")]330		let _ = s;331		Self {332			#[cfg(not(feature = "legacy-this-file"))]333			context: {334				let mut context = ContextBuilder::with_capacity(s, 1);335				context.bind("std", stdlib_thunk.clone());336				context.build()337			},338			#[cfg(not(feature = "legacy-this-file"))]339			stdlib_thunk,340			#[cfg(feature = "legacy-this-file")]341			stdlib_obj,342			settings,343		}344	}345	pub fn settings(&self) -> Ref<Settings> {346		self.settings.borrow()347	}348	pub fn settings_mut(&self) -> RefMut<Settings> {349		self.settings.borrow_mut()350	}351	pub fn add_ext_var(&self, name: IStr, value: Val) {352		self.settings_mut()353			.ext_vars354			.insert(name, TlaArg::Val(value));355	}356	pub fn add_ext_str(&self, name: IStr, value: IStr) {357		self.settings_mut()358			.ext_vars359			.insert(name, TlaArg::String(value));360	}361	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {362		let code = code.into();363		let source = extvar_source(name, code.clone());364		let parsed = jrsonnet_parser::parse(365			&code,366			&jrsonnet_parser::ParserSettings {367				source: source.clone(),368			},369		)370		.map_err(|e| ImportSyntaxError {371			path: source,372			error: Box::new(e),373		})?;374		// self.data_mut().volatile_files.insert(source_name, code);375		self.settings_mut()376			.ext_vars377			.insert(name.into(), TlaArg::Code(parsed));378		Ok(())379	}380	pub fn add_native(&self, name: impl Into<IStr>, cb: impl Into<FuncVal>) {381		self.settings_mut()382			.ext_natives383			.insert(name.into(), cb.into());384	}385}386impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {387	fn reserve_vars(&self) -> usize {388		1389	}390	#[cfg(not(feature = "legacy-this-file"))]391	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {392		self.context.clone()393	}394	#[cfg(not(feature = "legacy-this-file"))]395	fn populate(&self, _for_file: Source, builder: &mut ContextBuilder) {396		builder.bind("std", self.stdlib_thunk.clone());397	}398	#[cfg(feature = "legacy-this-file")]399	fn populate(&self, source: Source, builder: &mut ContextBuilder) {400		let mut std = ObjValueBuilder::new();401		std.with_super(self.stdlib_obj.clone());402		std.field("thisFile").hide().value({403			let source_path = source.source_path();404			source_path.path().map_or_else(405				|| source_path.to_string(),406				|p| self.settings().path_resolver.resolve(p),407			)408		});409		let stdlib_with_this_file = std.build();410411		builder.bind("std", Thunk::evaluated(Val::Obj(stdlib_with_this_file)));412	}413	fn as_any(&self) -> &dyn std::any::Any {414		self415	}416}417418pub trait StateExt {419	/// This method was previously implemented in jrsonnet-evaluator itself420	fn with_stdlib(&self);421}422423impl StateExt for State {424	fn with_stdlib(&self) {425		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());426		self.settings_mut().context_initializer = tb!(initializer);427	}428}