git.delta.rocks / jrsonnet / refs/commits / 796c7a04057c

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs9.8 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, 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::*;4344pub fn stdlib_uncached(settings: Rc<RefCell<Settings>>) -> ObjValue {45	let mut builder = ObjValueBuilder::new();4647	let expr = expr::stdlib_expr();48	let eval = jrsonnet_evaluator::evaluate(ContextBuilder::dangerous_empty_state().build(), &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(Val::Func(FuncVal::StaticBuiltin(builtin)))141			.expect("no conflict");142	}143144	builder145		.member("extVar".into())146		.hide()147		.value(Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_ext_var {148			settings: settings.clone()149		})))))150		.expect("no conflict");151	builder152		.member("native".into())153		.hide()154		.value(Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_native {155			settings: settings.clone()156		})))))157		.expect("no conflict");158	builder159		.member("trace".into())160		.hide()161		.value(Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_trace {162			settings163		})))))164		.expect("no conflict");165166	builder167		.member("id".into())168		.hide()169		.value(Val::Func(FuncVal::Id))170		.expect("no conflict");171172	builder.build()173}174175pub trait TracePrinter {176	fn print_trace(&self, loc: CallLocation, value: IStr);177}178179pub struct StdTracePrinter {180	resolver: PathResolver,181}182impl StdTracePrinter {183	pub fn new(resolver: PathResolver) -> Self {184		Self { resolver }185	}186}187impl TracePrinter for StdTracePrinter {188	fn print_trace(&self, loc: CallLocation, value: IStr) {189		eprint!("TRACE:");190		if let Some(loc) = loc.0 {191			let locs = loc.0.map_source_locations(&[loc.1]);192			eprint!(193				" {}:{}",194				match loc.0.source_path().path() {195					Some(p) => self.resolver.resolve(p),196					None => loc.0.source_path().to_string(),197				},198				locs[0].line199			);200		}201		eprintln!(" {}", value);202	}203}204205pub struct Settings {206	/// Used for `std.extVar`207	pub ext_vars: HashMap<IStr, TlaArg>,208	/// Used for `std.native`209	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,210	/// Helper to add globals without implementing custom ContextInitializer211	pub globals: GcHashMap<IStr, Thunk<Val>>,212	/// Used for `std.trace`213	pub trace_printer: Box<dyn TracePrinter>,214	/// Used for `std.thisFile`215	pub path_resolver: PathResolver,216}217218pub fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {219	let source_name = format!("<extvar:{}>", name);220	Source::new_virtual(source_name.into(), code.into())221}222223#[derive(Trace)]224pub struct ContextInitializer {225	// When we don't need to support legacy-this-file, we can reuse same context for all files226	#[cfg(not(feature = "legacy-this-file"))]227	context: Context,228	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it229	#[cfg(feature = "legacy-this-file")]230	stdlib_obj: ObjValue,231	settings: Rc<RefCell<Settings>>,232}233impl ContextInitializer {234	pub fn new(s: State, resolver: PathResolver) -> Self {235		let settings = Settings {236			ext_vars: Default::default(),237			ext_natives: Default::default(),238			globals: Default::default(),239			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),240			path_resolver: resolver,241		};242		let settings = Rc::new(RefCell::new(settings));243		Self {244			#[cfg(not(feature = "legacy-this-file"))]245			context: {246				let mut context = ContextBuilder::with_capacity(s, 1);247				context.bind(248					"std".into(),249					Thunk::evaluated(Val::Obj(stdlib_uncached(settings.clone()))),250				);251				context.build()252			},253			#[cfg(feature = "legacy-this-file")]254			stdlib_obj: stdlib_uncached(s, settings.clone()),255			settings,256		}257	}258	pub fn settings(&self) -> Ref<Settings> {259		self.settings.borrow()260	}261	pub fn settings_mut(&self) -> RefMut<Settings> {262		self.settings.borrow_mut()263	}264	pub fn add_ext_var(&self, name: IStr, value: Val) {265		self.settings_mut()266			.ext_vars267			.insert(name, TlaArg::Val(value));268	}269	pub fn add_ext_str(&self, name: IStr, value: IStr) {270		self.settings_mut()271			.ext_vars272			.insert(name, TlaArg::String(value));273	}274	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {275		let code = code.into();276		let source = extvar_source(name, code.clone());277		let parsed = jrsonnet_parser::parse(278			&code,279			&jrsonnet_parser::ParserSettings {280				file_name: source.clone(),281			},282		)283		.map_err(|e| ImportSyntaxError {284			path: source,285			error: Box::new(e),286		})?;287		// self.data_mut().volatile_files.insert(source_name, code);288		self.settings_mut()289			.ext_vars290			.insert(name.into(), TlaArg::Code(parsed));291		Ok(())292	}293	pub fn add_native(&self, name: IStr, cb: Cc<TraceBox<dyn Builtin>>) {294		self.settings_mut().ext_natives.insert(name, cb);295	}296}297impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {298	#[cfg(not(feature = "legacy-this-file"))]299	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {300		let out = self.context.clone();301		let globals = &self.settings().globals;302		if globals.is_empty() {303			return out;304		}305306		let mut out = ContextBuilder::extend(out);307		for (k, v) in globals.iter() {308			out.bind(k.clone(), v.clone());309		}310		out.build()311	}312	#[cfg(feature = "legacy-this-file")]313	fn initialize(&self, s: State, source: Source) -> jrsonnet_evaluator::Context {314		let mut builder = ObjValueBuilder::new();315		builder.with_super(self.stdlib_obj.clone());316		builder317			.member("thisFile".into())318			.hide()319			.value(320				s,321				Val::Str(match source.source_path().path() {322					Some(p) => self.settings().path_resolver.resolve(p).into(),323					None => source.source_path().to_string().into(),324				}),325			)326			.expect("this object builder is empty");327		let stdlib_with_this_file = builder.build();328329		let mut context = ContextBuilder::with_capacity(1);330		context.bind(331			"std".into(),332			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),333		);334		for (k, v) in self.settings().globals.iter() {335			context.bind(k.clone(), v.clone());336		}337		context.build()338	}339	fn as_any(&self) -> &dyn std::any::Any {340		self341	}342}343344pub trait StateExt {345	/// This method was previously implemented in jrsonnet-evaluator itself346	fn with_stdlib(&self);347	fn add_global(&self, name: IStr, value: Thunk<Val>);348}349350impl StateExt for State {351	fn with_stdlib(&self) {352		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());353		self.settings_mut().context_initializer = tb!(initializer)354	}355	fn add_global(&self, name: IStr, value: Thunk<Val>) {356		self.settings()357			.context_initializer358			.as_any()359			.downcast_ref::<ContextInitializer>()360			.expect("not standard context initializer")361			.settings_mut()362			.globals363			.insert(name, value);364	}365}