knurdy 0.2.0

Minimal, opinionated KDL deserialization with Serde
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
use heck::ToSnekCase;
use kdl::{KdlDocument, KdlEntry, KdlNode};
use serde::de::{self, Error, IntoDeserializer, Unexpected};

use crate::{literal::KdlAnnotatedValueDeser, DeError, KdlAnnotatedValueWrap};

/// Deserializer for a node
#[derive(Debug, Clone)]
pub struct KdlNodeDeser<'de> {
  #[allow(dead_code)]
  name: &'de str,
  entries: &'de [KdlEntry],
  children: Option<&'de KdlDocument>,

  forwarding_to_map_from_struct: bool,
}

impl<'de> KdlNodeDeser<'de> {
  pub fn new(wrapped: &'de KdlNode) -> Self {
    Self {
      name: wrapped.name().value(),
      entries: wrapped.entries(),
      children: wrapped.children(),

      forwarding_to_map_from_struct: false,
    }
  }

  fn collect_args_props(
    &self,
  ) -> (
    Vec<KdlAnnotatedValueWrap<'de>>,
    Vec<(&'de str, KdlAnnotatedValueWrap<'de>)>,
  ) {
    let mut args = Vec::new();
    let mut props = Vec::new();
    for entry in self.entries {
      if let Some(name) = entry.name() {
        let kavr = KdlAnnotatedValueWrap::from_entry(entry);
        props.push((name.value(), kavr));
      } else {
        let kavr = KdlAnnotatedValueWrap::from_entry(entry);
        args.push(kavr);
      }
    }
    (args, props)
  }
}

macro_rules! single_scalar {
  (@ $ty:ident) => {
    paste::paste! {
      fn [< deserialize_ $ty >]<V>(self, visitor: V) -> Result<V::Value, Self::Error>
      where
        V: de::Visitor<'de>,
      {
        if let ([ref entry @ KdlEntry { .. }], true) = (self.entries, self.children.is_none()) {
          if entry.name().is_none() {
            // then it is actually an arg, not a prop
            return KdlAnnotatedValueDeser::new(entry).[< deserialize_ $ty >](visitor);
          }
        }

        Err(DeError::invalid_type(
          Unexpected::Other(concat!(
            "node that isn't exactly one argument deserializable as ",
            stringify!($ty),
            " and nothing else",
          )),
          &visitor,
        ))
      }
    }
  };
  ( $($ty:ident)* ) => {
    $(
      single_scalar!(@ $ty);
    )*
  };
}

impl<'de> de::Deserializer<'de> for KdlNodeDeser<'de> {
  type Error = DeError;

  single_scalar! {
    u8 u16 u32 u64 i8 i16 i32 i64 char bool f32 f64
    str string bytes byte_buf identifier
  }

  fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    if let ([ref entry @ KdlEntry { .. }], true) =
      (self.entries, self.children.is_none())
    {
      if entry.name().is_none() {
        // then it is actually an arg
        return KdlAnnotatedValueDeser::new(entry)
          .deserialize_enum(name, variants, visitor);
      }
    }
    Err(DeError::invalid_type(
            Unexpected::Other(
                "node that isn't exactly one argument/property deserializable as enum and nothing else",
            ),
            &visitor,
        ))
  }

  fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    let kids_all_dashes = if let Some(kids) = self.children {
      kids.nodes().iter().all(|kid| kid.name().value() == "-")
    } else {
      false
    };

    let (arguments, properties) = self.collect_args_props();

    match (
      !arguments.is_empty(),
      !properties.is_empty() || self.children.is_some(),
    ) {
      (false, false) => visitor.visit_unit(),
      (true, true) => Err(DeError::invalid_type(
        Unexpected::Other(
          "node with arguments, properties/children, or neither (and not both)",
        ),
        &visitor,
      )),
      (true, false) => {
        let mut args = arguments;
        args.reverse();
        visitor.visit_seq(SeqArgsDeser(args))
      }
      _ if kids_all_dashes => {
        visitor.visit_seq(SeqDashChildrenDeser(self.children.unwrap().nodes()))
      }
      (false, true) => self.deserialize_map(visitor),
    }
  }

  fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    let (args, mut properties) = self.collect_args_props();

    if !args.is_empty() {
      return Err(DeError::invalid_type(
        Unexpected::Other("node with no arguments"),
        &visitor,
      ));
    }

    properties.reverse();
    visitor.visit_map(MapDeser {
      properties,
      children: self.children.map(|x| x.nodes()),
      value: MapDeserVal::None,
      snekify: self.forwarding_to_map_from_struct,
    })
  }
  fn deserialize_struct<V>(
    self,
    _name: &'static str,
    _fields: &'static [&'static str],
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    let self2 = Self {
      forwarding_to_map_from_struct: true,
      ..self
    };
    self2.deserialize_map(visitor)
  }

  fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    let (arguments, properties) = self.collect_args_props();

    if !properties.is_empty()
      || (arguments.is_empty() && self.children.is_none())
    {
      return Err(DeError::invalid_type(
                Unexpected::Other(
                    "node invalid as sequence (needs either only args, or children all named `-`)",
                ),
                &visitor,
            ));
    }

    if let Some(kids) = self.children {
      let kids_all_dashes =
        kids.nodes().iter().all(|kid| kid.name().value() == "-");
      if !kids_all_dashes {
        return Err(DeError::invalid_type(Unexpected::Other("node invalid as sequence (needs either only args, or children all named `-`)"), &visitor));
      }
      visitor.visit_seq(SeqDashChildrenDeser(kids.nodes()))
    } else {
      let mut args = arguments;
      args.reverse();
      visitor.visit_seq(SeqArgsDeser(args))
    }
  }

  fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    if self.entries.len() == 1 && self.entries[0].value().is_null() {
      visitor.visit_none()
    } else {
      visitor.visit_some(self)
    }
  }

  fn deserialize_tuple<V>(
    self,
    _len: usize,
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    self.deserialize_seq(visitor)
  }
  fn deserialize_tuple_struct<V>(
    self,
    _name: &'static str,
    _len: usize,
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    self.deserialize_seq(visitor)
  }

  fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    let (arguments, properties) = self.collect_args_props();

    if arguments.is_empty() && properties.is_empty() && self.children.is_none()
    {
      visitor.visit_unit()
    } else {
      Err(DeError::invalid_type(
        Unexpected::Other("node with arguments or properties or children"),
        &visitor,
      ))
    }
  }
  fn deserialize_unit_struct<V>(
    self,
    _name: &'static str,
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    self.deserialize_unit(visitor)
  }
  fn deserialize_ignored_any<V>(
    self,
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    visitor.visit_unit()
  }

  fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V,
  ) -> Result<V::Value, Self::Error>
  where
    V: de::Visitor<'de>,
  {
    visitor.visit_newtype_struct(self)
  }
}

struct MapDeser<'de> {
  /// These are in *backwards* order so it's cheap to pop the back one off
  properties: Vec<(&'de str, KdlAnnotatedValueWrap<'de>)>,
  children: Option<&'de [KdlNode]>,
  snekify: bool,

  value: MapDeserVal<'de>,
}

enum MapDeserVal<'de> {
  None,
  Property(KdlAnnotatedValueWrap<'de>),
  Child(&'de KdlNode),
}

impl<'de> de::MapAccess<'de> for MapDeser<'de> {
  type Error = DeError;

  fn next_key_seed<K>(
    &mut self,
    seed: K,
  ) -> Result<Option<K::Value>, Self::Error>
  where
    K: de::DeserializeSeed<'de>,
  {
    if !matches!(self.value, MapDeserVal::None) {
      return Err(DeError::custom("map visitor requested two keys in a row"));
    }

    // more like *pop*erties amirite
    let key = if let Some((key, val)) = self.properties.pop() {
      self.value = MapDeserVal::Property(val);
      key
    } else if let Some([kid, tail @ ..]) = self.children {
      // lispily pop the front
      self.children = Some(tail);
      self.value = MapDeserVal::Child(kid);
      kid.name().value()
    } else {
      return Ok(None);
    };
    let snek = if self.snekify {
      ToSnekCase::to_snek_case(key)
    } else {
      key.to_owned()
    };
    seed.deserialize(snek.into_deserializer()).map(Some)
  }

  fn next_value_seed<V>(&mut self, seed: V) -> Result<V::Value, Self::Error>
  where
    V: de::DeserializeSeed<'de>,
  {
    match std::mem::replace(&mut self.value, MapDeserVal::None) {
      MapDeserVal::None => Err(DeError::custom(
        "map visitor requested a value without a key",
      )),
      MapDeserVal::Property(prop) => {
        seed.deserialize(KdlAnnotatedValueDeser(prop))
      }
      MapDeserVal::Child(kid) => seed.deserialize(KdlNodeDeser::new(kid)),
    }
  }
}

/// Sequence deserializer for a struct with only arguments,
/// Stored backwards for better popping O time
struct SeqArgsDeser<'de>(Vec<KdlAnnotatedValueWrap<'de>>);

impl<'de> de::SeqAccess<'de> for SeqArgsDeser<'de> {
  type Error = DeError;

  fn next_element_seed<T>(
    &mut self,
    seed: T,
  ) -> Result<Option<T::Value>, Self::Error>
  where
    T: de::DeserializeSeed<'de>,
  {
    if let Some(head) = self.0.pop() {
      seed.deserialize(KdlAnnotatedValueDeser(head)).map(Some)
    } else {
      Ok(None)
    }
  }
}

/// Sequence deserializer for a struct with only children and all of the nodes are named `-`
struct SeqDashChildrenDeser<'de>(&'de [KdlNode]);

impl<'de> de::SeqAccess<'de> for SeqDashChildrenDeser<'de> {
  type Error = DeError;

  fn next_element_seed<T>(
    &mut self,
    seed: T,
  ) -> Result<Option<T::Value>, Self::Error>
  where
    T: de::DeserializeSeed<'de>,
  {
    if let [head, tail @ ..] = self.0 {
      self.0 = tail;
      seed.deserialize(KdlNodeDeser::new(head)).map(Some)
    } else {
      Ok(None)
    }
  }
}