git.delta.rocks / jrsonnet / refs/commits / 7b8b823d230b

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs9.9 KiBsourcehistory
1use std::{2	cell::{Ref, RefCell, RefMut},3	collections::HashMap,4	rc::Rc,5};67use jrsonnet_evaluator::{8	error::{Error::*, 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;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::*;4344pub fn stdlib_uncached(s: State, settings: Rc<RefCell<Settings>>) -> ObjValue {45	let mut builder = ObjValueBuilder::new();4647	let expr = expr::stdlib_expr();48	let eval = jrsonnet_evaluator::evaluate(s.clone(), Context::default(), &expr)49		.expect("stdlib.jsonnet should have no errors")50		.as_obj()51		.expect("stdlib.jsonnet should evaluate to object");5253	builder.with_super(eval);5455	for (name, builtin) in [56		// Types57		("type", builtin_type::INST),58		("isString", builtin_is_string::INST),59		("isNumber", builtin_is_number::INST),60		("isBoolean", builtin_is_boolean::INST),61		("isObject", builtin_is_object::INST),62		("isArray", builtin_is_array::INST),63		("isFunction", builtin_is_function::INST),64		// Arrays65		("makeArray", builtin_make_array::INST),66		("slice", builtin_slice::INST),67		("map", builtin_map::INST),68		("flatMap", builtin_flatmap::INST),69		("filter", builtin_filter::INST),70		("foldl", builtin_foldl::INST),71		("foldr", builtin_foldr::INST),72		("range", builtin_range::INST),73		("join", builtin_join::INST),74		("reverse", builtin_reverse::INST),75		("any", builtin_any::INST),76		("all", builtin_all::INST),77		("member", builtin_member::INST),78		("count", builtin_count::INST),79		// Math80		("modulo", builtin_modulo::INST),81		("floor", builtin_floor::INST),82		("ceil", builtin_ceil::INST),83		("log", builtin_log::INST),84		("pow", builtin_pow::INST),85		("sqrt", builtin_sqrt::INST),86		("sin", builtin_sin::INST),87		("cos", builtin_cos::INST),88		("tan", builtin_tan::INST),89		("asin", builtin_asin::INST),90		("acos", builtin_acos::INST),91		("atan", builtin_atan::INST),92		("exp", builtin_exp::INST),93		("mantissa", builtin_mantissa::INST),94		("exponent", builtin_exponent::INST),95		// Operator96		("mod", builtin_mod::INST),97		("primitiveEquals", builtin_primitive_equals::INST),98		("equals", builtin_equals::INST),99		("format", builtin_format::INST),100		// Sort101		("sort", builtin_sort::INST),102		// Hash103		("md5", builtin_md5::INST),104		// Encoding105		("encodeUTF8", builtin_encode_utf8::INST),106		("decodeUTF8", builtin_decode_utf8::INST),107		("base64", builtin_base64::INST),108		("base64Decode", builtin_base64_decode::INST),109		("base64DecodeBytes", builtin_base64_decode_bytes::INST),110		// Objects111		("objectFieldsEx", builtin_object_fields_ex::INST),112		("objectHasEx", builtin_object_has_ex::INST),113		// Manifest114		("escapeStringJson", builtin_escape_string_json::INST),115		("manifestJsonEx", builtin_manifest_json_ex::INST),116		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),117		// Parsing118		("parseJson", builtin_parse_json::INST),119		("parseYaml", builtin_parse_yaml::INST),120		// Strings121		("codepoint", builtin_codepoint::INST),122		("substr", builtin_substr::INST),123		("char", builtin_char::INST),124		("strReplace", builtin_str_replace::INST),125		("splitLimit", builtin_splitlimit::INST),126		("asciiUpper", builtin_ascii_upper::INST),127		("asciiLower", builtin_ascii_lower::INST),128		("findSubstr", builtin_find_substr::INST),129		// Misc130		("length", builtin_length::INST),131		("startsWith", builtin_starts_with::INST),132		("endsWith", builtin_ends_with::INST),133	]134	.iter()135	.cloned()136	{137		builder138			.member(name.into())139			.hide()140			.value(s.clone(), Val::Func(FuncVal::StaticBuiltin(builtin)))141			.expect("no conflict");142	}143144	builder145		.member("extVar".into())146		.hide()147		.value(148			s.clone(),149			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_ext_var {150				settings: settings.clone()151			})))),152		)153		.expect("no conflict");154	builder155		.member("native".into())156		.hide()157		.value(158			s.clone(),159			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_native {160				settings: settings.clone()161			})))),162		)163		.expect("no conflict");164	builder165		.member("trace".into())166		.hide()167		.value(168			s.clone(),169			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_trace { settings })))),170		)171		.expect("no conflict");172173	builder174		.member("id".into())175		.hide()176		.value(s, Val::Func(FuncVal::Id))177		.expect("no conflict");178179	builder.build()180}181182pub trait TracePrinter {183	fn print_trace(&self, s: State, loc: CallLocation, value: IStr);184}185186pub struct StdTracePrinter {187	resolver: PathResolver,188}189impl StdTracePrinter {190	pub fn new(resolver: PathResolver) -> Self {191		Self { resolver }192	}193}194impl TracePrinter for StdTracePrinter {195	fn print_trace(&self, _s: State, loc: CallLocation, value: IStr) {196		eprint!("TRACE:");197		if let Some(loc) = loc.0 {198			let locs = loc.0.map_source_locations(&[loc.1]);199			eprint!(200				" {}:{}",201				match loc.0.source_path().path() {202					Some(p) => self.resolver.resolve(p),203					None => loc.0.source_path().to_string(),204				},205				locs[0].line206			);207		}208		eprintln!(" {}", value);209	}210}211212pub struct Settings {213	/// Used for `std.extVar`214	pub ext_vars: HashMap<IStr, TlaArg>,215	/// Used for `std.native`216	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,217	/// Helper to add globals without implementing custom ContextInitializer218	pub globals: GcHashMap<IStr, Thunk<Val>>,219	/// Used for `std.trace`220	pub trace_printer: Box<dyn TracePrinter>,221	/// Used for `std.thisFile`222	pub path_resolver: PathResolver,223}224225pub fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {226	let source_name = format!("<extvar:{}>", name);227	Source::new_virtual(source_name.into(), code.into())228}229230pub struct ContextInitializer {231	// When we don't need to support legacy-this-file, we can reuse same context for all files232	#[cfg(not(feature = "legacy-this-file"))]233	context: Context,234	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it235	#[cfg(feature = "legacy-this-file")]236	stdlib_obj: ObjValue,237	settings: Rc<RefCell<Settings>>,238}239impl ContextInitializer {240	pub fn new(s: State, resolver: PathResolver) -> Self {241		let settings = Settings {242			ext_vars: Default::default(),243			ext_natives: Default::default(),244			globals: Default::default(),245			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),246			path_resolver: resolver,247		};248		let settings = Rc::new(RefCell::new(settings));249		Self {250			#[cfg(not(feature = "legacy-this-file"))]251			context: {252				let mut context = ContextBuilder::with_capacity(1);253				context.bind(254					"std".into(),255					Thunk::evaluated(Val::Obj(stdlib_uncached(s, settings.clone()))),256				);257				context.build()258			},259			#[cfg(feature = "legacy-this-file")]260			stdlib_obj: stdlib_uncached(s, settings.clone()),261			settings,262		}263	}264	pub fn settings(&self) -> Ref<Settings> {265		self.settings.borrow()266	}267	pub fn settings_mut(&self) -> RefMut<Settings> {268		self.settings.borrow_mut()269	}270	pub fn add_ext_var(&self, name: IStr, value: Val) {271		self.settings_mut()272			.ext_vars273			.insert(name, TlaArg::Val(value));274	}275	pub fn add_ext_str(&self, name: IStr, value: IStr) {276		self.settings_mut()277			.ext_vars278			.insert(name, TlaArg::String(value));279	}280	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {281		let code = code.into();282		let source = extvar_source(name, code.clone());283		let parsed = jrsonnet_parser::parse(284			&code,285			&jrsonnet_parser::ParserSettings {286				file_name: source.clone(),287			},288		)289		.map_err(|e| ImportSyntaxError {290			path: source,291			error: Box::new(e),292		})?;293		// self.data_mut().volatile_files.insert(source_name, code);294		self.settings_mut()295			.ext_vars296			.insert(name.into(), TlaArg::Code(parsed));297		Ok(())298	}299	pub fn add_native(&self, name: IStr, cb: Cc<TraceBox<dyn Builtin>>) {300		self.settings_mut().ext_natives.insert(name, cb);301	}302}303impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {304	#[cfg(not(feature = "legacy-this-file"))]305	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {306		let out = self.context.clone();307		let globals = &self.settings().globals;308		if globals.is_empty() {309			return out;310		}311312		let mut out = ContextBuilder::extend(out);313		for (k, v) in globals.iter() {314			out.bind(k.clone(), v.clone());315		}316		out.build()317	}318	#[cfg(feature = "legacy-this-file")]319	fn initialize(&self, s: State, source: Source) -> jrsonnet_evaluator::Context {320		let mut builder = ObjValueBuilder::new();321		builder.with_super(self.stdlib_obj.clone());322		builder323			.member("thisFile".into())324			.hide()325			.value(326				s,327				Val::Str(match source.source_path().path() {328					Some(p) => self.settings().path_resolver.resolve(p).into(),329					None => source.source_path().to_string().into(),330				}),331			)332			.expect("this object builder is empty");333		let stdlib_with_this_file = builder.build();334335		let mut context = ContextBuilder::with_capacity(1);336		context.bind(337			"std".into(),338			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),339		);340		for (k, v) in self.settings().globals.iter() {341			context.bind(k.clone(), v.clone());342		}343		context.build()344	}345	fn as_any(&self) -> &dyn std::any::Any {346		self347	}348}349350pub trait StateExt {351	/// This method was previously implemented in jrsonnet-evaluator itself352	fn with_stdlib(&self);353	fn add_global(&self, name: IStr, value: Thunk<Val>);354}355356impl StateExt for State {357	fn with_stdlib(&self) {358		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());359		self.settings_mut().context_initializer = Box::new(initializer)360	}361	fn add_global(&self, name: IStr, value: Thunk<Val>) {362		self.settings()363			.context_initializer364			.as_any()365			.downcast_ref::<ContextInitializer>()366			.expect("not standard context initializer")367			.settings_mut()368			.globals369			.insert(name, value);370	}371}