git.delta.rocks / jrsonnet / refs/commits / 54e5a6e38415

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs10.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::{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		("count", builtin_count::INST),84		// Math85		("abs", builtin_abs::INST),86		("sign", builtin_sign::INST),87		("max", builtin_max::INST),88		("min", builtin_min::INST),89		("sum", builtin_sum::INST),90		("modulo", builtin_modulo::INST),91		("floor", builtin_floor::INST),92		("ceil", builtin_ceil::INST),93		("log", builtin_log::INST),94		("pow", builtin_pow::INST),95		("sqrt", builtin_sqrt::INST),96		("sin", builtin_sin::INST),97		("cos", builtin_cos::INST),98		("tan", builtin_tan::INST),99		("asin", builtin_asin::INST),100		("acos", builtin_acos::INST),101		("atan", builtin_atan::INST),102		("exp", builtin_exp::INST),103		("mantissa", builtin_mantissa::INST),104		("exponent", builtin_exponent::INST),105		// Operator106		("mod", builtin_mod::INST),107		("primitiveEquals", builtin_primitive_equals::INST),108		("equals", builtin_equals::INST),109		("xor", builtin_xor::INST),110		("format", builtin_format::INST),111		// Sort112		("sort", builtin_sort::INST),113		("uniq", builtin_uniq::INST),114		("set", builtin_set::INST),115		("minArray", builtin_min_array::INST),116		("maxArray", builtin_max_array::INST),117		// Hash118		("md5", builtin_md5::INST),119		("sha256", builtin_sha256::INST),120		("sha512", builtin_sha512::INST),121		// Encoding122		("encodeUTF8", builtin_encode_utf8::INST),123		("decodeUTF8", builtin_decode_utf8::INST),124		("base64", builtin_base64::INST),125		("base64Decode", builtin_base64_decode::INST),126		("base64DecodeBytes", builtin_base64_decode_bytes::INST),127		// Objects128		("objectFieldsEx", builtin_object_fields_ex::INST),129		("objectHasEx", builtin_object_has_ex::INST),130		// Manifest131		("escapeStringJson", builtin_escape_string_json::INST),132		("manifestJsonEx", builtin_manifest_json_ex::INST),133		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),134		("manifestTomlEx", builtin_manifest_toml_ex::INST),135		// Parsing136		("parseJson", builtin_parse_json::INST),137		("parseYaml", builtin_parse_yaml::INST),138		// Strings139		("codepoint", builtin_codepoint::INST),140		("substr", builtin_substr::INST),141		("char", builtin_char::INST),142		("strReplace", builtin_str_replace::INST),143		("splitLimit", builtin_splitlimit::INST),144		("asciiUpper", builtin_ascii_upper::INST),145		("asciiLower", builtin_ascii_lower::INST),146		("findSubstr", builtin_find_substr::INST),147		("parseInt", builtin_parse_int::INST),148		#[cfg(feature = "exp-bigint")]149		("bigint", builtin_bigint::INST),150		("parseOctal", builtin_parse_octal::INST),151		("parseHex", builtin_parse_hex::INST),152		// Misc153		("length", builtin_length::INST),154		("startsWith", builtin_starts_with::INST),155		("endsWith", builtin_ends_with::INST),156		// Sets157		("setMember", builtin_set_member::INST),158		("setInter", builtin_set_inter::INST),159		// Compat160		("__compare", builtin___compare::INST),161	]162	.iter()163	.cloned()164	{165		builder166			.member(name.into())167			.hide()168			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))169			.expect("no conflict");170	}171172	builder173		.member("extVar".into())174		.hide()175		.value(Val::Func(FuncVal::builtin(builtin_ext_var {176			settings: settings.clone(),177		})))178		.expect("no conflict");179	builder180		.member("native".into())181		.hide()182		.value(Val::Func(FuncVal::builtin(builtin_native {183			settings: settings.clone(),184		})))185		.expect("no conflict");186	builder187		.member("trace".into())188		.hide()189		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))190		.expect("no conflict");191192	builder193		.member("id".into())194		.hide()195		.value(Val::Func(FuncVal::Id))196		.expect("no conflict");197198	builder.build()199}200201pub trait TracePrinter {202	fn print_trace(&self, loc: CallLocation, value: IStr);203}204205pub struct StdTracePrinter {206	resolver: PathResolver,207}208impl StdTracePrinter {209	pub fn new(resolver: PathResolver) -> Self {210		Self { resolver }211	}212}213impl TracePrinter for StdTracePrinter {214	fn print_trace(&self, loc: CallLocation, value: IStr) {215		eprint!("TRACE:");216		if let Some(loc) = loc.0 {217			let locs = loc.0.map_source_locations(&[loc.1]);218			eprint!(219				" {}:{}",220				match loc.0.source_path().path() {221					Some(p) => self.resolver.resolve(p),222					None => loc.0.source_path().to_string(),223				},224				locs[0].line225			);226		}227		eprintln!(" {value}");228	}229}230231pub struct Settings {232	/// Used for `std.extVar`233	pub ext_vars: HashMap<IStr, TlaArg>,234	/// Used for `std.native`235	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,236	/// Helper to add globals without implementing custom ContextInitializer237	pub globals: GcHashMap<IStr, Thunk<Val>>,238	/// Used for `std.trace`239	pub trace_printer: Box<dyn TracePrinter>,240	/// Used for `std.thisFile`241	pub path_resolver: PathResolver,242}243244fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {245	let source_name = format!("<extvar:{name}>");246	Source::new_virtual(source_name.into(), code.into())247}248249#[derive(Trace, Clone)]250pub struct ContextInitializer {251	// When we don't need to support legacy-this-file, we can reuse same context for all files252	#[cfg(not(feature = "legacy-this-file"))]253	context: Context,254	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it255	#[cfg(feature = "legacy-this-file")]256	stdlib_obj: ObjValue,257	settings: Rc<RefCell<Settings>>,258}259impl ContextInitializer {260	pub fn new(_s: State, resolver: PathResolver) -> Self {261		let settings = Settings {262			ext_vars: Default::default(),263			ext_natives: Default::default(),264			globals: Default::default(),265			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),266			path_resolver: resolver,267		};268		let settings = Rc::new(RefCell::new(settings));269		Self {270			#[cfg(not(feature = "legacy-this-file"))]271			context: {272				let mut context = ContextBuilder::with_capacity(_s, 1);273				context.bind(274					"std".into(),275					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),276				);277				context.build()278			},279			#[cfg(feature = "legacy-this-file")]280			stdlib_obj: stdlib_uncached(settings.clone()),281			settings,282		}283	}284	pub fn settings(&self) -> Ref<Settings> {285		self.settings.borrow()286	}287	pub fn settings_mut(&self) -> RefMut<Settings> {288		self.settings.borrow_mut()289	}290	pub fn add_ext_var(&self, name: IStr, value: Val) {291		self.settings_mut()292			.ext_vars293			.insert(name, TlaArg::Val(value));294	}295	pub fn add_ext_str(&self, name: IStr, value: IStr) {296		self.settings_mut()297			.ext_vars298			.insert(name, TlaArg::String(value));299	}300	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {301		let code = code.into();302		let source = extvar_source(name, code.clone());303		let parsed = jrsonnet_parser::parse(304			&code,305			&jrsonnet_parser::ParserSettings {306				source: source.clone(),307			},308		)309		.map_err(|e| ImportSyntaxError {310			path: source,311			error: Box::new(e),312		})?;313		// self.data_mut().volatile_files.insert(source_name, code);314		self.settings_mut()315			.ext_vars316			.insert(name.into(), TlaArg::Code(parsed));317		Ok(())318	}319	pub fn add_native(&self, name: IStr, cb: impl Builtin) {320		self.settings_mut()321			.ext_natives322			.insert(name, Cc::new(tb!(cb)));323	}324}325impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {326	#[cfg(not(feature = "legacy-this-file"))]327	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {328		let out = self.context.clone();329		let globals = &self.settings().globals;330		if globals.is_empty() {331			return out;332		}333334		let mut out = ContextBuilder::extend(out);335		for (k, v) in globals.iter() {336			out.bind(k.clone(), v.clone());337		}338		out.build()339	}340	#[cfg(feature = "legacy-this-file")]341	fn initialize(&self, s: State, source: Source) -> Context {342		use jrsonnet_evaluator::val::StrValue;343344		let mut builder = ObjValueBuilder::new();345		builder.with_super(self.stdlib_obj.clone());346		builder347			.member("thisFile".into())348			.hide()349			.value(Val::Str(StrValue::Flat(350				match source.source_path().path() {351					Some(p) => self.settings().path_resolver.resolve(p).into(),352					None => source.source_path().to_string().into(),353				},354			)))355			.expect("this object builder is empty");356		let stdlib_with_this_file = builder.build();357358		let mut context = ContextBuilder::with_capacity(s, 1);359		context.bind(360			"std".into(),361			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),362		);363		for (k, v) in self.settings().globals.iter() {364			context.bind(k.clone(), v.clone());365		}366		context.build()367	}368	fn as_any(&self) -> &dyn std::any::Any {369		self370	}371}372373pub trait StateExt {374	/// This method was previously implemented in jrsonnet-evaluator itself375	fn with_stdlib(&self);376	fn add_global(&self, name: IStr, value: Thunk<Val>);377}378379impl StateExt for State {380	fn with_stdlib(&self) {381		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());382		self.settings_mut().context_initializer = tb!(initializer)383	}384	fn add_global(&self, name: IStr, value: Thunk<Val>) {385		self.settings()386			.context_initializer387			.as_any()388			.downcast_ref::<ContextInitializer>()389			.expect("not standard context initializer")390			.settings_mut()391			.globals392			.insert(name, value);393	}394}