git.delta.rocks / jrsonnet / refs/commits / 2e5acc0c12c5

difftreelog

source

crates/jrsonnet-stdlib/src/lib.rs10.0 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, ArgLike, CallLocation, FuncVal, TlaArg},10	gc::{GcHashMap, TraceBox},11	tb, throw,12	trace::PathResolver,13	typed::{Any, Either, Either2, Either4, VecVal, M1},14	val::{equals, ArrValue},15	Context, ContextBuilder, IStr, ObjValue, ObjValueBuilder, State, Thunk, Val,16};17use jrsonnet_gcmodule::Cc;18use jrsonnet_macros::builtin;19use jrsonnet_parser::Source;2021mod expr;22mod types;23pub use types::*;24mod arrays;25pub use arrays::*;26mod math;27pub use math::*;28mod operator;29pub use operator::*;30mod sort;31pub use sort::*;32mod hash;33pub use hash::*;34mod encoding;35pub use encoding::*;36mod objects;37pub use objects::*;38mod manifest;39pub use manifest::*;40mod parse;41pub use parse::*;42mod strings;43pub use strings::*;44mod misc;45pub use misc::*;4647pub fn stdlib_uncached(s: State, settings: Rc<RefCell<Settings>>) -> ObjValue {48	let mut builder = ObjValueBuilder::new();4950	let expr = expr::stdlib_expr();51	let eval = jrsonnet_evaluator::evaluate(s.clone(), Context::default(), &expr)52		.expect("stdlib.jsonnet should have no errors")53		.as_obj()54		.expect("stdlib.jsonnet should evaluate to object");5556	builder.with_super(eval);5758	for (name, builtin) in [59		// Types60		("type", builtin_type::INST),61		("isString", builtin_is_string::INST),62		("isNumber", builtin_is_number::INST),63		("isBoolean", builtin_is_boolean::INST),64		("isObject", builtin_is_object::INST),65		("isArray", builtin_is_array::INST),66		("isFunction", builtin_is_function::INST),67		// Arrays68		("makeArray", builtin_make_array::INST),69		("slice", builtin_slice::INST),70		("map", builtin_map::INST),71		("flatMap", builtin_flatmap::INST),72		("filter", builtin_filter::INST),73		("foldl", builtin_foldl::INST),74		("foldr", builtin_foldr::INST),75		("range", builtin_range::INST),76		("join", builtin_join::INST),77		("reverse", builtin_reverse::INST),78		("any", builtin_any::INST),79		("all", builtin_all::INST),80		("member", builtin_member::INST),81		("count", builtin_count::INST),82		// Math83		("modulo", builtin_modulo::INST),84		("floor", builtin_floor::INST),85		("ceil", builtin_ceil::INST),86		("log", builtin_log::INST),87		("pow", builtin_pow::INST),88		("sqrt", builtin_sqrt::INST),89		("sin", builtin_sin::INST),90		("cos", builtin_cos::INST),91		("tan", builtin_tan::INST),92		("asin", builtin_asin::INST),93		("acos", builtin_acos::INST),94		("atan", builtin_atan::INST),95		("exp", builtin_exp::INST),96		("mantissa", builtin_mantissa::INST),97		("exponent", builtin_exponent::INST),98		// Operator99		("mod", builtin_mod::INST),100		("primitiveEquals", builtin_primitive_equals::INST),101		("equals", builtin_equals::INST),102		("format", builtin_format::INST),103		// Sort104		("sort", builtin_sort::INST),105		// Hash106		("md5", builtin_md5::INST),107		// Encoding108		("encodeUTF8", builtin_encode_utf8::INST),109		("decodeUTF8", builtin_decode_utf8::INST),110		("base64", builtin_base64::INST),111		("base64Decode", builtin_base64_decode::INST),112		("base64DecodeBytes", builtin_base64_decode_bytes::INST),113		// Objects114		("objectFieldsEx", builtin_object_fields_ex::INST),115		("objectHasEx", builtin_object_has_ex::INST),116		// Manifest117		("escapeStringJson", builtin_escape_string_json::INST),118		("manifestJsonEx", builtin_manifest_json_ex::INST),119		("manifestYamlDoc", builtin_manifest_yaml_doc::INST),120		// Parsing121		("parseJson", builtin_parse_json::INST),122		("parseYaml", builtin_parse_yaml::INST),123		// Strings124		("codepoint", builtin_codepoint::INST),125		("substr", builtin_substr::INST),126		("char", builtin_char::INST),127		("strReplace", builtin_str_replace::INST),128		("splitLimit", builtin_splitlimit::INST),129		("asciiUpper", builtin_ascii_upper::INST),130		("asciiLower", builtin_ascii_lower::INST),131		("findSubstr", builtin_find_substr::INST),132		// Misc133		("length", builtin_length::INST),134		("startsWith", builtin_starts_with::INST),135		("endsWith", builtin_ends_with::INST),136	]137	.iter()138	.cloned()139	{140		builder141			.member(name.into())142			.hide()143			.value(s.clone(), Val::Func(FuncVal::StaticBuiltin(builtin)))144			.expect("no conflict");145	}146147	builder148		.member("extVar".into())149		.hide()150		.value(151			s.clone(),152			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_ext_var {153				settings: settings.clone()154			})))),155		)156		.expect("no conflict");157	builder158		.member("native".into())159		.hide()160		.value(161			s.clone(),162			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_native {163				settings: settings.clone()164			})))),165		)166		.expect("no conflict");167	builder168		.member("trace".into())169		.hide()170		.value(171			s.clone(),172			Val::Func(FuncVal::Builtin(Cc::new(tb!(builtin_trace { settings })))),173		)174		.expect("no conflict");175176	builder177		.member("id".into())178		.hide()179		.value(s, Val::Func(FuncVal::Id))180		.expect("no conflict");181182	builder.build()183}184185pub trait TracePrinter {186	fn print_trace(&self, s: State, loc: CallLocation, value: IStr);187}188189pub struct StdTracePrinter {190	resolver: PathResolver,191}192impl StdTracePrinter {193	pub fn new(resolver: PathResolver) -> Self {194		Self { resolver }195	}196}197impl TracePrinter for StdTracePrinter {198	fn print_trace(&self, _s: State, loc: CallLocation, value: IStr) {199		eprint!("TRACE:");200		if let Some(loc) = loc.0 {201			let locs = loc.0.map_source_locations(&[loc.1]);202			eprint!(203				" {}:{}",204				match loc.0.source_path().path() {205					Some(p) => self.resolver.resolve(p),206					None => loc.0.source_path().to_string(),207				},208				locs[0].line209			);210		}211		eprintln!(" {}", value);212	}213}214215pub struct Settings {216	/// Used for `std.extVar`217	pub ext_vars: HashMap<IStr, TlaArg>,218	/// Used for `std.native`219	pub ext_natives: HashMap<IStr, Cc<TraceBox<dyn Builtin>>>,220	/// Helper to add globals without implementing custom ContextInitializer221	pub globals: GcHashMap<IStr, Thunk<Val>>,222	/// Used for `std.trace`223	pub trace_printer: Box<dyn TracePrinter>,224	/// Used for `std.thisFile`225	pub path_resolver: PathResolver,226}227228pub fn extvar_source(name: &str, code: impl Into<IStr>) -> Source {229	let source_name = format!("<extvar:{}>", name);230	Source::new_virtual(source_name.into(), code.into())231}232233pub struct ContextInitializer {234	// When we don't need to support legacy-this-file, we can reuse same context for all files235	#[cfg(not(feature = "legacy-this-file"))]236	context: Context,237	// Otherwise, we can only keep first stdlib layer, and then stack thisFile on top of it238	#[cfg(feature = "legacy-this-file")]239	stdlib_obj: ObjValue,240	settings: Rc<RefCell<Settings>>,241}242impl ContextInitializer {243	pub fn new(s: State, resolver: PathResolver) -> Self {244		let settings = Settings {245			ext_vars: Default::default(),246			ext_natives: Default::default(),247			globals: Default::default(),248			trace_printer: Box::new(StdTracePrinter::new(resolver.clone())),249			path_resolver: resolver,250		};251		let settings = Rc::new(RefCell::new(settings));252		Self {253			#[cfg(not(feature = "legacy-this-file"))]254			context: {255				let mut context = ContextBuilder::with_capacity(1);256				context.bind(257					"std".into(),258					Thunk::evaluated(Val::Obj(stdlib_uncached(s, settings.clone()))),259				);260				context.build()261			},262			#[cfg(feature = "legacy-this-file")]263			stdlib_obj: stdlib_uncached(s, settings.clone()),264			settings,265		}266	}267	pub fn settings(&self) -> Ref<Settings> {268		self.settings.borrow()269	}270	pub fn settings_mut(&self) -> RefMut<Settings> {271		self.settings.borrow_mut()272	}273	pub fn add_ext_var(&self, name: IStr, value: Val) {274		self.settings_mut()275			.ext_vars276			.insert(name, TlaArg::Val(value));277	}278	pub fn add_ext_str(&self, name: IStr, value: IStr) {279		self.settings_mut()280			.ext_vars281			.insert(name, TlaArg::String(value));282	}283	pub fn add_ext_code(&self, name: &str, code: impl Into<IStr>) -> Result<()> {284		let code = code.into();285		let source = extvar_source(name, code.clone());286		let parsed = jrsonnet_parser::parse(287			&code,288			&jrsonnet_parser::ParserSettings {289				file_name: source.clone(),290			},291		)292		.map_err(|e| ImportSyntaxError {293			path: source,294			error: Box::new(e),295		})?;296		// self.data_mut().volatile_files.insert(source_name, code);297		self.settings_mut()298			.ext_vars299			.insert(name.into(), TlaArg::Code(parsed));300		Ok(())301	}302	pub fn add_native(&self, name: IStr, cb: Cc<TraceBox<dyn Builtin>>) {303		self.settings_mut().ext_natives.insert(name, cb);304	}305}306impl jrsonnet_evaluator::ContextInitializer for ContextInitializer {307	#[cfg(not(feature = "legacy-this-file"))]308	fn initialize(&self, _s: State, _source: Source) -> jrsonnet_evaluator::Context {309		let out = self.context.clone();310		let globals = &self.settings().globals;311		if globals.is_empty() {312			return out;313		}314315		let mut out = ContextBuilder::extend(out);316		for (k, v) in globals.iter() {317			out.bind(k.clone(), v.clone());318		}319		out.build()320	}321	#[cfg(feature = "legacy-this-file")]322	fn initialize(&self, s: State, source: Source) -> jrsonnet_evaluator::Context {323		let mut builder = ObjValueBuilder::new();324		builder.with_super(self.stdlib_obj.clone());325		builder326			.member("thisFile".into())327			.hide()328			.value(329				s,330				Val::Str(match source.source_path().path() {331					Some(p) => self.settings().path_resolver.resolve(p).into(),332					None => source.source_path().to_string().into(),333				}),334			)335			.expect("this object builder is empty");336		let stdlib_with_this_file = builder.build();337338		let mut context = ContextBuilder::with_capacity(1);339		context.bind(340			"std".into(),341			Thunk::evaluated(Val::Obj(stdlib_with_this_file)),342		);343		for (k, v) in self.settings().globals.iter() {344			context.bind(k.clone(), v.clone());345		}346		context.build()347	}348	fn as_any(&self) -> &dyn std::any::Any {349		self350	}351}352353pub trait StateExt {354	/// This method was previously implemented in jrsonnet-evaluator itself355	fn with_stdlib(&self);356	fn add_global(&self, name: IStr, value: Thunk<Val>);357}358359impl StateExt for State {360	fn with_stdlib(&self) {361		let initializer = ContextInitializer::new(self.clone(), PathResolver::new_cwd_fallback());362		self.settings_mut().context_initializer = Box::new(initializer)363	}364	fn add_global(&self, name: IStr, value: Thunk<Val>) {365		self.settings()366			.context_initializer367			.as_any()368			.downcast_ref::<ContextInitializer>()369			.expect("not standard context initializer")370			.settings_mut()371			.globals372			.insert(name, value);373	}374}