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

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs10.5 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		// Hash116		("md5", builtin_md5::INST),117		#[cfg(feature = "exp-more-hashes")]118		("sha256", builtin_sha256::INST),119		// Encoding120		("encodeUTF8", builtin_encode_utf8::INST),121		("decodeUTF8", builtin_decode_utf8::INST),122		("base64", builtin_base64::INST),123		("base64Decode", builtin_base64_decode::INST),124		("base64DecodeBytes", builtin_base64_decode_bytes::INST),125		// Objects126		("objectFieldsEx", builtin_object_fields_ex::INST),127		("objectHasEx", builtin_object_has_ex::INST),128		// Manifest129		("escapeStringJson", builtin_escape_string_json::INST),130		("manifestJsonEx", builtin_manifest_json_ex::INST),131		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),132		("manifestTomlEx", builtin_manifest_toml_ex::INST),133		// Parsing134		("parseJson", builtin_parse_json::INST),135		("parseYaml", builtin_parse_yaml::INST),136		// Strings137		("codepoint", builtin_codepoint::INST),138		("substr", builtin_substr::INST),139		("char", builtin_char::INST),140		("strReplace", builtin_str_replace::INST),141		("splitLimit", builtin_splitlimit::INST),142		("asciiUpper", builtin_ascii_upper::INST),143		("asciiLower", builtin_ascii_lower::INST),144		("findSubstr", builtin_find_substr::INST),145		("parseInt", builtin_parse_int::INST),146		("parseOctal", builtin_parse_octal::INST),147		("parseHex", builtin_parse_hex::INST),148		// Misc149		("length", builtin_length::INST),150		("startsWith", builtin_starts_with::INST),151		("endsWith", builtin_ends_with::INST),152		// Sets153		("setMember", builtin_set_member::INST),154		("setInter", builtin_set_inter::INST),155		// Compat156		("__compare", builtin___compare::INST),157	]158	.iter()159	.cloned()160	{161		builder162			.member(name.into())163			.hide()164			.value(Val::Func(FuncVal::StaticBuiltin(builtin)))165			.expect("no conflict");166	}167168	builder169		.member("extVar".into())170		.hide()171		.value(Val::Func(FuncVal::builtin(builtin_ext_var {172			settings: settings.clone(),173		})))174		.expect("no conflict");175	builder176		.member("native".into())177		.hide()178		.value(Val::Func(FuncVal::builtin(builtin_native {179			settings: settings.clone(),180		})))181		.expect("no conflict");182	builder183		.member("trace".into())184		.hide()185		.value(Val::Func(FuncVal::builtin(builtin_trace { settings })))186		.expect("no conflict");187188	builder189		.member("id".into())190		.hide()191		.value(Val::Func(FuncVal::Id))192		.expect("no conflict");193194	builder.build()195}196197pub trait TracePrinter {198	fn print_trace(&self, loc: CallLocation, value: IStr);199}200201pub struct StdTracePrinter {202	resolver: PathResolver,203}204impl StdTracePrinter {205	pub fn new(resolver: PathResolver) -> Self {206		Self { resolver }207	}208}209impl TracePrinter for StdTracePrinter {210	fn print_trace(&self, loc: CallLocation, value: IStr) {211		eprint!("TRACE:");212		if let Some(loc) = loc.0 {213			let locs = loc.0.map_source_locations(&[loc.1]);214			eprint!(215				" {}:{}",216				match loc.0.source_path().path() {217					Some(p) => self.resolver.resolve(p),218					None => loc.0.source_path().to_string(),219				},220				locs[0].line221			);222		}223		eprintln!(" {value}");224	}225}226227pub struct Settings {228	/// Used for `std.extVar`229	pub ext_vars: HashMap<IStr, TlaArg>,230	/// Used for `std.native`231	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,232	/// Helper to add globals without implementing custom ContextInitializer233	pub globals: GcHashMap<IStr, Thunk<Val>>,234	/// Used for `std.trace`235	pub trace_printer: Box<dyn TracePrinter>,236	/// Used for `std.thisFile`237	pub path_resolver: PathResolver,238}239240fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {241	let source_name = format!("<extvar:{name}>");242	Source::new_virtual(source_name.into(), code.into())243}244245#[derive(Trace, Clone)]246pub struct ContextInitializer {247	// When we don't need to support legacy-this-file, we can reuse same context for all files248	#[cfg(not(feature = "legacy-this-file"))]249	context: Context,250	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it251	#[cfg(feature = "legacy-this-file")]252	stdlib_obj: ObjValue,253	settings: Rc<RefCell<Settings>>,254}255impl ContextInitializer {256	pub fn new(_s: State, resolver: PathResolver) -> Self {257		let settings = Settings {258			ext_vars: Default::default(),259			ext_natives: Default::default(),260			globals: Default::default(),261			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),262			path_resolver: resolver,263		};264		let settings = Rc::new(RefCell::new(settings));265		Self {266			#[cfg(not(feature = "legacy-this-file"))]267			context: {268				let mut context = ContextBuilder::with_capacity(_s, 1);269				context.bind(270					"std".into(),271					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),272				);273				context.build()274			},275			#[cfg(feature = "legacy-this-file")]276			stdlib_obj: stdlib_uncached(settings.clone()),277			settings,278		}279	}280	pub fn settings(&self) -> Ref<Settings> {281		self.settings.borrow()282	}283	pub fn settings_mut(&self) -> RefMut<Settings> {284		self.settings.borrow_mut()285	}286	pub fn add_ext_var(&self, name: IStr, value: Val) {287		self.settings_mut()288			.ext_vars289			.insert(name, TlaArg::Val(value));290	}291	pub fn add_ext_str(&self, name: IStr, value: IStr) {292		self.settings_mut()293			.ext_vars294			.insert(name, TlaArg::String(value));295	}296	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {297		let code = code.into();298		let source = extvar_source(name, code.clone());299		let parsed = jrsonnet_parser::parse(300			&code,301			&jrsonnet_parser::ParserSettings {302				source: source.clone(),303			},304		)305		.map_err(|e| ImportSyntaxError {306			path: source,307			error: Box::new(e),308		})?;309		// self.data_mut().volatile_files.insert(source_name, code);310		self.settings_mut()311			.ext_vars312			.insert(name.into(), TlaArg::Code(parsed));313		Ok(())314	}315	pub fn add_native(&self, name: IStr, cb: impl Builtin) {316		self.settings_mut()317			.ext_natives318			.insert(name, Cc::new(tb!(cb)));319	}320}321impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {322	#[cfg(not(feature = "legacy-this-file"))]323	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {324		let out = self.context.clone();325		let globals = &self.settings().globals;326		if globals.is_empty() {327			return out;328		}329330		let mut out = ContextBuilder::extend(out);331		for (k, v) in globals.iter() {332			out.bind(k.clone(), v.clone());333		}334		out.build()335	}336	#[cfg(feature = "legacy-this-file")]337	fn initialize(&self, s: State, source: Source) -> Context {338		use jrsonnet_evaluator::val::StrValue;339340		let mut builder = ObjValueBuilder::new();341		builder.with_super(self.stdlib_obj.clone());342		builder343			.member("thisFile".into())344			.hide()345			.value(Val::Str(StrValue::Flat(346				match source.source_path().path() {347					Some(p) => self.settings().path_resolver.resolve(p).into(),348					None => source.source_path().to_string().into(),349				},350			)))351			.expect("this object builder is empty");352		let stdlib_with_this_file = builder.build();353354		let mut context = ContextBuilder::with_capacity(s, 1);355		context.bind(356			"std".into(),357			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),358		);359		for (k, v) in self.settings().globals.iter() {360			context.bind(k.clone(), v.clone());361		}362		context.build()363	}364	fn as_any(&self) -> &dyn std::any::Any {365		self366	}367}368369pub trait StateExt {370	/// This method was previously implemented in jrsonnet-evaluator itself371	fn with_stdlib(&self);372	fn add_global(&self, name: IStr, value: Thunk<Val>);373}374375impl StateExt for State {376	fn with_stdlib(&self) {377		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());378		self.settings_mut().context_initializer = tb!(initializer)379	}380	fn add_global(&self, name: IStr, value: Thunk<Val>) {381		self.settings()382			.context_initializer383			.as_any()384			.downcast_ref::<ContextInitializer>()385			.expect("not standard context initializer")386			.settings_mut()387			.globals388			.insert(name, value);389	}390}