git.delta.rocks / jrsonnet / refs/commits / 71fb4e2830f5

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs13.4 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		("mapWithIndex", builtin_map_with_index::INST),82		("flatMap", builtin_flatmap::INST),83		("filter", builtin_filter::INST),84		("foldl", builtin_foldl::INST),85		("foldr", builtin_foldr::INST),86		("range", builtin_range::INST),87		("join", builtin_join::INST),88		("lines", builtin_lines::INST),89		("deepJoin", builtin_deep_join::INST),90		("reverse", builtin_reverse::INST),91		("any", builtin_any::INST),92		("all", builtin_all::INST),93		("member", builtin_member::INST),94		("find", builtin_find::INST),95		("contains", builtin_contains::INST),96		("count", builtin_count::INST),97		("avg", builtin_avg::INST),98		("removeAt", builtin_remove_at::INST),99		("remove", builtin_remove::INST),100		("flattenArrays", builtin_flatten_arrays::INST),101		("flattenDeepArray", builtin_flatten_deep_array::INST),102		("prune", builtin_prune::INST),103		("filterMap", builtin_filter_map::INST),104		// Math105		("abs", builtin_abs::INST),106		("sign", builtin_sign::INST),107		("max", builtin_max::INST),108		("min", builtin_min::INST),109		("clamp", builtin_clamp::INST),110		("sum", builtin_sum::INST),111		("modulo", builtin_modulo::INST),112		("floor", builtin_floor::INST),113		("ceil", builtin_ceil::INST),114		("log", builtin_log::INST),115		("pow", builtin_pow::INST),116		("sqrt", builtin_sqrt::INST),117		("sin", builtin_sin::INST),118		("cos", builtin_cos::INST),119		("tan", builtin_tan::INST),120		("asin", builtin_asin::INST),121		("acos", builtin_acos::INST),122		("atan", builtin_atan::INST),123		("atan2", builtin_atan2::INST),124		("exp", builtin_exp::INST),125		("mantissa", builtin_mantissa::INST),126		("exponent", builtin_exponent::INST),127		("round", builtin_round::INST),128		("isEven", builtin_is_even::INST),129		("isOdd", builtin_is_odd::INST),130		("isInteger", builtin_is_integer::INST),131		("isDecimal", builtin_is_decimal::INST),132		// Operator133		("mod", builtin_mod::INST),134		("primitiveEquals", builtin_primitive_equals::INST),135		("equals", builtin_equals::INST),136		("xor", builtin_xor::INST),137		("xnor", builtin_xnor::INST),138		("format", builtin_format::INST),139		// Sort140		("sort", builtin_sort::INST),141		("uniq", builtin_uniq::INST),142		("set", builtin_set::INST),143		("minArray", builtin_min_array::INST),144		("maxArray", builtin_max_array::INST),145		// Hash146		("md5", builtin_md5::INST),147		("sha1", builtin_sha1::INST),148		("sha256", builtin_sha256::INST),149		("sha512", builtin_sha512::INST),150		("sha3", builtin_sha3::INST),151		// Encoding152		("encodeUTF8", builtin_encode_utf8::INST),153		("decodeUTF8", builtin_decode_utf8::INST),154		("base64", builtin_base64::INST),155		("base64Decode", builtin_base64_decode::INST),156		("base64DecodeBytes", builtin_base64_decode_bytes::INST),157		// Objects158		("objectFieldsEx", builtin_object_fields_ex::INST),159		("objectFields", builtin_object_fields::INST),160		("objectFieldsAll", builtin_object_fields_all::INST),161		("objectValues", builtin_object_values::INST),162		("objectValuesAll", builtin_object_values_all::INST),163		("objectKeysValues", builtin_object_keys_values::INST),164		("objectKeysValuesAll", builtin_object_keys_values_all::INST),165		("objectHasEx", builtin_object_has_ex::INST),166		("objectHas", builtin_object_has::INST),167		("objectHasAll", builtin_object_has_all::INST),168		("objectRemoveKey", builtin_object_remove_key::INST),169		// Manifest170		("escapeStringJson", builtin_escape_string_json::INST),171		("escapeStringPython", builtin_escape_string_python::INST),172		("escapeStringXML", builtin_escape_string_xml::INST),173		("manifestJsonEx", builtin_manifest_json_ex::INST),174		("manifestJson", builtin_manifest_json::INST),175		("manifestJsonMinified", builtin_manifest_json_minified::INST),176		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),177		("manifestYamlStream", builtin_manifest_yaml_stream::INST),178		("manifestTomlEx", builtin_manifest_toml_ex::INST),179		("manifestToml", builtin_manifest_toml::INST),180		("toString", builtin_to_string::INST),181		("manifestPython", builtin_manifest_python::INST),182		("manifestPythonVars", builtin_manifest_python_vars::INST),183		("manifestXmlJsonml", builtin_manifest_xml_jsonml::INST),184		("manifestIni", builtin_manifest_ini::INST),185		// Parse186		("parseJson", builtin_parse_json::INST),187		("parseYaml", builtin_parse_yaml::INST),188		// Strings189		("codepoint", builtin_codepoint::INST),190		("substr", builtin_substr::INST),191		("char", builtin_char::INST),192		("strReplace", builtin_str_replace::INST),193		("escapeStringBash", builtin_escape_string_bash::INST),194		("escapeStringDollars", builtin_escape_string_dollars::INST),195		("isEmpty", builtin_is_empty::INST),196		("equalsIgnoreCase", builtin_equals_ignore_case::INST),197		("splitLimit", builtin_splitlimit::INST),198		("splitLimitR", builtin_splitlimitr::INST),199		("split", builtin_split::INST),200		("asciiUpper", builtin_ascii_upper::INST),201		("asciiLower", builtin_ascii_lower::INST),202		("findSubstr", builtin_find_substr::INST),203		("parseInt", builtin_parse_int::INST),204		#[cfg(feature = "exp-bigint")]205		("bigint", builtin_bigint::INST),206		("parseOctal", builtin_parse_octal::INST),207		("parseHex", builtin_parse_hex::INST),208		("stringChars", builtin_string_chars::INST),209		("lstripChars", builtin_lstrip_chars::INST),210		("rstripChars", builtin_rstrip_chars::INST),211		("stripChars", builtin_strip_chars::INST),212		// Misc213		("length", builtin_length::INST),214		("get", builtin_get::INST),215		("startsWith", builtin_starts_with::INST),216		("endsWith", builtin_ends_with::INST),217		("assertEqual", builtin_assert_equal::INST),218		("mergePatch", builtin_merge_patch::INST),219		// Sets220		("setMember", builtin_set_member::INST),221		("setInter", builtin_set_inter::INST),222		("setDiff", builtin_set_diff::INST),223		("setUnion", builtin_set_union::INST),224		// Regex225		#[cfg(feature = "exp-regex")]226		("regexQuoteMeta", builtin_regex_quote_meta::INST),227		// Compat228		("__compare", builtin___compare::INST),229		("__compare_array", builtin___compare_array::INST),230		("__array_less", builtin___array_less::INST),231		("__array_greater", builtin___array_greater::INST),232		("__array_less_or_equal", builtin___array_less_or_equal::INST),233		(234			"__array_greater_or_equal",235			builtin___array_greater_or_equal::INST,236		),237	]238	.iter()239	.copied()240	{241		builder.method(name, builtin);242	}243244	builder.method(245		"extVar",246		builtin_ext_var {247			settings: settings.clone(),248		},249	);250	builder.method(251		"native",252		builtin_native {253			settings: settings.clone(),254		},255	);256	builder.method("trace", builtin_trace { settings });257	builder.method("id", FuncVal::Id);258259	#[cfg(feature = "exp-regex")]260	{261		// Regex262		let regex_cache = RegexCache::default();263		builder.method(264			"regexFullMatch",265			builtin_regex_full_match {266				cache: regex_cache.clone(),267			},268		);269		builder.method(270			"regexPartialMatch",271			builtin_regex_partial_match {272				cache: regex_cache.clone(),273			},274		);275		builder.method(276			"regexReplace",277			builtin_regex_replace {278				cache: regex_cache.clone(),279			},280		);281		builder.method(282			"regexGlobalReplace",283			builtin_regex_global_replace { cache: regex_cache },284		);285	};286287	builder.build()288}289290pub trait TracePrinter {291	fn print_trace(&self, loc: CallLocation, value: IStr);292}293294pub struct StdTracePrinter {295	resolver: PathResolver,296}297impl StdTracePrinter {298	pub fn new(resolver: PathResolver) -> Self {299		Self { resolver }300	}301}302impl TracePrinter for StdTracePrinter {303	fn print_trace(&self, loc: CallLocation, value: IStr) {304		eprint!("TRACE:");305		if let Some(loc) = loc.0 {306			let locs = loc.0.map_source_locations(&[loc.1]);307			eprint!(308				" {}:{}",309				loc.0.source_path().path().map_or_else(310					|| loc.0.source_path().to_string(),311					|p| self.resolver.resolve(p)312				),313				locs[0].line314			);315		}316		eprintln!(" {value}");317	}318}319320pub struct Settings {321	/// Used for `std.extVar`322	pub ext_vars: HashMap<IStr, TlaArg>,323	/// Used for `std.native`324	pub ext_natives: HashMap<IStr, FuncVal>,325	/// Used for `std.trace`326	pub trace_printer: Box<dyn TracePrinter>,327	/// Used for `std.thisFile`328	pub path_resolver: PathResolver,329}330331fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {332	let source_name = format!("<extvar:{name}>");333	Source::new_virtual(source_name.into(), code.into())334}335336#[derive(Trace, Clone)]337pub struct ContextInitializer {338	/// When we don't need to support legacy-this-file, we can reuse same context for all files339	#[cfg(not(feature = "legacy-this-file"))]340	context: jrsonnet_evaluator::Context,341	/// For `populate`342	#[cfg(not(feature = "legacy-this-file"))]343	stdlib_thunk: Thunk<Val>,344	/// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it345	#[cfg(feature = "legacy-this-file")]346	stdlib_obj: ObjValue,347	settings: Rc<RefCell<Settings>>,348}349impl ContextInitializer {350	pub fn new(s: State, resolver: PathResolver) -> Self {351		let settings = Settings {352			ext_vars: HashMap::new(),353			ext_natives: HashMap::new(),354			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),355			path_resolver: resolver,356		};357		let settings = Rc::new(RefCell::new(settings));358		let stdlib_obj = stdlib_uncached(settings.clone());359		#[cfg(not(feature = "legacy-this-file"))]360		let stdlib_thunk = Thunk::evaluated(Val::Obj(stdlib_obj));361		#[cfg(feature = "legacy-this-file")]362		let _ = s;363		Self {364			#[cfg(not(feature = "legacy-this-file"))]365			context: {366				let mut context = ContextBuilder::with_capacity(s, 1);367				context.bind("std", stdlib_thunk.clone());368				context.build()369			},370			#[cfg(not(feature = "legacy-this-file"))]371			stdlib_thunk,372			#[cfg(feature = "legacy-this-file")]373			stdlib_obj,374			settings,375		}376	}377	pub fn settings(&self) -> Ref<Settings> {378		self.settings.borrow()379	}380	pub fn settings_mut(&self) -> RefMut<Settings> {381		self.settings.borrow_mut()382	}383	pub fn add_ext_var(&self, name: IStr, value: Val) {384		self.settings_mut()385			.ext_vars386			.insert(name, TlaArg::Val(value));387	}388	pub fn add_ext_str(&self, name: IStr, value: IStr) {389		self.settings_mut()390			.ext_vars391			.insert(name, TlaArg::String(value));392	}393	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {394		let code = code.into();395		let source = extvar_source(name, code.clone());396		let parsed = jrsonnet_parser::parse(397			&code,398			&jrsonnet_parser::ParserSettings {399				source: source.clone(),400			},401		)402		.map_err(|e| ImportSyntaxError {403			path: source,404			error: Box::new(e),405		})?;406		// self.data_mut().volatile_files.insert(source_name, code);407		self.settings_mut()408			.ext_vars409			.insert(name.into(), TlaArg::Code(parsed));410		Ok(())411	}412	pub fn add_native(&self, name: impl Into<IStr>, cb: impl Into<FuncVal>) {413		self.settings_mut()414			.ext_natives415			.insert(name.into(), cb.into());416	}417}418impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {419	fn reserve_vars(&self) -> usize {420		1421	}422	#[cfg(not(feature = "legacy-this-file"))]423	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {424		self.context.clone()425	}426	#[cfg(not(feature = "legacy-this-file"))]427	fn populate(&self, _for_file: Source, builder: &mut ContextBuilder) {428		builder.bind("std", self.stdlib_thunk.clone());429	}430	#[cfg(feature = "legacy-this-file")]431	fn populate(&self, source: Source, builder: &mut ContextBuilder) {432		let mut std = ObjValueBuilder::new();433		std.with_super(self.stdlib_obj.clone());434		std.field("thisFile").hide().value({435			let source_path = source.source_path();436			source_path.path().map_or_else(437				|| source_path.to_string(),438				|p| self.settings().path_resolver.resolve(p),439			)440		});441		let stdlib_with_this_file = std.build();442443		builder.bind("std", Thunk::evaluated(Val::Obj(stdlib_with_this_file)));444	}445	fn as_any(&self) -> &dyn std::any::Any {446		self447	}448}449450pub trait StateExt {451	/// This method was previously implemented in jrsonnet-evaluator itself452	fn with_stdlib(&self);453}454455impl StateExt for State {456	fn with_stdlib(&self) {457		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());458		self.settings_mut().context_initializer = tb!(initializer);459	}460}