difftreelog
feat experimental object field order preservation
in: master
15 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -492,6 +492,7 @@
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d0ffa0837f2dfa6fb90868c2b5468cad482e175f7dad97e7421951e663f2b527"
dependencies = [
+ "indexmap",
"itoa",
"ryu",
"serde",
bindings/jsonnet/Cargo.tomldiffbeforeafterboth--- a/bindings/jsonnet/Cargo.toml
+++ b/bindings/jsonnet/Cargo.toml
@@ -17,3 +17,4 @@
[features]
interop = []
+exp-preserve-order = ["jrsonnet-evaluator/exp-preserve-order"]
bindings/jsonnet/src/lib.rsdiffbeforeafterboth--- a/bindings/jsonnet/src/lib.rs
+++ b/bindings/jsonnet/src/lib.rs
@@ -58,7 +58,11 @@
pub extern "C" fn jsonnet_string_output(vm: &EvaluationState, v: c_int) {
match v {
1 => vm.set_manifest_format(ManifestFormat::String),
- 0 => vm.set_manifest_format(ManifestFormat::Json(4)),
+ 0 => vm.set_manifest_format(ManifestFormat::Json {
+ padding: 4,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: false,
+ }),
_ => panic!("incorrect output format"),
}
}
bindings/jsonnet/src/val_modify.rsdiffbeforeafterboth--- a/bindings/jsonnet/src/val_modify.rs
+++ b/bindings/jsonnet/src/val_modify.rs
@@ -5,8 +5,7 @@
use std::{ffi::CStr, os::raw::c_char};
use gcmodule::Cc;
-use jrsonnet_evaluator::{val::ArrValue, EvaluationState, LazyBinding, LazyVal, ObjMember, Val};
-use jrsonnet_parser::Visibility;
+use jrsonnet_evaluator::{val::ArrValue, EvaluationState, LazyVal, Val};
/// # Safety
///
@@ -41,19 +40,9 @@
val: &Val,
) {
match obj {
- Val::Obj(old) => {
- let new_obj = old.clone().extend_with_field(
- CStr::from_ptr(name).to_str().unwrap().into(),
- ObjMember {
- add: false,
- visibility: Visibility::Normal,
- invoke: LazyBinding::Bound(LazyVal::new_resolved(val.clone())),
- location: None,
- },
- );
-
- *obj = Val::Obj(new_obj);
- }
+ Val::Obj(old) => old
+ .extend_field(CStr::from_ptr(name).to_str().unwrap().into())
+ .value(val.clone()),
_ => panic!("should receive object"),
}
}
cmds/jrsonnet/Cargo.tomldiffbeforeafterboth--- a/cmds/jrsonnet/Cargo.toml
+++ b/cmds/jrsonnet/Cargo.toml
@@ -9,6 +9,12 @@
[features]
# Use mimalloc as allocator
mimalloc = ["mimallocator"]
+# Experimental feature, which allows to preserve order of object fields
+exp-preserve-order = [
+ "jrsonnet-evaluator/exp-preserve-order",
+ "jrsonnet-evaluator/exp-serde-preserve-order",
+ "jrsonnet-cli/exp-preserve-order",
+]
[dependencies]
jrsonnet-evaluator = { path = "../../crates/jrsonnet-evaluator", version = "0.4.2" }
crates/jrsonnet-cli/Cargo.tomldiffbeforeafterboth--- a/crates/jrsonnet-cli/Cargo.toml
+++ b/crates/jrsonnet-cli/Cargo.toml
@@ -6,6 +6,9 @@
license = "MIT"
edition = "2021"
+[features]
+exp-preserve-order = ["jrsonnet-evaluator/exp-preserve-order"]
+
[dependencies]
jrsonnet-evaluator = { path = "../../crates/jrsonnet-evaluator", version = "0.4.2", features = [
"explaining-traces",
crates/jrsonnet-cli/src/manifest.rsdiffbeforeafterboth--- a/crates/jrsonnet-cli/src/manifest.rs
+++ b/crates/jrsonnet-cli/src/manifest.rs
@@ -43,20 +43,30 @@
/// `0` for hard tabs, `-1` for single line output [default: 3 for json, 2 for yaml]
#[clap(long)]
line_padding: Option<usize>,
+ /// Preserve order in object manifestification
+ #[cfg(feature = "exp-preserve-order")]
+ #[clap(long)]
+ exp_preserve_order: bool,
}
impl ConfigureState for ManifestOpts {
fn configure(&self, state: &EvaluationState) -> Result<()> {
if self.string {
state.set_manifest_format(ManifestFormat::String);
} else {
+ #[cfg(feature = "exp-preserve-order")]
+ let preserve_order = self.exp_preserve_order;
match self.format {
ManifestFormatName::String => state.set_manifest_format(ManifestFormat::String),
- ManifestFormatName::Json => {
- state.set_manifest_format(ManifestFormat::Json(self.line_padding.unwrap_or(3)))
- }
- ManifestFormatName::Yaml => {
- state.set_manifest_format(ManifestFormat::Yaml(self.line_padding.unwrap_or(2)))
- }
+ ManifestFormatName::Json => state.set_manifest_format(ManifestFormat::Json {
+ padding: self.line_padding.unwrap_or(3),
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ }),
+ ManifestFormatName::Yaml => state.set_manifest_format(ManifestFormat::Yaml {
+ padding: self.line_padding.unwrap_or(2),
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ }),
}
}
if self.yaml_stream {
crates/jrsonnet-evaluator/Cargo.tomldiffbeforeafterboth--- a/crates/jrsonnet-evaluator/Cargo.toml
+++ b/crates/jrsonnet-evaluator/Cargo.toml
@@ -15,6 +15,10 @@
# Allows library authors to throw custom errors
anyhow-error = ["anyhow"]
+# Allows to preserve field order in objects
+exp-preserve-order = []
+exp-serde-preserve-order = ["serde_json/preserve_order"]
+
[dependencies]
jrsonnet-interner = { path = "../jrsonnet-interner", version = "0.4.2" }
jrsonnet-parser = { path = "../jrsonnet-parser", version = "0.4.2" }
crates/jrsonnet-evaluator/src/builtin/manifest.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/builtin/manifest.rs
+++ b/crates/jrsonnet-evaluator/src/builtin/manifest.rs
@@ -21,6 +21,8 @@
pub mtype: ManifestType,
pub newline: &'s str,
pub key_val_sep: &'s str,
+ #[cfg(feature = "exp-preserve-order")]
+ pub preserve_order: bool,
}
pub fn manifest_json_ex(val: &Val, options: &ManifestJsonOptions<'_>) -> Result<String> {
@@ -85,7 +87,10 @@
Val::Obj(obj) => {
obj.run_assertions()?;
buf.push('{');
- let fields = obj.fields();
+ let fields = obj.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ options.preserve_order,
+ );
if !fields.is_empty() {
if mtype != ManifestType::ToString && mtype != ManifestType::Minify {
buf.push_str(options.newline);
@@ -182,6 +187,10 @@
/// safe_key: 1
/// ```
pub quote_keys: bool,
+ /// If true - then order of fields is preserved as written,
+ /// instead of sorting alphabetically
+ #[cfg(feature = "exp-preserve-order")]
+ pub preserve_order: bool,
}
/// From https://github.com/chyh1990/yaml-rust/blob/da52a68615f2ecdd6b7e4567019f280c433c1521/src/emitter.rs#L289
@@ -287,7 +296,14 @@
if o.is_empty() {
buf.push_str("{}");
} else {
- for (i, key) in o.fields().iter().enumerate() {
+ for (i, key) in o
+ .fields(
+ #[cfg(feature = "exp-preserve-order")]
+ options.preserve_order,
+ )
+ .iter()
+ .enumerate()
+ {
if i != 0 {
buf.push('\n');
buf.push_str(cur_padding);
crates/jrsonnet-evaluator/src/builtin/mod.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/builtin/mod.rs
+++ b/crates/jrsonnet-evaluator/src/builtin/mod.rs
@@ -162,11 +162,7 @@
Ok(match x {
A(x) => x.chars().count(),
B(x) => x.len(),
- C(x) => x
- .fields_visibility()
- .into_iter()
- .filter(|(_k, v)| *v)
- .count(),
+ C(x) => x.len(),
D(f) => f.args_len(),
})
}
@@ -191,8 +187,20 @@
}
#[jrsonnet_macros::builtin]
-fn builtin_object_fields_ex(obj: ObjValue, inc_hidden: bool) -> Result<VecVal> {
- let out = obj.fields_ex(inc_hidden);
+fn builtin_object_fields_ex(
+ obj: ObjValue,
+ inc_hidden: bool,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,
+) -> Result<VecVal> {
+ #[cfg(not(feature = "exp-preserve-order"))]
+ let preserve_order = false;
+ #[cfg(feature = "exp-preserve-order")]
+ let preserve_order = preserve_order.unwrap_or(false);
+ let out = obj.fields_ex(
+ inc_hidden,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ );
Ok(VecVal(Cc::new(
out.into_iter().map(Val::Str).collect::<Vec<_>>(),
)))
@@ -586,6 +594,7 @@
indent: IStr,
newline: Option<IStr>,
key_val_sep: Option<IStr>,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,
) -> Result<String> {
let newline = newline.as_deref().unwrap_or("\n");
let key_val_sep = key_val_sep.as_deref().unwrap_or(": ");
@@ -596,6 +605,8 @@
mtype: ManifestType::Std,
newline,
key_val_sep,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: preserve_order.unwrap_or(false),
},
)
}
@@ -605,6 +616,7 @@
value: Any,
indent_array_in_object: Option<bool>,
quote_keys: Option<bool>,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: Option<bool>,
) -> Result<String> {
manifest_yaml_ex(
&value.0,
@@ -616,6 +628,8 @@
""
},
quote_keys: quote_keys.unwrap_or(true),
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: preserve_order.unwrap_or(false),
},
)
}
crates/jrsonnet-evaluator/src/integrations/serde.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/integrations/serde.rs
+++ b/crates/jrsonnet-evaluator/src/integrations/serde.rs
@@ -28,7 +28,10 @@
}
Val::Obj(o) => {
let mut out = Map::new();
- for key in o.fields() {
+ for key in o.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ cfg!(feature = "exp-serde-preserve-order"),
+ ) {
out.insert(
(&key as &str).into(),
o.get(key)?
crates/jrsonnet-evaluator/src/lib.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/lib.rs
+++ b/crates/jrsonnet-evaluator/src/lib.rs
@@ -100,7 +100,11 @@
ext_natives: Default::default(),
tla_vars: Default::default(),
import_resolver: Box::new(DummyImportResolver),
- manifest_format: ManifestFormat::Json(4),
+ manifest_format: ManifestFormat::Json {
+ padding: 4,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: false,
+ },
trace_format: Box::new(CompactFormat {
padding: 4,
resolver: trace::PathResolver::Absolute,
crates/jrsonnet-evaluator/src/obj.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/obj.rs
+++ b/crates/jrsonnet-evaluator/src/obj.rs
@@ -18,10 +18,82 @@
push_frame, throw, weak_ptr_eq, weak_raw, Bindable, LazyBinding, LazyVal, Result, Val,
};
+#[cfg(not(feature = "exp-preserve-order"))]
+pub(crate) mod ordering {
+ use gcmodule::Trace;
+
+ #[derive(Clone, Copy, Default, Debug, Trace)]
+ pub struct FieldIndex;
+ impl FieldIndex {
+ pub fn next(self) -> Self {
+ Self
+ }
+ }
+
+ #[derive(Clone, Copy, Default, Debug, Trace)]
+ pub struct SuperDepth;
+ impl SuperDepth {
+ pub fn deeper(self) -> Self {
+ Self
+ }
+ }
+
+ #[derive(Clone, Copy)]
+ pub struct FieldSortKey;
+ impl FieldSortKey {
+ pub fn new(_: SuperDepth, _: FieldIndex) -> Self {
+ Self
+ }
+ }
+}
+
+#[cfg(feature = "exp-preserve-order")]
+mod ordering {
+ use std::cmp::Reverse;
+
+ use gcmodule::Trace;
+
+ #[derive(Clone, Copy, Default, Debug, Trace, PartialEq, Eq, PartialOrd, Ord)]
+ pub struct FieldIndex(u32);
+ impl FieldIndex {
+ pub fn next(self) -> Self {
+ Self(self.0 + 1)
+ }
+ }
+
+ #[derive(Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Debug)]
+ pub struct SuperDepth(u32);
+ impl SuperDepth {
+ pub fn deeper(self) -> Self {
+ Self(self.0 + 1)
+ }
+ }
+
+ #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
+ pub struct FieldSortKey(Reverse<SuperDepth>, FieldIndex);
+ impl FieldSortKey {
+ pub fn new(depth: SuperDepth, index: FieldIndex) -> Self {
+ Self(Reverse(depth), index)
+ }
+ pub fn collide(self, other: Self) -> Self {
+ if self.0 .0 > other.0 .0 {
+ self
+ } else if self.0 .0 < other.0 .0 {
+ other
+ } else {
+ unreachable!("object can't have two fields with same name")
+ }
+ }
+ }
+}
+
+pub(crate) use ordering::*;
+
#[derive(Debug, Trace)]
pub struct ObjMember {
pub add: bool,
pub visibility: Visibility,
+ original_index: FieldIndex,
pub invoke: LazyBinding,
pub location: Option<ExprLocation>,
}
@@ -120,6 +192,14 @@
),
}
}
+ pub(crate) fn extend_with_raw_member(self, key: IStr, value: ObjMember) -> Self {
+ let mut new = GcHashMap::with_capacity(1);
+ new.insert(key, value);
+ Self::new(Some(self), Cc::new(new), Cc::new(Vec::new()))
+ }
+ pub fn extend_field(&mut self, name: IStr) -> ObjMemberBuilder<ExtendBuilder> {
+ ObjMemberBuilder::new(ExtendBuilder(self), name, FieldIndex::default())
+ }
pub fn with_this(&self, this_obj: Self) -> Self {
Self(Cc::new(ObjValueInternals {
super_obj: self.0.super_obj.clone(),
@@ -131,6 +211,13 @@
}))
}
+ pub fn len(&self) -> usize {
+ self.fields_visibility()
+ .into_iter()
+ .filter(|(_, (visible, _))| *visible)
+ .count()
+ }
+
pub fn is_empty(&self) -> bool {
if !self.0.this_entries.is_empty() {
return false;
@@ -143,51 +230,93 @@
}
/// Run callback for every field found in object
- pub(crate) fn enum_fields(&self, handler: &mut impl FnMut(&IStr, &ObjMember) -> bool) -> bool {
+ pub(crate) fn enum_fields(
+ &self,
+ depth: SuperDepth,
+ handler: &mut impl FnMut(SuperDepth, &IStr, &ObjMember) -> bool,
+ ) -> bool {
if let Some(s) = &self.0.super_obj {
- if s.enum_fields(handler) {
+ if s.enum_fields(depth.deeper(), handler) {
return true;
}
}
for (name, member) in self.0.this_entries.iter() {
- if handler(name, member) {
+ if handler(depth, name, member) {
return true;
}
}
false
}
- pub fn fields_visibility(&self) -> FxHashMap<IStr, bool> {
+ pub fn fields_visibility(&self) -> FxHashMap<IStr, (bool, FieldSortKey)> {
let mut out = FxHashMap::default();
- self.enum_fields(&mut |name, member| {
+ self.enum_fields(SuperDepth::default(), &mut |depth, name, member| {
+ let new_sort_key = FieldSortKey::new(depth, member.original_index);
match member.visibility {
Visibility::Normal => {
let entry = out.entry(name.to_owned());
- entry.or_insert(true);
+ let v = entry.or_insert((true, new_sort_key));
+ v.1 = new_sort_key;
}
Visibility::Hidden => {
- out.insert(name.to_owned(), false);
+ out.insert(name.to_owned(), (false, new_sort_key));
}
Visibility::Unhide => {
- out.insert(name.to_owned(), true);
+ out.insert(name.to_owned(), (true, new_sort_key));
}
};
false
});
out
}
- pub fn fields_ex(&self, include_hidden: bool) -> Vec<IStr> {
+ pub fn fields_ex(
+ &self,
+ include_hidden: bool,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Vec<IStr> {
+ #[cfg(feature = "exp-preserve-order")]
+ if preserve_order {
+ let (mut fields, mut keys): (Vec<_>, Vec<_>) = self
+ .fields_visibility()
+ .into_iter()
+ .filter(|(_, (visible, _))| include_hidden || *visible)
+ .enumerate()
+ .map(|(idx, (k, (_, sk)))| (k, (sk, idx)))
+ .unzip();
+ keys.sort_unstable_by_key(|v| v.0);
+ // Reorder in-place by resulting indexes
+ for i in 0..fields.len() {
+ let x = fields[i].clone();
+ let mut j = i;
+ loop {
+ let k = keys[j].1;
+ keys[j].1 = j;
+ if k == i {
+ break;
+ }
+ fields[j] = fields[k].clone();
+ j = k
+ }
+ fields[j] = x;
+ }
+ return fields;
+ }
+
let mut fields: Vec<_> = self
.fields_visibility()
.into_iter()
- .filter(|(_k, v)| include_hidden || *v)
+ .filter(|(_, (visible, _))| include_hidden || *visible)
.map(|(k, _)| k)
.collect();
fields.sort_unstable();
fields
}
- pub fn fields(&self) -> Vec<IStr> {
- self.fields_ex(false)
+ pub fn fields(&self, #[cfg(feature = "exp-preserve-order")] preserve_order: bool) -> Vec<IStr> {
+ self.fields_ex(
+ false,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ )
}
pub fn field_visibility(&self, name: IStr) -> Option<Visibility> {
@@ -236,11 +365,7 @@
self.get_raw(key, self.0.this_obj.as_ref())
}
- pub fn extend_with_field(self, key: IStr, value: ObjMember) -> Self {
- let mut new = GcHashMap::with_capacity(1);
- new.insert(key, value);
- Self::new(Some(self), Cc::new(new), Cc::new(Vec::new()))
- }
+ // pub fn extend_with(self, key: )
fn get_raw(&self, key: IStr, real_this: Option<&Self>) -> Result<Option<Val>> {
let real_this = real_this.unwrap_or(self);
@@ -339,6 +464,7 @@
super_obj: Option<ObjValue>,
map: GcHashMap<IStr, ObjMember>,
assertions: Vec<TraceBox<dyn ObjectAssertion>>,
+ next_field_index: FieldIndex,
}
impl ObjValueBuilder {
pub fn new() -> Self {
@@ -349,6 +475,7 @@
super_obj: None,
map: GcHashMap::with_capacity(capacity),
assertions: Vec::new(),
+ next_field_index: FieldIndex::default(),
}
}
pub fn reserve_asserts(&mut self, capacity: usize) -> &mut Self {
@@ -364,14 +491,10 @@
self.assertions.push(assertion);
self
}
- pub fn member(&mut self, name: IStr) -> ObjMemberBuilder {
- ObjMemberBuilder {
- value: self,
- name,
- add: false,
- visibility: Visibility::Normal,
- location: None,
- }
+ pub fn member(&mut self, name: IStr) -> ObjMemberBuilder<ValueBuilder> {
+ let field_index = self.next_field_index;
+ self.next_field_index = self.next_field_index.next();
+ ObjMemberBuilder::new(ValueBuilder(self), name, field_index)
}
pub fn build(self) -> ObjValue {
@@ -385,16 +508,28 @@
}
#[must_use = "value not added unless binding() was called"]
-pub struct ObjMemberBuilder<'v> {
- value: &'v mut ObjValueBuilder,
+pub struct ObjMemberBuilder<Kind> {
+ kind: Kind,
name: IStr,
add: bool,
visibility: Visibility,
+ original_index: FieldIndex,
location: Option<ExprLocation>,
}
#[allow(clippy::missing_const_for_fn)]
-impl<'v> ObjMemberBuilder<'v> {
+impl<Kind> ObjMemberBuilder<Kind> {
+ pub(crate) fn new(kind: Kind, name: IStr, original_index: FieldIndex) -> Self {
+ Self {
+ kind,
+ name,
+ original_index,
+ add: false,
+ visibility: Visibility::Normal,
+ location: None,
+ }
+ }
+
pub const fn with_add(mut self, add: bool) -> Self {
self.add = add;
self
@@ -413,6 +548,23 @@
self.location = Some(location);
self
}
+ fn build_member(self, binding: LazyBinding) -> (Kind, IStr, ObjMember) {
+ (
+ self.kind,
+ self.name,
+ ObjMember {
+ add: self.add,
+ visibility: self.visibility,
+ original_index: self.original_index,
+ invoke: binding,
+ location: self.location,
+ },
+ )
+ }
+}
+
+pub struct ValueBuilder<'v>(&'v mut ObjValueBuilder);
+impl<'v> ObjMemberBuilder<ValueBuilder<'v>> {
pub fn value(self, value: Val) -> Result<()> {
self.binding(LazyBinding::Bound(LazyVal::new_resolved(value)))
}
@@ -420,22 +572,31 @@
self.binding(LazyBinding::Bindable(Cc::new(bindable)))
}
pub fn binding(self, binding: LazyBinding) -> Result<()> {
- let old = self.value.map.insert(
- self.name.clone(),
- ObjMember {
- add: self.add,
- visibility: self.visibility,
- invoke: binding,
- location: self.location.clone(),
- },
- );
+ let (receiver, name, member) = self.build_member(binding);
+ let location = member.location.clone();
+ let old = receiver.0.map.insert(name.clone(), member);
if old.is_some() {
push_frame(
- CallLocation(self.location.as_ref()),
- || format!("field <{}> initializtion", self.name.clone()),
- || throw!(DuplicateFieldName(self.name.clone())),
+ CallLocation(location.as_ref()),
+ || format!("field <{}> initializtion", name.clone()),
+ || throw!(DuplicateFieldName(name.clone())),
)?
}
Ok(())
}
}
+
+pub struct ExtendBuilder<'v>(&'v mut ObjValue);
+impl<'v> ObjMemberBuilder<ExtendBuilder<'v>> {
+ pub fn value(self, value: Val) {
+ self.binding(LazyBinding::Bound(LazyVal::new_resolved(value)))
+ }
+ pub fn bindable(self, bindable: TraceBox<dyn Bindable>) {
+ self.binding(LazyBinding::Bindable(Cc::new(bindable)))
+ }
+ pub fn binding(self, binding: LazyBinding) -> () {
+ let (receiver, name, member) = self.build_member(binding);
+ let new = receiver.0.clone();
+ *receiver.0 = new.extend_with_raw_member(name, member)
+ }
+}
crates/jrsonnet-evaluator/src/val.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/val.rs
+++ b/crates/jrsonnet-evaluator/src/val.rs
@@ -167,11 +167,31 @@
#[derive(Clone)]
pub enum ManifestFormat {
YamlStream(Box<ManifestFormat>),
- Yaml(usize),
- Json(usize),
+ Yaml {
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: bool,
+ },
+ Json {
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: bool,
+ },
ToString,
String,
}
+impl ManifestFormat {
+ #[cfg(feature = "exp-preserve-order")]
+ fn preserve_order(&self) -> bool {
+ match self {
+ ManifestFormat::YamlStream(s) => s.preserve_order(),
+ ManifestFormat::Yaml { preserve_order, .. } => *preserve_order,
+ ManifestFormat::Json { preserve_order, .. } => *preserve_order,
+ ManifestFormat::ToString => false,
+ ManifestFormat::String => false,
+ }
+ }
+}
#[derive(Debug, Clone, Trace)]
pub struct Slice {
@@ -559,6 +579,8 @@
mtype: ManifestType::ToString,
newline: "\n",
key_val_sep: ": ",
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order: false,
},
)?
.into(),
@@ -571,7 +593,10 @@
Self::Obj(obj) => obj,
_ => throw!(MultiManifestOutputIsNotAObject),
};
- let keys = obj.fields();
+ let keys = obj.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ ty.preserve_order(),
+ );
let mut out = Vec::with_capacity(keys.len());
for key in keys {
let value = obj
@@ -622,8 +647,24 @@
out.into()
}
- ManifestFormat::Yaml(padding) => self.to_yaml(*padding)?,
- ManifestFormat::Json(padding) => self.to_json(*padding)?,
+ ManifestFormat::Yaml {
+ padding,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ } => self.to_yaml(
+ *padding,
+ #[cfg(feature = "exp-preserve-order")]
+ *preserve_order,
+ )?,
+ ManifestFormat::Json {
+ padding,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
+ } => self.to_json(
+ *padding,
+ #[cfg(feature = "exp-preserve-order")]
+ *preserve_order,
+ )?,
ManifestFormat::ToString => self.to_string()?,
ManifestFormat::String => match self {
Self::Str(s) => s.clone(),
@@ -633,7 +674,11 @@
}
/// For manifestification
- pub fn to_json(&self, padding: usize) -> Result<IStr> {
+ pub fn to_json(
+ &self,
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Result<IStr> {
manifest_json_ex(
self,
&ManifestJsonOptions {
@@ -645,13 +690,19 @@
},
newline: "\n",
key_val_sep: ": ",
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
},
)
.map(|s| s.into())
}
/// Calls `std.manifestJson`
- pub fn to_std_json(&self, padding: usize) -> Result<Rc<str>> {
+ pub fn to_std_json(
+ &self,
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Result<Rc<str>> {
manifest_json_ex(
self,
&ManifestJsonOptions {
@@ -659,12 +710,18 @@
mtype: ManifestType::Std,
newline: "\n",
key_val_sep: ": ",
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
},
)
.map(|s| s.into())
}
- pub fn to_yaml(&self, padding: usize) -> Result<IStr> {
+ pub fn to_yaml(
+ &self,
+ padding: usize,
+ #[cfg(feature = "exp-preserve-order")] preserve_order: bool,
+ ) -> Result<IStr> {
let padding = &" ".repeat(padding);
manifest_yaml_ex(
self,
@@ -672,6 +729,8 @@
padding,
arr_element_padding: padding,
quote_keys: false,
+ #[cfg(feature = "exp-preserve-order")]
+ preserve_order,
},
)
.map(|s| s.into())
@@ -733,8 +792,15 @@
if ObjValue::ptr_eq(a, b) {
return Ok(true);
}
- let fields = a.fields();
- if fields != b.fields() {
+ let fields = a.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ false,
+ );
+ if fields
+ != b.fields(
+ #[cfg(feature = "exp-preserve-order")]
+ false,
+ ) {
return Ok(false);
}
for field in fields {
crates/jrsonnet-macros/src/lib.rsdiffbeforeafterboth1use proc_macro2::TokenStream;2use quote::quote;3use syn::{4 parenthesized,5 parse::{Parse, ParseStream},6 parse_macro_input,7 punctuated::Punctuated,8 spanned::Spanned,9 token::Comma,10 Attribute, DeriveInput, Error, FnArg, GenericArgument, Ident, ItemFn, LitStr, Pat, Path,11 PathArguments, Result, ReturnType, Token, Type,12};1314fn parse_attr<A: Parse, I>(attrs: &[Attribute], ident: I) -> Result<Option<A>>15where16 Ident: PartialEq<I>,17{18 let attrs = attrs19 .iter()20 .filter(|a| a.path.is_ident(&ident))21 .collect::<Vec<_>>();22 if attrs.len() > 1 {23 return Err(Error::new(24 attrs[1].span(),25 "this attribute may be specified only once",26 ));27 } else if attrs.is_empty() {28 return Ok(None);29 }30 let attr = attrs[0];31 let attr = attr.parse_args::<A>()?;3233 Ok(Some(attr))34}3536fn path_is(path: &Path, needed: &str) -> bool {37 path.leading_colon.is_none()38 && !path.segments.is_empty()39 && path.segments.iter().last().unwrap().ident == needed40}4142fn type_is_path<'ty>(ty: &'ty Type, needed: &str) -> Option<&'ty PathArguments> {43 match ty {44 Type::Path(path) if path.qself.is_none() && path_is(&path.path, needed) => {45 let args = &path.path.segments.iter().last().unwrap().arguments;46 Some(args)47 }48 _ => None,49 }50}5152fn extract_type_from_option(ty: &Type) -> Result<Option<&Type>> {53 Ok(if let Some(args) = type_is_path(ty, "Option") {54 // It should have only on angle-bracketed param ("<String>"):55 let generic_arg = match args {56 PathArguments::AngleBracketed(params) => params.args.iter().next().unwrap(),57 _ => return Err(Error::new(args.span(), "missing option generic")),58 };59 // This argument must be a type:60 match generic_arg {61 GenericArgument::Type(ty) => Some(ty),62 _ => {63 return Err(Error::new(64 generic_arg.span(),65 "option generic should be a type",66 ))67 }68 }69 } else {70 None71 })72}7374struct Field {75 name: Ident,76 _colon: Token![:],77 ty: Type,78}79impl Parse for Field {80 fn parse(input: ParseStream) -> syn::Result<Self> {81 Ok(Self {82 name: input.parse()?,83 _colon: input.parse()?,84 ty: input.parse()?,85 })86 }87}8889mod kw {90 syn::custom_keyword!(fields);91 syn::custom_keyword!(rename);92 syn::custom_keyword!(flatten);93}9495struct EmptyAttr;96impl Parse for EmptyAttr {97 fn parse(_input: ParseStream) -> Result<Self> {98 Ok(Self)99 }100}101102struct BuiltinAttrs {103 fields: Vec<Field>,104}105impl Parse for BuiltinAttrs {106 fn parse(input: ParseStream) -> syn::Result<Self> {107 if input.is_empty() {108 return Ok(Self { fields: Vec::new() });109 }110 input.parse::<kw::fields>()?;111 let fields;112 parenthesized!(fields in input);113 let p = Punctuated::<Field, Comma>::parse_terminated(&fields)?;114 Ok(Self {115 fields: p.into_iter().collect(),116 })117 }118}119120enum ArgInfo {121 Normal {122 ty: Box<Type>,123 is_option: bool,124 name: String,125 // ident: Ident,126 },127 Lazy {128 is_option: bool,129 name: String,130 },131 Location,132 This,133}134135impl ArgInfo {136 fn parse(arg: &FnArg) -> Result<Self> {137 let typed = match arg {138 FnArg::Receiver(_) => unreachable!(),139 FnArg::Typed(a) => a,140 };141 let ident = match &typed.pat as &Pat {142 Pat::Ident(i) => i.ident.clone(),143 _ => {144 return Err(Error::new(145 typed.pat.span(),146 "arg should be plain identifier",147 ))148 }149 };150 let ty = &typed.ty;151 if type_is_path(ty, "CallLocation").is_some() {152 return Ok(Self::Location);153 } else if type_is_path(ty, "Self").is_some() {154 return Ok(Self::This);155 } else if type_is_path(ty, "LazyVal").is_some() {156 return Ok(Self::Lazy {157 is_option: false,158 name: ident.to_string(),159 });160 }161162 let (is_option, ty) = if let Some(ty) = extract_type_from_option(ty)? {163 if type_is_path(ty, "LazyVal").is_some() {164 return Ok(Self::Lazy {165 is_option: true,166 name: ident.to_string(),167 });168 }169170 (true, Box::new(ty.clone()))171 } else {172 (false, ty.clone())173 };174175 Ok(Self::Normal {176 ty,177 is_option,178 name: ident.to_string(),179 // ident,180 })181 }182}183184#[proc_macro_attribute]185pub fn builtin(186 attr: proc_macro::TokenStream,187 item: proc_macro::TokenStream,188) -> proc_macro::TokenStream {189 let attr = parse_macro_input!(attr as BuiltinAttrs);190 let item: ItemFn = parse_macro_input!(item);191192 match builtin_inner(attr, item) {193 Ok(v) => v.into(),194 Err(e) => e.into_compile_error().into(),195 }196}197198fn builtin_inner(attr: BuiltinAttrs, fun: ItemFn) -> syn::Result<TokenStream> {199 let result = match fun.sig.output {200 ReturnType::Default => {201 return Err(Error::new(202 fun.sig.span(),203 "builtin should return something",204 ))205 }206 ReturnType::Type(_, ref ty) => ty.clone(),207 };208209 let args = fun210 .sig211 .inputs212 .iter()213 .map(ArgInfo::parse)214 .collect::<Result<Vec<_>>>()?;215216 let params_desc = args.iter().flat_map(|a| match a {217 ArgInfo::Normal {218 is_option, name, ..219 }220 | ArgInfo::Lazy { is_option, name } => Some(quote! {221 BuiltinParam {222 name: std::borrow::Cow::Borrowed(#name),223 has_default: #is_option,224 }225 }),226 ArgInfo::Location => None,227 ArgInfo::This => None,228 });229230 let pass = args.iter().map(|a| match a {231 ArgInfo::Normal {232 ty,233 is_option,234 name,235 // ident,236 } => {237 let eval = quote! {::jrsonnet_evaluator::push_description_frame(238 || format!("argument <{}> evaluation", #name),239 || <#ty>::try_from(value.evaluate()?),240 )?};241 if *is_option {242 quote! {if let Some(value) = parsed.get(#name) {243 Some(#eval)244 } else {245 None246 }}247 } else {248 quote! {{249 let value = parsed.get(#name).expect("args shape is checked");250 #eval251 }}252 }253 }254 ArgInfo::Lazy { is_option, name } => {255 if *is_option {256 quote! {if let Some(value) = parsed.get(#name) {257 Some(value.clone())258 } else {259 None260 }}261 } else {262 quote! {263 parsed.get(#name).expect("args shape is correct").clone()264 }265 }266 }267 ArgInfo::Location => quote! {location},268 ArgInfo::This => quote! {self},269 });270271 let fields = attr.fields.iter().map(|field| {272 let name = &field.name;273 let ty = &field.ty;274 quote! {275 pub #name: #ty,276 }277 });278279 let name = &fun.sig.ident;280 let vis = &fun.vis;281 let static_ext = if attr.fields.is_empty() {282 quote! {283 impl #name {284 pub const INST: &'static dyn StaticBuiltin = &#name {};285 }286 impl StaticBuiltin for #name {}287 }288 } else {289 quote! {}290 };291 let static_derive_copy = if attr.fields.is_empty() {292 quote! {, Copy}293 } else {294 quote! {}295 };296297 Ok(quote! {298 #fun299 #[doc(hidden)]300 #[allow(non_camel_case_types)]301 #[derive(Clone, gcmodule::Trace #static_derive_copy)]302 #vis struct #name {303 #(#fields)*304 }305 const _: () = {306 use ::jrsonnet_evaluator::{307 function::{Builtin, CallLocation, StaticBuiltin, BuiltinParam, ArgsLike, parse_builtin_call},308 error::Result, Context,309 parser::ExprLocation,310 };311 const PARAMS: &'static [BuiltinParam] = &[312 #(#params_desc),*313 ];314315 #static_ext316 impl Builtin for #name317 where318 Self: 'static319 {320 fn name(&self) -> &str {321 stringify!(#name)322 }323 fn params(&self) -> &[BuiltinParam] {324 PARAMS325 }326 fn call(&self, context: Context, location: CallLocation, args: &dyn ArgsLike) -> Result<Val> {327 let parsed = parse_builtin_call(context, &PARAMS, args, false)?;328329 let result: #result = #name(#(#pass),*);330 let result = result?;331 result.try_into()332 }333 }334 };335 })336}337338#[derive(Default)]339struct TypedAttr {340 rename: Option<String>,341 flatten: bool,342}343impl Parse for TypedAttr {344 fn parse(input: ParseStream) -> syn::Result<Self> {345 let mut out = Self::default();346 loop {347 let lookahead = input.lookahead1();348 if lookahead.peek(kw::rename) {349 input.parse::<kw::rename>()?;350 input.parse::<Token![=]>()?;351 let name = input.parse::<LitStr>()?;352 if out.rename.is_some() {353 return Err(Error::new(354 name.span(),355 "rename attribute may only be specified once",356 ));357 }358 out.rename = Some(name.value());359 } else if lookahead.peek(kw::flatten) {360 input.parse::<kw::flatten>()?;361 out.flatten = true;362 } else if input.is_empty() {363 break;364 } else {365 return Err(lookahead.error());366 }367 if input.peek(Token![,]) {368 input.parse::<Token![,]>()?;369 } else {370 break;371 }372 }373 // input.parse::<kw::rename>()?;374 // input.parse::<Token![=]>()?;375 // let rename = input.parse::<LitStr>()?.value();376 Ok(out)377 }378}379380struct TypedField<'f>(&'f syn::Field, TypedAttr);381impl<'f> TypedField<'f> {382 fn try_new(field: &'f syn::Field) -> Result<Self> {383 let attr = parse_attr::<TypedAttr, _>(&field.attrs, "typed")?.unwrap_or_default();384 if field.ident.is_none() {385 return Err(Error::new(386 field.span(),387 "this field should appear in output object, but it has no visible name",388 ));389 }390 Ok(Self(field, attr))391 }392 fn ident(&self) -> Ident {393 self.0394 .ident395 .clone()396 .expect("constructor disallows fields without name")397 }398 /// None if this field is flattened in jsonnet output399 fn name(&self) -> Option<String> {400 if self.1.flatten {401 return None;402 }403 Some(404 self.1405 .rename406 .clone()407 .unwrap_or_else(|| self.ident().to_string()),408 )409 }410411 fn expand_field(&self) -> Option<TokenStream> {412 if self.is_option() {413 return None;414 }415 let name = self.name()?;416 let ty = &self.0.ty;417 Some(quote! {418 (#name, <#ty>::TYPE)419 })420 }421 fn expand_parse(&self) -> TokenStream {422 let ident = self.ident();423 let ty = &self.0.ty;424 if self.1.flatten {425 // optional flatten is handled in same way as serde426 return if self.is_option() {427 quote! {428 #ident: <#ty>::parse(&obj).ok(),429 }430 } else {431 quote! {432 #ident: <#ty>::parse(&obj)?,433 }434 };435 };436437 let name = self.name().unwrap();438 let value = if let Some(ty) = self.as_option() {439 quote! {440 if let Some(value) = obj.get(#name.into())? {441 Some(<#ty>::try_from(vakue)?)442 } else {443 None444 }445 }446 } else {447 quote! {448 <#ty>::try_from(obj.get(#name.into())?.ok_or_else(|| Error::NoSuchField(#name.into()))?)?449 }450 };451452 quote! {453 #ident: #value,454 }455 }456 fn expand_serialize(&self) -> TokenStream {457 let ident = self.ident();458 if let Some(name) = self.name() {459 if self.is_option() {460 quote! {461 if let Some(value) = self.#ident {462 out.member(#name.into()).value(value.try_into()?)?;463 }464 }465 } else {466 quote! {467 out.member(#name.into()).value(self.#ident.try_into()?)?;468 }469 }470 } else if self.is_option() {471 quote! {472 if let Some(value) = self.#ident {473 value.serialize(out)?;474 }475 }476 } else {477 quote! {478 self.#ident.serialize(out)?;479 }480 }481 }482483 fn as_option(&self) -> Option<&Type> {484 extract_type_from_option(&self.0.ty).unwrap()485 }486 fn is_option(&self) -> bool {487 self.as_option().is_some()488 }489}490491#[proc_macro_derive(Typed, attributes(typed))]492pub fn derive_typed(item: proc_macro::TokenStream) -> proc_macro::TokenStream {493 let input = parse_macro_input!(item as DeriveInput);494495 match derive_typed_inner(input) {496 Ok(v) => v.into(),497 Err(e) => e.to_compile_error().into(),498 }499}500501fn derive_typed_inner(input: DeriveInput) -> Result<TokenStream> {502 let data = match &input.data {503 syn::Data::Struct(s) => s,504 _ => return Err(Error::new(input.span(), "only structs supported")),505 };506507 let ident = &input.ident;508 let fields = data509 .fields510 .iter()511 .map(TypedField::try_new)512 .collect::<Result<Vec<_>>>()?;513514 let typed = {515 let fields = fields516 .iter()517 .flat_map(TypedField::expand_field)518 .collect::<Vec<_>>();519 let len = fields.len();520 quote! {521 const ITEMS: [(&'static str, &'static ComplexValType); #len] = [522 #(#fields,)*523 ];524 impl Typed for #ident {525 const TYPE: &'static ComplexValType = &ComplexValType::ObjectRef(&ITEMS);526 }527 }528 };529530 let fields_parse = fields.iter().map(TypedField::expand_parse);531 let fields_serialize = fields.iter().map(TypedField::expand_serialize);532533 Ok(quote! {534 const _: () = {535 use ::jrsonnet_evaluator::{536 typed::{ComplexValType, Typed, TypedObj, CheckType},537 Val,538 error::{LocError, Error},539 ObjValueBuilder, ObjValue,540 };541542 #typed543544 impl #ident {545 fn serialize(self, out: &mut ObjValueBuilder) -> Result<(), LocError> {546 #(#fields_serialize)*547548 Ok(())549 }550 fn parse(obj: &ObjValue) -> Result<Self, LocError> {551 Ok(Self {552 #(#fields_parse)*553 })554 }555 }556557 impl TryFrom<Val> for #ident {558 type Error = LocError;559 fn try_from(value: Val) -> Result<Self, Self::Error> {560 let obj = value.as_obj().expect("shape is correct");561 Self::parse(&obj)562 }563 }564 impl TryInto<Val> for #ident {565 type Error = LocError;566 fn try_into(self) -> Result<Val, Self::Error> {567 let mut out = ObjValueBuilder::new();568 self.serialize(&mut out)?;569 Ok(Val::Obj(out.build()))570 }571 }572 ()573 };574 })575}