12#![allow(clippy::unnecessary_wraps)]34use std::collections::HashMap;56use format::{format_arr, format_obj};7use gcmodule::Cc;8use jrsonnet_interner::IStr;9use serde::Deserialize;10use serde_yaml::DeserializingQuirks;1112use crate::{13 builtin::manifest::{manifest_yaml_ex, ManifestYamlOptions},14 error::{Error::*, Result},15 function::{CallLocation, StaticBuiltin},16 operator::evaluate_mod_op,17 throw,18 typed::{Any, BoundedUsize, Bytes, Either2, Either4, PositiveF64, Typed, VecVal, M1},19 val::{equals, primitive_equals, ArrValue, FuncVal, IndexableVal, Slice},20 Either, ObjValue, State, Val,21};2223pub mod stdlib;24pub use stdlib::*;2526use self::manifest::{escape_string_json, manifest_json_ex, ManifestJsonOptions, ManifestType};2728pub mod format;29pub mod manifest;30pub mod sort;3132pub fn std_format(s: State, str: IStr, vals: Val) -> Result<String> {33 s.push(34 CallLocation::native(),35 || format!("std.format of {}", str),36 || {37 Ok(match vals {38 Val::Arr(vals) => format_arr(s.clone(), &str, &vals.evaluated(s.clone())?)?,39 Val::Obj(obj) => format_obj(s.clone(), &str, &obj)?,40 o => format_arr(s.clone(), &str, &[o])?,41 })42 },43 )44}4546pub fn std_slice(47 indexable: IndexableVal,48 index: Option<BoundedUsize<0, { i32::MAX as usize }>>,49 end: Option<BoundedUsize<0, { i32::MAX as usize }>>,50 step: Option<BoundedUsize<1, { i32::MAX as usize }>>,51) -> Result<Val> {52 match &indexable {53 IndexableVal::Str(s) => {54 let index = index.as_deref().copied().unwrap_or(0);55 let end = end.as_deref().copied().unwrap_or(usize::MAX);56 let step = step.as_deref().copied().unwrap_or(1);5758 if index >= end {59 return Ok(Val::Str("".into()));60 }6162 Ok(Val::Str(63 (s.chars()64 .skip(index)65 .take(end - index)66 .step_by(step)67 .collect::<String>())68 .into(),69 ))70 }71 IndexableVal::Arr(arr) => {72 let index = index.as_deref().copied().unwrap_or(0);73 let end = end.as_deref().copied().unwrap_or(usize::MAX).min(arr.len());74 let step = step.as_deref().copied().unwrap_or(1);7576 if index >= end {77 return Ok(Val::Arr(ArrValue::new_eager()));78 }7980 Ok(Val::Arr(ArrValue::Slice(Box::new(Slice {81 inner: arr.clone(),82 from: index as u32,83 to: end as u32,84 step: step as u32,85 }))))86 }87 }88}8990type BuiltinsType = HashMap<IStr, &'static dyn StaticBuiltin>;9192thread_local! {93 pub static BUILTINS: BuiltinsType = {94 [95 ("length".into(), builtin_length::INST),96 ("type".into(), builtin_type::INST),97 ("makeArray".into(), builtin_make_array::INST),98 ("codepoint".into(), builtin_codepoint::INST),99 ("objectFieldsEx".into(), builtin_object_fields_ex::INST),100 ("objectHasEx".into(), builtin_object_has_ex::INST),101 ("slice".into(), builtin_slice::INST),102 ("substr".into(), builtin_substr::INST),103 ("primitiveEquals".into(), builtin_primitive_equals::INST),104 ("equals".into(), builtin_equals::INST),105 ("modulo".into(), builtin_modulo::INST),106 ("mod".into(), builtin_mod::INST),107 ("floor".into(), builtin_floor::INST),108 ("ceil".into(), builtin_ceil::INST),109 ("log".into(), builtin_log::INST),110 ("pow".into(), builtin_pow::INST),111 ("sqrt".into(), builtin_sqrt::INST),112 ("sin".into(), builtin_sin::INST),113 ("cos".into(), builtin_cos::INST),114 ("tan".into(), builtin_tan::INST),115 ("asin".into(), builtin_asin::INST),116 ("acos".into(), builtin_acos::INST),117 ("atan".into(), builtin_atan::INST),118 ("exp".into(), builtin_exp::INST),119 ("mantissa".into(), builtin_mantissa::INST),120 ("exponent".into(), builtin_exponent::INST),121 ("extVar".into(), builtin_ext_var::INST),122 ("native".into(), builtin_native::INST),123 ("filter".into(), builtin_filter::INST),124 ("map".into(), builtin_map::INST),125 ("flatMap".into(), builtin_flatmap::INST),126 ("foldl".into(), builtin_foldl::INST),127 ("foldr".into(), builtin_foldr::INST),128 ("sort".into(), builtin_sort::INST),129 ("format".into(), builtin_format::INST),130 ("range".into(), builtin_range::INST),131 ("char".into(), builtin_char::INST),132 ("encodeUTF8".into(), builtin_encode_utf8::INST),133 ("decodeUTF8".into(), builtin_decode_utf8::INST),134 ("md5".into(), builtin_md5::INST),135 ("base64".into(), builtin_base64::INST),136 ("base64DecodeBytes".into(), builtin_base64_decode_bytes::INST),137 ("base64Decode".into(), builtin_base64_decode::INST),138 ("trace".into(), builtin_trace::INST),139 ("join".into(), builtin_join::INST),140 ("escapeStringJson".into(), builtin_escape_string_json::INST),141 ("manifestJsonEx".into(), builtin_manifest_json_ex::INST),142 ("manifestYamlDoc".into(), builtin_manifest_yaml_doc::INST),143 ("reverse".into(), builtin_reverse::INST),144 ("id".into(), builtin_id::INST),145 ("strReplace".into(), builtin_str_replace::INST),146 ("splitLimit".into(), builtin_splitlimit::INST),147 ("parseJson".into(), builtin_parse_json::INST),148 ("parseYaml".into(), builtin_parse_yaml::INST),149 ("asciiUpper".into(), builtin_ascii_upper::INST),150 ("asciiLower".into(), builtin_ascii_lower::INST),151 ("member".into(), builtin_member::INST),152 ("count".into(), builtin_count::INST),153 ("any".into(), builtin_any::INST),154 ("all".into(), builtin_all::INST),155 ].iter().cloned().collect()156 };157}158159#[jrsonnet_macros::builtin]160fn builtin_length(x: Either![IStr, ArrValue, ObjValue, FuncVal]) -> Result<usize> {161 use Either4::*;162 Ok(match x {163 A(x) => x.chars().count(),164 B(x) => x.len(),165 C(x) => x.len(),166 D(f) => f.args_len(),167 })168}169170#[jrsonnet_macros::builtin]171fn builtin_type(x: Any) -> Result<IStr> {172 Ok(x.0.value_type().name().into())173}174175#[jrsonnet_macros::builtin]176fn builtin_make_array(s: State, sz: usize, func: FuncVal) -> Result<VecVal> {177 let mut out = Vec::with_capacity(sz);178 for i in 0..sz {179 out.push(func.evaluate_simple(s.clone(), &[i as f64].as_slice())?);180 }181 Ok(VecVal(Cc::new(out)))182}183184#[jrsonnet_macros::builtin]185const fn builtin_codepoint(str: char) -> Result<u32> {186 Ok(str as u32)187}188189#[jrsonnet_macros::builtin]190fn builtin_object_fields_ex(191 obj: ObjValue,192 inc_hidden: bool,193 #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,194) -> Result<VecVal> {195 #[cfg(feature = "exp-preserve-order")]196 let preserve_order = preserve_order.unwrap_or(false);197 let out = obj.fields_ex(198 inc_hidden,199 #[cfg(feature = "exp-preserve-order")]200 preserve_order,201 );202 Ok(VecVal(Cc::new(203 out.into_iter().map(Val::Str).collect::<Vec<_>>(),204 )))205}206207#[jrsonnet_macros::builtin]208fn builtin_object_has_ex(obj: ObjValue, f: IStr, inc_hidden: bool) -> Result<bool> {209 Ok(obj.has_field_ex(f, inc_hidden))210}211212#[jrsonnet_macros::builtin]213fn builtin_parse_json(st: State, s: IStr) -> Result<Any> {214 use serde_json::Value;215 let value: Value = serde_json::from_str(&s)216 .map_err(|e| RuntimeError(format!("failed to parse json: {}", e).into()))?;217 Ok(Any(Value::into_untyped(value, st)?))218}219220#[jrsonnet_macros::builtin]221fn builtin_parse_yaml(st: State, s: IStr) -> Result<Any> {222 use serde_json::Value;223 let value = serde_yaml::Deserializer::from_str_with_quirks(224 &s,225 DeserializingQuirks { old_octals: true },226 );227 let mut out = vec![];228 for item in value {229 let value = Value::deserialize(item)230 .map_err(|e| RuntimeError(format!("failed to parse yaml: {}", e).into()))?;231 let val = Value::into_untyped(value, st.clone())?;232 out.push(val);233 }234 Ok(Any(if out.is_empty() {235 Val::Null236 } else if out.len() == 1 {237 out.into_iter().next().unwrap()238 } else {239 Val::Arr(out.into())240 }))241}242243#[jrsonnet_macros::builtin]244fn builtin_slice(245 indexable: IndexableVal,246 index: Option<BoundedUsize<0, { i32::MAX as usize }>>,247 end: Option<BoundedUsize<0, { i32::MAX as usize }>>,248 step: Option<BoundedUsize<1, { i32::MAX as usize }>>,249) -> Result<Any> {250 std_slice(indexable, index, end, step).map(Any)251}252253#[jrsonnet_macros::builtin]254fn builtin_substr(str: IStr, from: usize, len: usize) -> Result<String> {255 Ok(str.chars().skip(from as usize).take(len as usize).collect())256}257258#[jrsonnet_macros::builtin]259fn builtin_primitive_equals(a: Any, b: Any) -> Result<bool> {260 primitive_equals(&a.0, &b.0)261}262263#[jrsonnet_macros::builtin]264fn builtin_equals(s: State, a: Any, b: Any) -> Result<bool> {265 equals(s, &a.0, &b.0)266}267268#[jrsonnet_macros::builtin]269fn builtin_modulo(a: f64, b: f64) -> Result<f64> {270 Ok(a % b)271}272273#[jrsonnet_macros::builtin]274fn builtin_mod(s: State, a: Either![f64, IStr], b: Any) -> Result<Any> {275 use Either2::*;276 Ok(Any(evaluate_mod_op(277 s,278 &match a {279 A(v) => Val::Num(v),280 B(s) => Val::Str(s),281 },282 &b.0,283 )?))284}285286#[jrsonnet_macros::builtin]287fn builtin_floor(x: f64) -> Result<f64> {288 Ok(x.floor())289}290291#[jrsonnet_macros::builtin]292fn builtin_ceil(x: f64) -> Result<f64> {293 Ok(x.ceil())294}295296#[jrsonnet_macros::builtin]297fn builtin_log(n: f64) -> Result<f64> {298 Ok(n.ln())299}300301#[jrsonnet_macros::builtin]302fn builtin_pow(x: f64, n: f64) -> Result<f64> {303 Ok(x.powf(n))304}305306#[jrsonnet_macros::builtin]307fn builtin_sqrt(x: PositiveF64) -> Result<f64> {308 Ok(x.0.sqrt())309}310311#[jrsonnet_macros::builtin]312fn builtin_sin(x: f64) -> Result<f64> {313 Ok(x.sin())314}315316#[jrsonnet_macros::builtin]317fn builtin_cos(x: f64) -> Result<f64> {318 Ok(x.cos())319}320321#[jrsonnet_macros::builtin]322fn builtin_tan(x: f64) -> Result<f64> {323 Ok(x.tan())324}325326#[jrsonnet_macros::builtin]327fn builtin_asin(x: f64) -> Result<f64> {328 Ok(x.asin())329}330331#[jrsonnet_macros::builtin]332fn builtin_acos(x: f64) -> Result<f64> {333 Ok(x.acos())334}335336#[jrsonnet_macros::builtin]337fn builtin_atan(x: f64) -> Result<f64> {338 Ok(x.atan())339}340341#[jrsonnet_macros::builtin]342fn builtin_exp(x: f64) -> Result<f64> {343 Ok(x.exp())344}345346fn frexp(s: f64) -> (f64, i16) {347 if 0.0 == s {348 (s, 0)349 } else {350 let lg = s.abs().log2();351 let x = (lg - lg.floor() - 1.0).exp2();352 let exp = lg.floor() + 1.0;353 (s.signum() * x, exp as i16)354 }355}356357#[jrsonnet_macros::builtin]358fn builtin_mantissa(x: f64) -> Result<f64> {359 Ok(frexp(x).0)360}361362#[jrsonnet_macros::builtin]363fn builtin_exponent(x: f64) -> Result<i16> {364 Ok(frexp(x).1)365}366367#[jrsonnet_macros::builtin]368fn builtin_ext_var(s: State, x: IStr) -> Result<Any> {369 Ok(Any(s370 .settings()371 .ext_vars372 .get(&x)373 .cloned()374 .ok_or(UndefinedExternalVariable(x))?))375}376377#[jrsonnet_macros::builtin]378fn builtin_native(s: State, name: IStr) -> Result<Any> {379 Ok(Any(s380 .settings()381 .ext_natives382 .get(&name)383 .cloned()384 .map_or(Val::Null, |v| {385 Val::Func(FuncVal::Builtin(v.clone()))386 })))387}388389#[jrsonnet_macros::builtin]390fn builtin_filter(s: State, func: FuncVal, arr: ArrValue) -> Result<ArrValue> {391 arr.filter(s.clone(), |val| {392 bool::from_untyped(393 func.evaluate_simple(s.clone(), &[Any(val.clone())].as_slice())?,394 s.clone(),395 )396 })397}398399#[jrsonnet_macros::builtin]400fn builtin_map(s: State, func: FuncVal, arr: ArrValue) -> Result<ArrValue> {401 arr.map(s.clone(), |val| {402 func.evaluate_simple(s.clone(), &[Any(val)].as_slice())403 })404}405406#[jrsonnet_macros::builtin]407fn builtin_flatmap(s: State, func: FuncVal, arr: IndexableVal) -> Result<IndexableVal> {408 match arr {409 IndexableVal::Str(str) => {410 let mut out = String::new();411 for c in str.chars() {412 match func.evaluate_simple(s.clone(), &[c.to_string()].as_slice())? {413 Val::Str(o) => out.push_str(&o),414 Val::Null => continue,415 _ => throw!(RuntimeError(416 "in std.join all items should be strings".into()417 )),418 };419 }420 Ok(IndexableVal::Str(out.into()))421 }422 IndexableVal::Arr(a) => {423 let mut out = Vec::new();424 for el in a.iter(s.clone()) {425 let el = el?;426 match func.evaluate_simple(s.clone(), &[Any(el)].as_slice())? {427 Val::Arr(o) => {428 for oe in o.iter(s.clone()) {429 out.push(oe?);430 }431 }432 Val::Null => continue,433 _ => throw!(RuntimeError(434 "in std.join all items should be arrays".into()435 )),436 };437 }438 Ok(IndexableVal::Arr(out.into()))439 }440 }441}442443#[jrsonnet_macros::builtin]444fn builtin_foldl(s: State, func: FuncVal, arr: ArrValue, init: Any) -> Result<Any> {445 let mut acc = init.0;446 for i in arr.iter(s.clone()) {447 acc = func.evaluate_simple(s.clone(), &[Any(acc), Any(i?)].as_slice())?;448 }449 Ok(Any(acc))450}451452#[jrsonnet_macros::builtin]453fn builtin_foldr(s: State, func: FuncVal, arr: ArrValue, init: Any) -> Result<Any> {454 let mut acc = init.0;455 for i in arr.iter(s.clone()).rev() {456 acc = func.evaluate_simple(s.clone(), &[Any(i?), Any(acc)].as_slice())?;457 }458 Ok(Any(acc))459}460461#[jrsonnet_macros::builtin]462#[allow(non_snake_case)]463fn builtin_sort(s: State, arr: ArrValue, keyF: Option<FuncVal>) -> Result<ArrValue> {464 if arr.len() <= 1 {465 return Ok(arr);466 }467 Ok(ArrValue::Eager(sort::sort(468 s.clone(),469 arr.evaluated(s)?,470 keyF.as_ref(),471 )?))472}473474#[jrsonnet_macros::builtin]475fn builtin_format(s: State, str: IStr, vals: Any) -> Result<String> {476 std_format(s, str, vals.0)477}478479#[jrsonnet_macros::builtin]480fn builtin_range(from: i32, to: i32) -> Result<ArrValue> {481 if to < from {482 return Ok(ArrValue::new_eager());483 }484 Ok(ArrValue::new_range(from, to))485}486487#[jrsonnet_macros::builtin]488fn builtin_char(n: u32) -> Result<char> {489 Ok(std::char::from_u32(n as u32).ok_or(InvalidUnicodeCodepointGot(n as u32))?)490}491492#[jrsonnet_macros::builtin]493fn builtin_encode_utf8(str: IStr) -> Result<Bytes> {494 Ok(Bytes(str.bytes().collect::<Vec<u8>>().into()))495}496497#[jrsonnet_macros::builtin]498fn builtin_decode_utf8(arr: Bytes) -> Result<IStr> {499 Ok(std::str::from_utf8(&arr.0)500 .map_err(|_| RuntimeError("bad utf8".into()))?501 .into())502}503504#[jrsonnet_macros::builtin]505fn builtin_md5(str: IStr) -> Result<String> {506 Ok(format!("{:x}", md5::compute(&str.as_bytes())))507}508509#[jrsonnet_macros::builtin]510fn builtin_trace(s: State, loc: CallLocation, str: IStr, rest: Any) -> Result<Any> {511 eprint!("TRACE:");512 if let Some(loc) = loc.0 {513 let locs = s.map_source_locations(&loc.0, &[loc.1]);514 eprint!(515 " {}:{}",516 loc.0.file_name().unwrap().to_str().unwrap(),517 locs[0].line518 );519 }520 eprintln!(" {}", str);521 Ok(rest) as Result<Any>522}523524#[jrsonnet_macros::builtin]525fn builtin_base64(input: Either![Bytes, IStr]) -> Result<String> {526 use Either2::*;527 Ok(match input {528 A(a) => base64::encode(a.0),529 B(l) => base64::encode(l.bytes().collect::<Vec<_>>()),530 })531}532533#[jrsonnet_macros::builtin]534fn builtin_base64_decode_bytes(input: IStr) -> Result<Bytes> {535 Ok(Bytes(536 base64::decode(&input.as_bytes())537 .map_err(|_| RuntimeError("bad base64".into()))?538 .into(),539 ))540}541542#[jrsonnet_macros::builtin]543fn builtin_base64_decode(input: IStr) -> Result<String> {544 let bytes = base64::decode(&input.as_bytes()).map_err(|_| RuntimeError("bad base64".into()))?;545 Ok(String::from_utf8(bytes).map_err(|_| RuntimeError("bad utf8".into()))?)546}547548#[jrsonnet_macros::builtin]549fn builtin_join(s: State, sep: IndexableVal, arr: ArrValue) -> Result<IndexableVal> {550 Ok(match sep {551 IndexableVal::Arr(joiner_items) => {552 let mut out = Vec::new();553554 let mut first = true;555 for item in arr.iter(s.clone()) {556 let item = item?.clone();557 if let Val::Arr(items) = item {558 if !first {559 out.reserve(joiner_items.len());560 561 for item in joiner_items.iter(s.clone()) {562 out.push(item?);563 }564 }565 first = false;566 out.reserve(items.len());567 for item in items.iter(s.clone()) {568 out.push(item?);569 }570 } else if matches!(item, Val::Null) {571 continue;572 } else {573 throw!(RuntimeError(574 "in std.join all items should be arrays".into()575 ));576 }577 }578579 IndexableVal::Arr(out.into())580 }581 IndexableVal::Str(sep) => {582 let mut out = String::new();583584 let mut first = true;585 for item in arr.iter(s) {586 let item = item?.clone();587 if let Val::Str(item) = item {588 if !first {589 out += &sep;590 }591 first = false;592 out += &item;593 } else if matches!(item, Val::Null) {594 continue;595 } else {596 throw!(RuntimeError(597 "in std.join all items should be strings".into()598 ));599 }600 }601602 IndexableVal::Str(out.into())603 }604 })605}606607#[jrsonnet_macros::builtin]608fn builtin_escape_string_json(str_: IStr) -> Result<String> {609 Ok(escape_string_json(&str_))610}611612#[jrsonnet_macros::builtin]613fn builtin_manifest_json_ex(614 s: State,615 value: Any,616 indent: IStr,617 newline: Option<IStr>,618 key_val_sep: Option<IStr>,619 #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,620) -> Result<String> {621 let newline = newline.as_deref().unwrap_or("\n");622 let key_val_sep = key_val_sep.as_deref().unwrap_or(": ");623 manifest_json_ex(624 s,625 &value.0,626 &ManifestJsonOptions {627 padding: &indent,628 mtype: ManifestType::Std,629 newline,630 key_val_sep,631 #[cfg(feature = "exp-preserve-order")]632 preserve_order: preserve_order.unwrap_or(false),633 },634 )635}636637#[jrsonnet_macros::builtin]638fn builtin_manifest_yaml_doc(639 s: State,640 value: Any,641 indent_array_in_object: Option<bool>,642 quote_keys: Option<bool>,643 #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,644) -> Result<String> {645 manifest_yaml_ex(646 s,647 &value.0,648 &ManifestYamlOptions {649 padding: " ",650 arr_element_padding: if indent_array_in_object.unwrap_or(false) {651 " "652 } else {653 ""654 },655 quote_keys: quote_keys.unwrap_or(true),656 #[cfg(feature = "exp-preserve-order")]657 preserve_order: preserve_order.unwrap_or(false),658 },659 )660}661662#[jrsonnet_macros::builtin]663fn builtin_reverse(value: ArrValue) -> Result<ArrValue> {664 Ok(value.reversed())665}666667#[jrsonnet_macros::builtin]668const fn builtin_id(v: Any) -> Result<Any> {669 Ok(v)670}671672#[jrsonnet_macros::builtin]673fn builtin_str_replace(str: String, from: IStr, to: IStr) -> Result<String> {674 Ok(str.replace(&from as &str, &to as &str))675}676677#[jrsonnet_macros::builtin]678fn builtin_splitlimit(str: IStr, c: IStr, maxsplits: Either![usize, M1]) -> Result<VecVal> {679 use Either2::*;680 Ok(VecVal(Cc::new(match maxsplits {681 A(n) => str682 .splitn(n + 1, &c as &str)683 .map(|s| Val::Str(s.into()))684 .collect(),685 B(_) => str.split(&c as &str).map(|s| Val::Str(s.into())).collect(),686 })))687}688689#[jrsonnet_macros::builtin]690fn builtin_ascii_upper(str: IStr) -> Result<String> {691 Ok(str.to_ascii_uppercase())692}693694#[jrsonnet_macros::builtin]695fn builtin_ascii_lower(str: IStr) -> Result<String> {696 Ok(str.to_ascii_lowercase())697}698699#[jrsonnet_macros::builtin]700fn builtin_member(s: State, arr: IndexableVal, x: Any) -> Result<bool> {701 match arr {702 IndexableVal::Str(str) => {703 let x: IStr = IStr::from_untyped(x.0, s)?;704 Ok(!x.is_empty() && str.contains(&*x))705 }706 IndexableVal::Arr(a) => {707 for item in a.iter(s.clone()) {708 let item = item?;709 if equals(s.clone(), &item, &x.0)? {710 return Ok(true);711 }712 }713 Ok(false)714 }715 }716}717718#[jrsonnet_macros::builtin]719fn builtin_count(s: State, arr: Vec<Any>, v: Any) -> Result<usize> {720 let mut count = 0;721 for item in &arr {722 if equals(s.clone(), &item.0, &v.0)? {723 count += 1;724 }725 }726 Ok(count)727}728729#[jrsonnet_macros::builtin]730fn builtin_any(s: State, arr: ArrValue) -> Result<bool> {731 for v in arr.iter(s.clone()) {732 let v = bool::from_untyped(v?, s.clone())?;733 if v {734 return Ok(true);735 }736 }737 Ok(false)738}739740#[jrsonnet_macros::builtin]741fn builtin_all(s: State, arr: ArrValue) -> Result<bool> {742 for v in arr.iter(s.clone()) {743 let v = bool::from_untyped(v?, s.clone())?;744 if !v {745 return Ok(false);746 }747 }748 Ok(true)749}