git.delta.rocks / jrsonnet / refs/commits / 3d527a7bcaaf

difftreelog

source

crates/jrsonnet-evaluator/src/builtin/mod.rs15.4 KiBsourcehistory
1use crate::{2	equals,3	error::{Error::*, Result},4	evaluate, parse_args, primitive_equals, push, throw,5	typed::CheckType,6	with_state, ArrValue, Context, FuncVal, LazyVal, Val,7};8use format::{format_arr, format_obj};9use jrsonnet_interner::IStr;10use jrsonnet_parser::{ArgsDesc, BinaryOpType, ExprLocation};11use jrsonnet_types::ty;12use std::{collections::HashMap, path::PathBuf, rc::Rc};1314pub mod stdlib;15pub use stdlib::*;1617use self::manifest::{escape_string_json, manifest_json_ex, ManifestJsonOptions, ManifestType};1819pub mod format;20pub mod manifest;21pub mod sort;2223fn std_format(str: IStr, vals: Val) -> Result<Val> {24	push(25		&Some(ExprLocation(Rc::from(PathBuf::from("std.jsonnet")), 0, 0)),26		|| format!("std.format of {}", str),27		|| {28			Ok(match vals {29				Val::Arr(vals) => Val::Str(format_arr(&str, &vals.evaluated()?)?.into()),30				Val::Obj(obj) => Val::Str(format_obj(&str, &obj)?.into()),31				o => Val::Str(format_arr(&str, &[o])?.into()),32			})33		},34	)35}3637type Builtin = fn(context: Context, loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val>;3839type BuiltinsType = HashMap<Box<str>, Builtin>;4041thread_local! {42	static BUILTINS: BuiltinsType = {43		[44			("length".into(), builtin_length as Builtin),45			("type".into(), builtin_type),46			("makeArray".into(), builtin_make_array),47			("codepoint".into(), builtin_codepoint),48			("objectFieldsEx".into(), builtin_object_fields_ex),49			("objectHasEx".into(), builtin_object_has_ex),50			("slice".into(), builtin_slice),51			("primitiveEquals".into(), builtin_primitive_equals),52			("equals".into(), builtin_equals),53			("modulo".into(), builtin_modulo),54			("mod".into(), builtin_mod),55			("floor".into(), builtin_floor),56			("log".into(), builtin_log),57			("pow".into(), builtin_pow),58			("extVar".into(), builtin_ext_var),59			("native".into(), builtin_native),60			("filter".into(), builtin_filter),61			("foldl".into(), builtin_foldl),62			("foldr".into(), builtin_foldr),63			("sortImpl".into(), builtin_sort_impl),64			("format".into(), builtin_format),65			("range".into(), builtin_range),66			("char".into(), builtin_char),67			("encodeUTF8".into(), builtin_encode_utf8),68			("md5".into(), builtin_md5),69			("base64".into(), builtin_base64),70			("trace".into(), builtin_trace),71			("join".into(), builtin_join),72			("escapeStringJson".into(), builtin_escape_string_json),73			("manifestJsonEx".into(), builtin_manifest_json_ex),74			("reverse".into(), builtin_reverse),75			("id".into(), builtin_id),76			("strReplace".into(), builtin_str_replace),77		].iter().cloned().collect()78	};79}8081fn builtin_length(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {82	parse_args!(context, "length", args, 1, [83		0, x: ty!((string | object | array));84	], {85		Ok(match x {86			Val::Str(n) => Val::Num(n.chars().count() as f64),87			Val::Arr(a) => Val::Num(a.len() as f64),88			Val::Obj(o) => Val::Num(89				o.fields_visibility()90					.into_iter()91					.filter(|(_k, v)| *v)92					.count() as f64,93			),94			_ => unreachable!(),95		})96	})97}9899fn builtin_type(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {100	parse_args!(context, "type", args, 1, [101		0, x: ty!(any);102	], {103		Ok(Val::Str(x.value_type().name().into()))104	})105}106107fn builtin_make_array(108	context: Context,109	_loc: &Option<ExprLocation>,110	args: &ArgsDesc,111) -> Result<Val> {112	parse_args!(context, "makeArray", args, 2, [113		0, sz: ty!(BoundedNumber<(Some(0.0)), (None)>) => Val::Num;114		1, func: ty!(function) => Val::Func;115	], {116		let mut out = Vec::with_capacity(sz as usize);117		for i in 0..sz as usize {118			out.push(LazyVal::new_resolved(func.evaluate_values(119				Context::new(),120				&[Val::Num(i as f64)]121			)?))122		}123		Ok(Val::Arr(out.into()))124	})125}126127fn builtin_codepoint(128	context: Context,129	_loc: &Option<ExprLocation>,130	args: &ArgsDesc,131) -> Result<Val> {132	parse_args!(context, "codepoint", args, 1, [133		0, str: ty!(char) => Val::Str;134	], {135		Ok(Val::Num(str.chars().next().unwrap() as u32 as f64))136	})137}138139fn builtin_object_fields_ex(140	context: Context,141	_loc: &Option<ExprLocation>,142	args: &ArgsDesc,143) -> Result<Val> {144	parse_args!(context, "objectFieldsEx", args, 2, [145		0, obj: ty!(object) => Val::Obj;146		1, inc_hidden: ty!(boolean) => Val::Bool;147	], {148		let mut out = obj.fields_visibility()149			.into_iter()150			.filter(|(_k, v)| *v || inc_hidden)151			.map(|(k, _v)|k)152			.collect::<Vec<_>>();153		out.sort();154		Ok(Val::Arr(out.into_iter().map(Val::Str).collect::<Vec<_>>().into()))155	})156}157158fn builtin_object_has_ex(159	context: Context,160	_loc: &Option<ExprLocation>,161	args: &ArgsDesc,162) -> Result<Val> {163	parse_args!(context, "objectHasEx", args, 3, [164		0, obj: ty!(object) => Val::Obj;165		1, f: ty!(string) => Val::Str;166		2, inc_hidden: ty!(boolean) => Val::Bool;167	], {168		Ok(Val::Bool(169			obj.fields_visibility()170				.into_iter()171				.filter(|(_k, v)| *v || inc_hidden)172				.any(|(k, _v)| *k == *f),173		))174	})175}176177// faster178fn builtin_slice(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {179	parse_args!(context, "slice", args, 4, [180		0, indexable: ty!((string | array));181		1, index: ty!((number | null));182		2, end: ty!((number | null));183		3, step: ty!((number | null));184	], {185		let index = match index {186			Val::Num(v) => v as usize,187			Val::Null => 0,188			_ => unreachable!(),189		};190		let end = match end {191			Val::Num(v) => v as usize,192			Val::Null => match &indexable {193				Val::Str(s) => s.chars().count(),194				Val::Arr(v) => v.len(),195				_ => unreachable!()196			},197			_ => unreachable!()198		};199		let step = match step {200			Val::Num(v) => v as usize,201			Val::Null => 1,202			_ => unreachable!()203		};204		match &indexable {205			Val::Str(s) => {206				Ok(Val::Str((s.chars().skip(index).take(end-index).step_by(step).collect::<String>()).into()))207			}208			Val::Arr(arr) => {209				Ok(Val::Arr((arr.iter().skip(index).take(end-index).step_by(step).collect::<Result<Vec<Val>>>()?).into()))210			}211			_ => unreachable!()212		}213	})214}215216// faster217fn builtin_primitive_equals(218	context: Context,219	_loc: &Option<ExprLocation>,220	args: &ArgsDesc,221) -> Result<Val> {222	parse_args!(context, "primitiveEquals", args, 2, [223		0, a: ty!(any);224		1, b: ty!(any);225	], {226		Ok(Val::Bool(primitive_equals(&a, &b)?))227	})228}229230// faster231fn builtin_equals(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {232	parse_args!(context, "equals", args, 2, [233		0, a: ty!(any);234		1, b: ty!(any);235	], {236		Ok(Val::Bool(equals(&a, &b)?))237	})238}239240fn builtin_modulo(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {241	parse_args!(context, "modulo", args, 2, [242		0, a: ty!(number) => Val::Num;243		1, b: ty!(number) => Val::Num;244	], {245		Ok(Val::Num(a % b))246	})247}248249fn builtin_mod(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {250	parse_args!(context, "mod", args, 2, [251		0, a: ty!((number | string));252		1, b: ty!(any);253	], {254		match (a, b) {255			(Val::Num(a), Val::Num(b)) => Ok(Val::Num(a % b)),256			(Val::Str(str), vals) => std_format(str, vals),257			(a, b) => throw!(BinaryOperatorDoesNotOperateOnValues(BinaryOpType::Mod, a.value_type(), b.value_type()))258		}259	})260}261262fn builtin_floor(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {263	parse_args!(context, "floor", args, 1, [264		0, x: ty!(number) => Val::Num;265	], {266		Ok(Val::Num(x.floor()))267	})268}269270fn builtin_log(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {271	parse_args!(context, "log", args, 1, [272		0, n: ty!(number) => Val::Num;273	], {274		Ok(Val::Num(n.ln()))275	})276}277278fn builtin_pow(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {279	parse_args!(context, "pow", args, 2, [280		0, x: ty!(number) => Val::Num;281		1, n: ty!(number) => Val::Num;282	], {283		Ok(Val::Num(x.powf(n)))284	})285}286287fn builtin_ext_var(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {288	parse_args!(context, "extVar", args, 1, [289		0, x: ty!(string) => Val::Str;290	], {291		Ok(with_state(|s| s.settings().ext_vars.get(&x).cloned()).ok_or(UndefinedExternalVariable(x))?)292	})293}294295fn builtin_native(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {296	parse_args!(context, "native", args, 1, [297		0, x: ty!(string) => Val::Str;298	], {299		Ok(with_state(|s| s.settings().ext_natives.get(&x).cloned()).map(|v| Val::Func(Rc::new(FuncVal::NativeExt(x.clone(), v)))).ok_or(UndefinedExternalFunction(x))?)300	})301}302303fn builtin_filter(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {304	parse_args!(context, "filter", args, 2, [305		0, func: ty!(function) => Val::Func;306		1, arr: ty!(array) => Val::Arr;307	], {308		let mut out = Vec::new();309		for item in arr.iter() {310			let item = item?;311			if func312						.evaluate_values(context.clone(), &[item.clone()])?313						.try_cast_bool("filter predicate")? {314							out.push(item);315						}316		}317		Ok(Val::Arr(out.into()))318	})319}320321fn builtin_foldl(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {322	parse_args!(context, "foldl", args, 3, [323		0, func: ty!(function) => Val::Func;324		1, arr: ty!(array) => Val::Arr;325		2, init: ty!(any);326	], {327		let mut acc = init;328		for i in arr.iter() {329			acc = func.evaluate_values(context.clone(), &[acc, i?])?;330		}331		Ok(acc)332	})333}334335fn builtin_foldr(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {336	parse_args!(context, "foldr", args, 3, [337		0, func: ty!(function) => Val::Func;338		1, arr: ty!(array) => Val::Arr;339		2, init: ty!(any);340	], {341		let mut acc = init;342		for i in arr.iter().rev() {343			acc = func.evaluate_values(context.clone(), &[acc, i?])?;344		}345		Ok(acc)346	})347}348349#[allow(non_snake_case)]350fn builtin_sort_impl(351	context: Context,352	_loc: &Option<ExprLocation>,353	args: &ArgsDesc,354) -> Result<Val> {355	parse_args!(context, "sort", args, 2, [356		0, arr: ty!(array) => Val::Arr;357		1, keyF: ty!(function) => Val::Func;358	], {359		if arr.len() <= 1 {360			return Ok(Val::Arr(arr))361		}362		Ok(Val::Arr(ArrValue::Eager(sort::sort(context, arr.evaluated()?, &keyF)?)))363	})364}365366// faster367fn builtin_format(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {368	parse_args!(context, "format", args, 2, [369		0, str: ty!(string) => Val::Str;370		1, vals: ty!(any)371	], {372		std_format(str, vals)373	})374}375376fn builtin_range(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {377	parse_args!(context, "range", args, 2, [378		0, from: ty!(number) => Val::Num;379		1, to: ty!(number) => Val::Num;380	], {381		let mut out = Vec::with_capacity((1+to as usize-from as usize).max(0));382		for i in from as usize..=to as usize {383			out.push(Val::Num(i as f64));384		}385		Ok(Val::Arr(out.into()))386	})387}388389fn builtin_char(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {390	parse_args!(context, "char", args, 1, [391		0, n: ty!(number) => Val::Num;392	], {393		let mut out = String::new();394		out.push(std::char::from_u32(n as u32).ok_or_else(||395			InvalidUnicodeCodepointGot(n as u32)396		)?);397		Ok(Val::Str(out.into()))398	})399}400401fn builtin_encode_utf8(402	context: Context,403	_loc: &Option<ExprLocation>,404	args: &ArgsDesc,405) -> Result<Val> {406	parse_args!(context, "encodeUTF8", args, 1, [407		0, str: ty!(string) => Val::Str;408	], {409		Ok(Val::Arr((str.bytes().map(|b| Val::Num(b as f64)).collect::<Vec<Val>>()).into()))410	})411}412413fn builtin_md5(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {414	parse_args!(context, "md5", args, 1, [415		0, str: ty!(string) => Val::Str;416	], {417		Ok(Val::Str(format!("{:x}", md5::compute(&str.as_bytes())).into()))418	})419}420421fn builtin_trace(context: Context, loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {422	parse_args!(context, "trace", args, 2, [423		0, str: ty!(string) => Val::Str;424		1, rest: ty!(any);425	], {426		eprint!("TRACE:");427		if let Some(loc) = loc {428			with_state(|s|{429				let locs = s.map_source_locations(&loc.0, &[loc.1]);430				eprint!(" {}:{}", loc.0.file_name().unwrap().to_str().unwrap(), locs[0].line);431			});432		}433		eprintln!(" {}", str);434		Ok(rest)435	})436}437438fn builtin_base64(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {439	parse_args!(context, "base64", args, 1, [440		0, input: ty!((string | (Array<number>)));441	], {442		Ok(Val::Str(match input {443			Val::Str(s) => {444				base64::encode(s.bytes().collect::<Vec<_>>()).into()445			},446			Val::Arr(a) => {447				base64::encode(a.iter().map(|v| {448					Ok(v?.clone().unwrap_num()? as u8)449				}).collect::<Result<Vec<_>>>()?).into()450			},451			_ => unreachable!()452		}))453	})454}455456457fn builtin_join(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {458	parse_args!(context, "join", args, 2, [459		0, sep: ty!((string | array));460		1, arr: ty!(array) => Val::Arr;461	], {462		Ok(match sep {463			Val::Arr(joiner_items) => {464				let mut out = Vec::new();465466				let mut first = true;467				for item in arr.iter() {468					let item = item?.clone();469					if let Val::Arr(items) = item {470						if !first {471							out.reserve(joiner_items.len());472							// TODO: extend473							for item in joiner_items.iter() {474								out.push(item?);475							}476						}477						first = false;478						out.reserve(items.len());479						// TODO: extend480						for item in items.iter() {481							out.push(item?);482						}483					} else {484						throw!(RuntimeError("in std.join all items should be arrays".into()));485					}486				}487488				Val::Arr(out.into())489			},490			Val::Str(sep) => {491				let mut out = String::new();492493				let mut first = true;494				for item in arr.iter() {495					let item = item?.clone();496					if let Val::Str(item) = item {497						if !first {498							out += &sep;499						}500						first = false;501						out += &item;502					} else {503						throw!(RuntimeError("in std.join all items should be strings".into()));504					}505				}506507				Val::Str(out.into())508			},509			_ => unreachable!()510		})511	})512}513514// faster515fn builtin_escape_string_json(516	context: Context,517	_loc: &Option<ExprLocation>,518	args: &ArgsDesc,519) -> Result<Val> {520	parse_args!(context, "escapeStringJson", args, 1, [521		0, str_: ty!(string) => Val::Str;522	], {523		Ok(Val::Str(escape_string_json(&str_).into()))524	})525}526527// faster528fn builtin_manifest_json_ex(529	context: Context,530	_loc: &Option<ExprLocation>,531	args: &ArgsDesc,532) -> Result<Val> {533	parse_args!(context, "manifestJsonEx", args, 2, [534		0, value: ty!(any);535		1, indent: ty!(string) => Val::Str;536	], {537		Ok(Val::Str(manifest_json_ex(&value, &ManifestJsonOptions {538			padding: &indent,539			mtype: ManifestType::Std,540		})?.into()))541	})542}543544// faster545fn builtin_reverse(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {546	parse_args!(context, "reverse", args, 1, [547		0, value: ty!(array) => Val::Arr;548	], {549		Ok(Val::Arr(value.reversed()))550	})551}552553fn builtin_id(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {554	parse_args!(context, "id", args, 1, [555		0, v: ty!(any);556	], {557		Ok(v)558	})559}560561// faster562fn builtin_str_replace(context: Context, _loc: &Option<ExprLocation>, args: &ArgsDesc) -> Result<Val> {563	parse_args!(context, "strReplace", args, 3, [564		0, str: ty!(string) => Val::Str;565		1, from: ty!(string) => Val::Str;566		2, to: ty!(string) => Val::Str;567	], {568		let mut out = String::new();569		let mut last_idx = 0;570		while let Some(idx) = (&str[last_idx..]).find(&from as &str) {571			out.push_str(&str[last_idx..last_idx+idx]);572			out.push_str(&to);573			last_idx += idx + from.len();574		}575		if last_idx == 0 {576			return Ok(Val::Str(str))577		}578		out.push_str(&str[last_idx..]);579		Ok(Val::Str(out.into()))580	})581}582583#[allow(clippy::cognitive_complexity)]584pub fn call_builtin(585	context: Context,586	loc: &Option<ExprLocation>,587	name: &str,588	args: &ArgsDesc,589) -> Result<Val> {590	if let Some(f) = BUILTINS.with(|builtins| builtins.get(name).map(|f| *f)) {591		return Ok(f(context, loc, args)?);592	}593	throw!(IntrinsicNotFound(name.into()))594}