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<FuncVal> {379 Ok(s.settings()380 .ext_natives381 .get(&name)382 .cloned()383 .map(|v| FuncVal::Builtin(v.clone()))384 .ok_or(UndefinedExternalFunction(name))?)385}386387#[jrsonnet_macros::builtin]388fn builtin_filter(s: State, func: FuncVal, arr: ArrValue) -> Result<ArrValue> {389 arr.filter(s.clone(), |val| {390 bool::from_untyped(391 func.evaluate_simple(s.clone(), &[Any(val.clone())].as_slice())?,392 s.clone(),393 )394 })395}396397#[jrsonnet_macros::builtin]398fn builtin_map(s: State, func: FuncVal, arr: ArrValue) -> Result<ArrValue> {399 arr.map(s.clone(), |val| {400 func.evaluate_simple(s.clone(), &[Any(val)].as_slice())401 })402}403404#[jrsonnet_macros::builtin]405fn builtin_flatmap(s: State, func: FuncVal, arr: IndexableVal) -> Result<IndexableVal> {406 match arr {407 IndexableVal::Str(str) => {408 let mut out = String::new();409 for c in str.chars() {410 match func.evaluate_simple(s.clone(), &[c.to_string()].as_slice())? {411 Val::Str(o) => out.push_str(&o),412 _ => throw!(RuntimeError(413 "in std.join all items should be strings".into()414 )),415 };416 }417 Ok(IndexableVal::Str(out.into()))418 }419 IndexableVal::Arr(a) => {420 let mut out = Vec::new();421 for el in a.iter(s.clone()) {422 let el = el?;423 match func.evaluate_simple(s.clone(), &[Any(el)].as_slice())? {424 Val::Arr(o) => {425 for oe in o.iter(s.clone()) {426 out.push(oe?);427 }428 }429 _ => throw!(RuntimeError(430 "in std.join all items should be arrays".into()431 )),432 };433 }434 Ok(IndexableVal::Arr(out.into()))435 }436 }437}438439#[jrsonnet_macros::builtin]440fn builtin_foldl(s: State, func: FuncVal, arr: ArrValue, init: Any) -> Result<Any> {441 let mut acc = init.0;442 for i in arr.iter(s.clone()) {443 acc = func.evaluate_simple(s.clone(), &[Any(acc), Any(i?)].as_slice())?;444 }445 Ok(Any(acc))446}447448#[jrsonnet_macros::builtin]449fn builtin_foldr(s: State, func: FuncVal, arr: ArrValue, init: Any) -> Result<Any> {450 let mut acc = init.0;451 for i in arr.iter(s.clone()).rev() {452 acc = func.evaluate_simple(s.clone(), &[Any(i?), Any(acc)].as_slice())?;453 }454 Ok(Any(acc))455}456457#[jrsonnet_macros::builtin]458#[allow(non_snake_case)]459fn builtin_sort(s: State, arr: ArrValue, keyF: Option<FuncVal>) -> Result<ArrValue> {460 if arr.len() <= 1 {461 return Ok(arr);462 }463 Ok(ArrValue::Eager(sort::sort(464 s.clone(),465 arr.evaluated(s)?,466 keyF.as_ref(),467 )?))468}469470#[jrsonnet_macros::builtin]471fn builtin_format(s: State, str: IStr, vals: Any) -> Result<String> {472 std_format(s, str, vals.0)473}474475#[jrsonnet_macros::builtin]476fn builtin_range(from: i32, to: i32) -> Result<ArrValue> {477 if to < from {478 return Ok(ArrValue::new_eager());479 }480 Ok(ArrValue::new_range(from, to))481}482483#[jrsonnet_macros::builtin]484fn builtin_char(n: u32) -> Result<char> {485 Ok(std::char::from_u32(n as u32).ok_or(InvalidUnicodeCodepointGot(n as u32))?)486}487488#[jrsonnet_macros::builtin]489fn builtin_encode_utf8(str: IStr) -> Result<Bytes> {490 Ok(Bytes(str.bytes().collect::<Vec<u8>>().into()))491}492493#[jrsonnet_macros::builtin]494fn builtin_decode_utf8(arr: Bytes) -> Result<IStr> {495 Ok(std::str::from_utf8(&arr.0)496 .map_err(|_| RuntimeError("bad utf8".into()))?497 .into())498}499500#[jrsonnet_macros::builtin]501fn builtin_md5(str: IStr) -> Result<String> {502 Ok(format!("{:x}", md5::compute(&str.as_bytes())))503}504505#[jrsonnet_macros::builtin]506fn builtin_trace(s: State, loc: CallLocation, str: IStr, rest: Any) -> Result<Any> {507 eprint!("TRACE:");508 if let Some(loc) = loc.0 {509 let locs = s.map_source_locations(&loc.0, &[loc.1]);510 eprint!(511 " {}:{}",512 loc.0.file_name().unwrap().to_str().unwrap(),513 locs[0].line514 );515 }516 eprintln!(" {}", str);517 Ok(rest) as Result<Any>518}519520#[jrsonnet_macros::builtin]521fn builtin_base64(input: Either![Bytes, IStr]) -> Result<String> {522 use Either2::*;523 Ok(match input {524 A(a) => base64::encode(a.0),525 B(l) => base64::encode(l.bytes().collect::<Vec<_>>()),526 })527}528529#[jrsonnet_macros::builtin]530fn builtin_base64_decode_bytes(input: IStr) -> Result<Bytes> {531 Ok(Bytes(532 base64::decode(&input.as_bytes())533 .map_err(|_| RuntimeError("bad base64".into()))?534 .into(),535 ))536}537538#[jrsonnet_macros::builtin]539fn builtin_base64_decode(input: IStr) -> Result<String> {540 let bytes = base64::decode(&input.as_bytes()).map_err(|_| RuntimeError("bad base64".into()))?;541 Ok(String::from_utf8(bytes).map_err(|_| RuntimeError("bad utf8".into()))?)542}543544#[jrsonnet_macros::builtin]545fn builtin_join(s: State, sep: IndexableVal, arr: ArrValue) -> Result<IndexableVal> {546 Ok(match sep {547 IndexableVal::Arr(joiner_items) => {548 let mut out = Vec::new();549550 let mut first = true;551 for item in arr.iter(s.clone()) {552 let item = item?.clone();553 if let Val::Arr(items) = item {554 if !first {555 out.reserve(joiner_items.len());556 557 for item in joiner_items.iter(s.clone()) {558 out.push(item?);559 }560 }561 first = false;562 out.reserve(items.len());563 for item in items.iter(s.clone()) {564 out.push(item?);565 }566 } else {567 throw!(RuntimeError(568 "in std.join all items should be arrays".into()569 ));570 }571 }572573 IndexableVal::Arr(out.into())574 }575 IndexableVal::Str(sep) => {576 let mut out = String::new();577578 let mut first = true;579 for item in arr.iter(s) {580 let item = item?.clone();581 if let Val::Str(item) = item {582 if !first {583 out += &sep;584 }585 first = false;586 out += &item;587 } else {588 throw!(RuntimeError(589 "in std.join all items should be strings".into()590 ));591 }592 }593594 IndexableVal::Str(out.into())595 }596 })597}598599#[jrsonnet_macros::builtin]600fn builtin_escape_string_json(str_: IStr) -> Result<String> {601 Ok(escape_string_json(&str_))602}603604#[jrsonnet_macros::builtin]605fn builtin_manifest_json_ex(606 s: State,607 value: Any,608 indent: IStr,609 newline: Option<IStr>,610 key_val_sep: Option<IStr>,611 #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,612) -> Result<String> {613 let newline = newline.as_deref().unwrap_or("\n");614 let key_val_sep = key_val_sep.as_deref().unwrap_or(": ");615 manifest_json_ex(616 s,617 &value.0,618 &ManifestJsonOptions {619 padding: &indent,620 mtype: ManifestType::Std,621 newline,622 key_val_sep,623 #[cfg(feature = "exp-preserve-order")]624 preserve_order: preserve_order.unwrap_or(false),625 },626 )627}628629#[jrsonnet_macros::builtin]630fn builtin_manifest_yaml_doc(631 s: State,632 value: Any,633 indent_array_in_object: Option<bool>,634 quote_keys: Option<bool>,635 #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,636) -> Result<String> {637 manifest_yaml_ex(638 s,639 &value.0,640 &ManifestYamlOptions {641 padding: " ",642 arr_element_padding: if indent_array_in_object.unwrap_or(false) {643 " "644 } else {645 ""646 },647 quote_keys: quote_keys.unwrap_or(true),648 #[cfg(feature = "exp-preserve-order")]649 preserve_order: preserve_order.unwrap_or(false),650 },651 )652}653654#[jrsonnet_macros::builtin]655fn builtin_reverse(value: ArrValue) -> Result<ArrValue> {656 Ok(value.reversed())657}658659#[jrsonnet_macros::builtin]660const fn builtin_id(v: Any) -> Result<Any> {661 Ok(v)662}663664#[jrsonnet_macros::builtin]665fn builtin_str_replace(str: String, from: IStr, to: IStr) -> Result<String> {666 Ok(str.replace(&from as &str, &to as &str))667}668669#[jrsonnet_macros::builtin]670fn builtin_splitlimit(str: IStr, c: IStr, maxsplits: Either![usize, M1]) -> Result<VecVal> {671 use Either2::*;672 Ok(VecVal(Cc::new(match maxsplits {673 A(n) => str674 .splitn(n + 1, &c as &str)675 .map(|s| Val::Str(s.into()))676 .collect(),677 B(_) => str.split(&c as &str).map(|s| Val::Str(s.into())).collect(),678 })))679}680681#[jrsonnet_macros::builtin]682fn builtin_ascii_upper(str: IStr) -> Result<String> {683 Ok(str.to_ascii_uppercase())684}685686#[jrsonnet_macros::builtin]687fn builtin_ascii_lower(str: IStr) -> Result<String> {688 Ok(str.to_ascii_lowercase())689}690691#[jrsonnet_macros::builtin]692fn builtin_member(s: State, arr: IndexableVal, x: Any) -> Result<bool> {693 match arr {694 IndexableVal::Str(str) => {695 let x: IStr = IStr::from_untyped(x.0, s)?;696 Ok(!x.is_empty() && str.contains(&*x))697 }698 IndexableVal::Arr(a) => {699 for item in a.iter(s.clone()) {700 let item = item?;701 if equals(s.clone(), &item, &x.0)? {702 return Ok(true);703 }704 }705 Ok(false)706 }707 }708}709710#[jrsonnet_macros::builtin]711fn builtin_count(s: State, arr: Vec<Any>, v: Any) -> Result<usize> {712 let mut count = 0;713 for item in &arr {714 if equals(s.clone(), &item.0, &v.0)? {715 count += 1;716 }717 }718 Ok(count)719}720721#[jrsonnet_macros::builtin]722fn builtin_any(s: State, arr: ArrValue) -> Result<bool> {723 for v in arr.iter(s.clone()) {724 let v = bool::from_untyped(v?, s.clone())?;725 if v {726 return Ok(true);727 }728 }729 Ok(false)730}731732#[jrsonnet_macros::builtin]733fn builtin_all(s: State, arr: ArrValue) -> Result<bool> {734 for v in arr.iter(s.clone()) {735 let v = bool::from_untyped(v?, s.clone())?;736 if !v {737 return Ok(false);738 }739 }740 Ok(true)741}