git.delta.rocks / jrsonnet / refs/commits / 761e42906daa

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs11.7 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	trace::PathResolver,17	ContextBuilder, IStr, ObjValue, ObjValueBuilder, Thunk, Val,18};19use jrsonnet_gcmodule::Trace;20use jrsonnet_parser::Source;21pub use manifest::*;22pub use math::*;23pub use misc::*;24pub use objects::*;25pub use operator::*;26pub use parse::*;27pub use sets::*;28pub use sort::*;29pub use strings::*;30pub use types::*;3132#[cfg(feature = "exp-regex")]33pub use crate::regex::*;3435mod arrays;36mod compat;37mod encoding;38mod hash;39mod manifest;40mod math;41mod misc;42mod objects;43mod operator;44mod parse;45#[cfg(feature = "exp-regex")]46mod regex;47mod sets;48mod sort;49mod strings;50mod types;5152#[allow(clippy::too_many_lines)]53pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {54	let mut builder = ObjValueBuilder::new();5556	// FIXME: Use PHF57	for (name, builtin) in [58		// Types59		("type", builtin_type::INST),60		("isString", builtin_is_string::INST),61		("isNumber", builtin_is_number::INST),62		("isBoolean", builtin_is_boolean::INST),63		("isObject", builtin_is_object::INST),64		("isArray", builtin_is_array::INST),65		("isFunction", builtin_is_function::INST),66		// Arrays67		("makeArray", builtin_make_array::INST),68		("repeat", builtin_repeat::INST),69		("slice", builtin_slice::INST),70		("map", builtin_map::INST),71		("mapWithIndex", builtin_map_with_index::INST),72		("mapWithKey", builtin_map_with_key::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		("lines", builtin_lines::INST),80		("resolvePath", builtin_resolve_path::INST),81		("deepJoin", builtin_deep_join::INST),82		("reverse", builtin_reverse::INST),83		("any", builtin_any::INST),84		("all", builtin_all::INST),85		("member", builtin_member::INST),86		("find", builtin_find::INST),87		("contains", builtin_contains::INST),88		("count", builtin_count::INST),89		("avg", builtin_avg::INST),90		("removeAt", builtin_remove_at::INST),91		("remove", builtin_remove::INST),92		("flattenArrays", builtin_flatten_arrays::INST),93		("flattenDeepArray", builtin_flatten_deep_array::INST),94		("prune", builtin_prune::INST),95		("filterMap", builtin_filter_map::INST),96		// Math97		("abs", builtin_abs::INST),98		("sign", builtin_sign::INST),99		("max", builtin_max::INST),100		("min", builtin_min::INST),101		("clamp", builtin_clamp::INST),102		("sum", builtin_sum::INST),103		("modulo", builtin_modulo::INST),104		("floor", builtin_floor::INST),105		("ceil", builtin_ceil::INST),106		("log", builtin_log::INST),107		("pow", builtin_pow::INST),108		("sqrt", builtin_sqrt::INST),109		("sin", builtin_sin::INST),110		("cos", builtin_cos::INST),111		("tan", builtin_tan::INST),112		("asin", builtin_asin::INST),113		("acos", builtin_acos::INST),114		("atan", builtin_atan::INST),115		("atan2", builtin_atan2::INST),116		("exp", builtin_exp::INST),117		("mantissa", builtin_mantissa::INST),118		("exponent", builtin_exponent::INST),119		("round", builtin_round::INST),120		("isEven", builtin_is_even::INST),121		("isOdd", builtin_is_odd::INST),122		("isInteger", builtin_is_integer::INST),123		("isDecimal", builtin_is_decimal::INST),124		// Operator125		("mod", builtin_mod::INST),126		("primitiveEquals", builtin_primitive_equals::INST),127		("equals", builtin_equals::INST),128		("xor", builtin_xor::INST),129		("xnor", builtin_xnor::INST),130		("format", builtin_format::INST),131		// Sort132		("sort", builtin_sort::INST),133		("uniq", builtin_uniq::INST),134		("set", builtin_set::INST),135		("minArray", builtin_min_array::INST),136		("maxArray", builtin_max_array::INST),137		// Hash138		("md5", builtin_md5::INST),139		("sha1", builtin_sha1::INST),140		("sha256", builtin_sha256::INST),141		("sha512", builtin_sha512::INST),142		("sha3", builtin_sha3::INST),143		// Encoding144		("encodeUTF8", builtin_encode_utf8::INST),145		("decodeUTF8", builtin_decode_utf8::INST),146		("base64", builtin_base64::INST),147		("base64Decode", builtin_base64_decode::INST),148		("base64DecodeBytes", builtin_base64_decode_bytes::INST),149		// Objects150		("objectFieldsEx", builtin_object_fields_ex::INST),151		("objectFields", builtin_object_fields::INST),152		("objectFieldsAll", builtin_object_fields_all::INST),153		("objectValues", builtin_object_values::INST),154		("objectValuesAll", builtin_object_values_all::INST),155		("objectKeysValues", builtin_object_keys_values::INST),156		("objectKeysValuesAll", builtin_object_keys_values_all::INST),157		("objectHasEx", builtin_object_has_ex::INST),158		("objectHas", builtin_object_has::INST),159		("objectHasAll", builtin_object_has_all::INST),160		("objectRemoveKey", builtin_object_remove_key::INST),161		// Manifest162		("escapeStringJson", builtin_escape_string_json::INST),163		("escapeStringPython", builtin_escape_string_python::INST),164		("escapeStringXML", builtin_escape_string_xml::INST),165		("manifestJsonEx", builtin_manifest_json_ex::INST),166		("manifestJson", builtin_manifest_json::INST),167		("manifestJsonMinified", builtin_manifest_json_minified::INST),168		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),169		("manifestYamlStream", builtin_manifest_yaml_stream::INST),170		("manifestTomlEx", builtin_manifest_toml_ex::INST),171		("manifestToml", builtin_manifest_toml::INST),172		("toString", builtin_to_string::INST),173		("manifestPython", builtin_manifest_python::INST),174		("manifestPythonVars", builtin_manifest_python_vars::INST),175		("manifestXmlJsonml", builtin_manifest_xml_jsonml::INST),176		("manifestIni", builtin_manifest_ini::INST),177		// Parse178		("parseJson", builtin_parse_json::INST),179		("parseYaml", builtin_parse_yaml::INST),180		// Strings181		("codepoint", builtin_codepoint::INST),182		("substr", builtin_substr::INST),183		("char", builtin_char::INST),184		("strReplace", builtin_str_replace::INST),185		("escapeStringBash", builtin_escape_string_bash::INST),186		("escapeStringDollars", builtin_escape_string_dollars::INST),187		("isEmpty", builtin_is_empty::INST),188		("equalsIgnoreCase", builtin_equals_ignore_case::INST),189		("splitLimit", builtin_splitlimit::INST),190		("splitLimitR", builtin_splitlimitr::INST),191		("split", builtin_split::INST),192		("asciiUpper", builtin_ascii_upper::INST),193		("asciiLower", builtin_ascii_lower::INST),194		("findSubstr", builtin_find_substr::INST),195		("parseInt", builtin_parse_int::INST),196		#[cfg(feature = "exp-bigint")]197		("bigint", builtin_bigint::INST),198		("parseOctal", builtin_parse_octal::INST),199		("parseHex", builtin_parse_hex::INST),200		("stringChars", builtin_string_chars::INST),201		("lstripChars", builtin_lstrip_chars::INST),202		("rstripChars", builtin_rstrip_chars::INST),203		("stripChars", builtin_strip_chars::INST),204		// Misc205		("length", builtin_length::INST),206		("get", builtin_get::INST),207		("startsWith", builtin_starts_with::INST),208		("endsWith", builtin_ends_with::INST),209		("assertEqual", builtin_assert_equal::INST),210		("mergePatch", builtin_merge_patch::INST),211		// Sets212		("setMember", builtin_set_member::INST),213		("setInter", builtin_set_inter::INST),214		("setDiff", builtin_set_diff::INST),215		("setUnion", builtin_set_union::INST),216		// Regex217		#[cfg(feature = "exp-regex")]218		("regexQuoteMeta", builtin_regex_quote_meta::INST),219		// Compat220		("__compare", builtin___compare::INST),221		("__compare_array", builtin___compare_array::INST),222		("__array_less", builtin___array_less::INST),223		("__array_greater", builtin___array_greater::INST),224		("__array_less_or_equal", builtin___array_less_or_equal::INST),225		(226			"__array_greater_or_equal",227			builtin___array_greater_or_equal::INST,228		),229	]230	.iter()231	.copied()232	{233		builder.method(name, builtin);234	}235236	builder.method(237		"extVar",238		builtin_ext_var {239			settings: settings.clone(),240		},241	);242	builder.method(243		"native",244		builtin_native {245			settings: settings.clone(),246		},247	);248	builder.method("trace", builtin_trace { settings });249	builder.method("id", FuncVal::Id);250251	#[cfg(feature = "exp-regex")]252	{253		// Regex254		let regex_cache = RegexCache::default();255		builder.method(256			"regexFullMatch",257			builtin_regex_full_match {258				cache: regex_cache.clone(),259			},260		);261		builder.method(262			"regexPartialMatch",263			builtin_regex_partial_match {264				cache: regex_cache.clone(),265			},266		);267		builder.method(268			"regexReplace",269			builtin_regex_replace {270				cache: regex_cache.clone(),271			},272		);273		builder.method(274			"regexGlobalReplace",275			builtin_regex_global_replace { cache: regex_cache },276		);277	};278279	builder.build()280}281282pub trait TracePrinter {283	fn print_trace(&self, loc: CallLocation, value: IStr);284}285286pub struct StdTracePrinter {287	resolver: PathResolver,288}289impl StdTracePrinter {290	pub fn new(resolver: PathResolver) -> Self {291		Self { resolver }292	}293}294impl TracePrinter for StdTracePrinter {295	fn print_trace(&self, loc: CallLocation, value: IStr) {296		eprint!("TRACE:");297		if let Some(loc) = loc.0 {298			let locs = loc.0.map_source_locations(&[loc.1]);299			eprint!(300				" {}:{}",301				loc.0.source_path().path().map_or_else(302					|| loc.0.source_path().to_string(),303					|p| self.resolver.resolve(p)304				),305				locs[0].line306			);307		}308		eprintln!(" {value}");309	}310}311312pub struct Settings {313	/// Used for `std.extVar`314	pub ext_vars: HashMap<IStr, TlaArg>,315	/// Used for `std.native`316	pub ext_natives: HashMap<IStr, FuncVal>,317	/// Used for `std.trace`318	pub trace_printer: Box<dyn TracePrinter>,319	/// Used for `std.thisFile`320	pub path_resolver: PathResolver,321}322323fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {324	let source_name = format!("<extvar:{name}>");325	Source::new_virtual(source_name.into(), code.into())326}327328#[derive(Trace, Clone)]329pub struct ContextInitializer {330	/// std without applied thisFile overlay331	stdlib_obj: ObjValue,332	settings: Rc<RefCell<Settings>>,333}334impl ContextInitializer {335	pub fn new(resolver: PathResolver) -> Self {336		let settings = Settings {337			ext_vars: HashMap::new(),338			ext_natives: HashMap::new(),339			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),340			path_resolver: resolver,341		};342		let settings = Rc::new(RefCell::new(settings));343		let stdlib_obj = stdlib_uncached(settings.clone());344		Self {345			stdlib_obj,346			settings,347		}348	}349	pub fn settings(&self) -> Ref<Settings> {350		self.settings.borrow()351	}352	pub fn settings_mut(&self) -> RefMut<Settings> {353		self.settings.borrow_mut()354	}355	pub fn add_ext_var(&self, name: IStr, value: Val) {356		self.settings_mut()357			.ext_vars358			.insert(name, TlaArg::Val(value));359	}360	pub fn add_ext_str(&self, name: IStr, value: IStr) {361		self.settings_mut()362			.ext_vars363			.insert(name, TlaArg::String(value));364	}365	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {366		let code = code.into();367		let source = extvar_source(name, code.clone());368		let parsed = jrsonnet_parser::parse(369			&code,370			&jrsonnet_parser::ParserSettings {371				source: source.clone(),372			},373		)374		.map_err(|e| ImportSyntaxError {375			path: source,376			error: Box::new(e),377		})?;378		// self.data_mut().volatile_files.insert(source_name, code);379		self.settings_mut()380			.ext_vars381			.insert(name.into(), TlaArg::Code(parsed));382		Ok(())383	}384	pub fn add_native(&self, name: impl Into<IStr>, cb: impl Into<FuncVal>) {385		self.settings_mut()386			.ext_natives387			.insert(name.into(), cb.into());388	}389}390impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {391	fn reserve_vars(&self) -> usize {392		1393	}394	fn populate(&self, source: Source, builder: &mut ContextBuilder) {395		let mut std = ObjValueBuilder::new();396		std.with_super(self.stdlib_obj.clone());397		std.field("thisFile").hide().value({398			let source_path = source.source_path();399			source_path.path().map_or_else(400				|| source_path.to_string(),401				|p| self.settings().path_resolver.resolve(p),402			)403		});404		let stdlib_with_this_file = std.build();405406		builder.bind("std", Thunk::evaluated(Val::Obj(stdlib_with_this_file)));407	}408	fn as_any(&self) -> &dyn std::any::Any {409		self410	}411}