kobold-json 0.1.0

Forensic JSON evidence packets for COBOL record migration: raw-byte custody, copybook/record hashes, field findings, round-trip proof. Clean-room; independent of GnuCOBOL/libcob.
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
//! A small, deterministic, self-contained JSON value model + serializer + fail-closed parser.
//!
//! This is the JSON analogue of a clean serializer/parser pair: a [`JsonValue`] tree with **ordered**
//! objects (so a packet's field order is stable for migration diffs and golden-file tests), a deterministic
//! [`serialize`]/[`to_string`] that is a pure function of the tree, and a recursive-descent [`parse`] that
//! is **fail-closed** (it returns an `Err` on malformed input -- it never silently repairs or guesses).
//!
//! It is independent of GnuCOBOL/libcob. ASCII-only output for non-printable controls via `\uXXXX`.

/// A JSON value. Objects keep their members in **insertion order** (a `Vec` of pairs, not a map) so a
/// serialized packet is byte-stable.
#[derive(Debug, Clone, PartialEq)]
pub enum JsonValue {
    /// `null`.
    Null,
    /// `true` / `false`.
    Bool(bool),
    /// A number, kept as its literal text (so integer/decimal formatting round-trips exactly).
    Number(String),
    /// A string.
    String(String),
    /// An ordered array.
    Array(Vec<JsonValue>),
    /// An **ordered** object: `(key, value)` members in insertion order.
    Object(Vec<(String, JsonValue)>),
}

impl JsonValue {
    /// Construct a string value.
    pub fn str(s: impl Into<String>) -> JsonValue {
        JsonValue::String(s.into())
    }

    /// Construct a number value from a u64.
    pub fn uint(n: u64) -> JsonValue {
        JsonValue::Number(n.to_string())
    }

    /// Look up a member of an object by key (first match), or `None`.
    pub fn get(&self, key: &str) -> Option<&JsonValue> {
        if let JsonValue::Object(members) = self {
            members.iter().find(|(k, _)| k == key).map(|(_, v)| v)
        } else {
            None
        }
    }

    /// The string contents if this is a `String`, else `None`.
    pub fn as_str(&self) -> Option<&str> {
        if let JsonValue::String(s) = self {
            Some(s)
        } else {
            None
        }
    }
}

/// Serialization options.
#[derive(Debug, Clone)]
pub struct SerializeOptions {
    /// Pretty-print with `indent`-space indentation + newlines. `None` = compact (no insignificant
    /// whitespace) -- the safest form for byte-stable diffs.
    pub indent: Option<usize>,
}

impl Default for SerializeOptions {
    fn default() -> Self {
        SerializeOptions { indent: None }
    }
}

/// Escape a JSON string body into `out` (ASCII-only: controls and non-ASCII via `\uXXXX`).
pub fn escape_string(s: &str, out: &mut String) {
    out.push(0x22 as char); // opening quote
    for c in s.chars() {
        match c {
            '\\' => out.push_str("\\\\"),
            '\n' => out.push_str("\\n"),
            '\r' => out.push_str("\\r"),
            '\t' => out.push_str("\\t"),
            '\u{08}' => out.push_str("\\b"),
            '\u{0c}' => out.push_str("\\f"),
            c if c as u32 == 0x22 => out.push_str("\\\""),
            c if (c as u32) < 0x20 || (c as u32) > 0x7e => {
                // Emit as \uXXXX (surrogate pair for astral planes).
                let cp = c as u32;
                if cp > 0xffff {
                    let v = cp - 0x10000;
                    let hi = 0xd800 + (v >> 10);
                    let lo = 0xdc00 + (v & 0x3ff);
                    push_u_escape(hi, out);
                    push_u_escape(lo, out);
                } else {
                    push_u_escape(cp, out);
                }
            }
            c => out.push(c),
        }
    }
    out.push(0x22 as char); // closing quote
}

fn push_u_escape(cp: u32, out: &mut String) {
    const HEX: &[u8; 16] = b"0123456789abcdef";
    out.push_str("\\u");
    out.push(HEX[((cp >> 12) & 0xf) as usize] as char);
    out.push(HEX[((cp >> 8) & 0xf) as usize] as char);
    out.push(HEX[((cp >> 4) & 0xf) as usize] as char);
    out.push(HEX[(cp & 0xf) as usize] as char);
}

fn write_value(v: &JsonValue, opts: &SerializeOptions, depth: usize, out: &mut String) {
    let pad = |n: usize, out: &mut String| {
        if let Some(w) = opts.indent {
            out.push('\n');
            out.push_str(&" ".repeat(w * n));
        }
    };
    match v {
        JsonValue::Null => out.push_str("null"),
        JsonValue::Bool(true) => out.push_str("true"),
        JsonValue::Bool(false) => out.push_str("false"),
        JsonValue::Number(n) => out.push_str(n),
        JsonValue::String(s) => escape_string(s, out),
        JsonValue::Array(items) => {
            if items.is_empty() {
                out.push_str("[]");
                return;
            }
            out.push('[');
            for (i, item) in items.iter().enumerate() {
                if i > 0 {
                    out.push(',');
                }
                pad(depth + 1, out);
                write_value(item, opts, depth + 1, out);
            }
            pad(depth, out);
            out.push(']');
        }
        JsonValue::Object(members) => {
            if members.is_empty() {
                out.push_str("{}");
                return;
            }
            out.push('{');
            for (i, (k, val)) in members.iter().enumerate() {
                if i > 0 {
                    out.push(',');
                }
                pad(depth + 1, out);
                escape_string(k, out);
                out.push(':');
                if opts.indent.is_some() {
                    out.push(' ');
                }
                write_value(val, opts, depth + 1, out);
            }
            pad(depth, out);
            out.push('}');
        }
    }
}

/// Serialize a [`JsonValue`] to text. Deterministic: a pure function of `v` + `opts`. Object members are
/// emitted in their stored order (never reordered).
pub fn serialize(v: &JsonValue, opts: &SerializeOptions) -> String {
    let mut out = String::new();
    write_value(v, opts, 0, &mut out);
    out
}

/// Convenience: serialize compactly.
pub fn to_string(v: &JsonValue) -> String {
    serialize(v, &SerializeOptions::default())
}

// ---- Parser (fail-closed recursive descent) ----------------------------------------------------------

/// A JSON parse error: a message and the byte offset where it was detected.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParseError {
    /// What went wrong.
    pub message: String,
    /// The byte offset into the input where the error was detected.
    pub offset: usize,
}

struct Parser<'a> {
    b: &'a [u8],
    i: usize,
}

impl<'a> Parser<'a> {
    fn err(&self, msg: &str) -> ParseError {
        ParseError { message: msg.to_string(), offset: self.i }
    }

    fn skip_ws(&mut self) {
        while self.i < self.b.len() {
            match self.b[self.i] {
                b' ' | b'\t' | b'\n' | b'\r' => self.i += 1,
                _ => break,
            }
        }
    }

    fn peek(&self) -> Option<u8> {
        self.b.get(self.i).copied()
    }

    fn value(&mut self) -> Result<JsonValue, ParseError> {
        self.skip_ws();
        match self.peek() {
            None => Err(self.err("unexpected end of input")),
            Some(b'{') => self.object(),
            Some(b'[') => self.array(),
            Some(c) if c == 0x22 => self.string().map(JsonValue::String),
            Some(b't') | Some(b'f') => self.boolean(),
            Some(b'n') => self.null(),
            Some(c) if c == b'-' || c.is_ascii_digit() => self.number(),
            Some(_) => Err(self.err("unexpected character")),
        }
    }

    fn expect(&mut self, c: u8) -> Result<(), ParseError> {
        if self.peek() == Some(c) {
            self.i += 1;
            Ok(())
        } else {
            Err(self.err("expected a specific character"))
        }
    }

    fn literal(&mut self, word: &[u8]) -> Result<(), ParseError> {
        if self.b[self.i..].starts_with(word) {
            self.i += word.len();
            Ok(())
        } else {
            Err(self.err("invalid literal"))
        }
    }

    fn null(&mut self) -> Result<JsonValue, ParseError> {
        self.literal(b"null")?;
        Ok(JsonValue::Null)
    }

    fn boolean(&mut self) -> Result<JsonValue, ParseError> {
        if self.peek() == Some(b't') {
            self.literal(b"true")?;
            Ok(JsonValue::Bool(true))
        } else {
            self.literal(b"false")?;
            Ok(JsonValue::Bool(false))
        }
    }

    fn number(&mut self) -> Result<JsonValue, ParseError> {
        let start = self.i;
        if self.peek() == Some(b'-') {
            self.i += 1;
        }
        let int_start = self.i;
        while matches!(self.peek(), Some(c) if c.is_ascii_digit()) {
            self.i += 1;
        }
        if self.i == int_start {
            return Err(self.err("number missing integer part"));
        }
        // Strict JSON: no leading zeros (a single 0 is fine, "01" is not).
        if self.i - int_start > 1 && self.b[int_start] == b'0' {
            return Err(self.err("leading zero in number"));
        }
        if self.peek() == Some(b'.') {
            self.i += 1;
            let frac_start = self.i;
            while matches!(self.peek(), Some(c) if c.is_ascii_digit()) {
                self.i += 1;
            }
            if self.i == frac_start {
                return Err(self.err("number missing fraction digits"));
            }
        }
        if matches!(self.peek(), Some(b'e') | Some(b'E')) {
            self.i += 1;
            if matches!(self.peek(), Some(b'+') | Some(b'-')) {
                self.i += 1;
            }
            let exp_start = self.i;
            while matches!(self.peek(), Some(c) if c.is_ascii_digit()) {
                self.i += 1;
            }
            if self.i == exp_start {
                return Err(self.err("number missing exponent digits"));
            }
        }
        let text = core::str::from_utf8(&self.b[start..self.i])
            .map_err(|_| self.err("non-utf8 in number"))?;
        Ok(JsonValue::Number(text.to_string()))
    }

    fn string(&mut self) -> Result<String, ParseError> {
        self.expect(0x22)?;
        let mut s = String::new();
        loop {
            let c = self.peek().ok_or_else(|| self.err("unterminated string"))?;
            self.i += 1;
            match c {
                x if x == 0x22 => return Ok(s),
                b'\\' => {
                    let e = self.peek().ok_or_else(|| self.err("unterminated escape"))?;
                    self.i += 1;
                    match e {
                        x if x == 0x22 => s.push(0x22 as char),
                        b'\\' => s.push('\\'),
                        b'/' => s.push('/'),
                        b'b' => s.push('\u{08}'),
                        b'f' => s.push('\u{0c}'),
                        b'n' => s.push('\n'),
                        b'r' => s.push('\r'),
                        b't' => s.push('\t'),
                        b'u' => {
                            let cp = self.hex4()?;
                            if (0xd800..=0xdbff).contains(&cp) {
                                // high surrogate: must be followed by \uDC00..\uDFFF
                                if self.peek() != Some(b'\\') {
                                    return Err(self.err("lone high surrogate"));
                                }
                                self.i += 1;
                                if self.peek() != Some(b'u') {
                                    return Err(self.err("lone high surrogate"));
                                }
                                self.i += 1;
                                let lo = self.hex4()?;
                                if !(0xdc00..=0xdfff).contains(&lo) {
                                    return Err(self.err("invalid low surrogate"));
                                }
                                let combined = 0x10000 + ((cp - 0xd800) << 10) + (lo - 0xdc00);
                                s.push(
                                    char::from_u32(combined)
                                        .ok_or_else(|| self.err("invalid surrogate pair"))?,
                                );
                            } else if (0xdc00..=0xdfff).contains(&cp) {
                                return Err(self.err("lone low surrogate"));
                            } else {
                                s.push(
                                    char::from_u32(cp)
                                        .ok_or_else(|| self.err("invalid code point"))?,
                                );
                            }
                        }
                        _ => return Err(self.err("invalid escape")),
                    }
                }
                x if x < 0x20 => return Err(self.err("unescaped control in string")),
                // Accept a UTF-8 continuation: rewind and decode one char.
                _ => {
                    self.i -= 1;
                    let rest = &self.b[self.i..];
                    let ch_str = match core::str::from_utf8(rest) {
                        Ok(valid) => valid,
                        Err(e) if e.valid_up_to() > 0 => {
                            core::str::from_utf8(&rest[..e.valid_up_to()]).unwrap()
                        }
                        Err(_) => return Err(self.err("invalid utf-8 in string")),
                    };
                    let ch = ch_str
                        .chars()
                        .next()
                        .ok_or_else(|| self.err("invalid utf-8 in string"))?;
                    self.i += ch.len_utf8();
                    s.push(ch);
                }
            }
        }
    }

    fn hex4(&mut self) -> Result<u32, ParseError> {
        let mut v = 0u32;
        for _ in 0..4 {
            let c = self.peek().ok_or_else(|| self.err("short \\u escape"))?;
            let d = match c {
                b'0'..=b'9' => (c - b'0') as u32,
                b'a'..=b'f' => (c - b'a' + 10) as u32,
                b'A'..=b'F' => (c - b'A' + 10) as u32,
                _ => return Err(self.err("invalid hex digit in \\u escape")),
            };
            v = v * 16 + d;
            self.i += 1;
        }
        Ok(v)
    }

    fn array(&mut self) -> Result<JsonValue, ParseError> {
        self.expect(b'[')?;
        let mut items = Vec::new();
        self.skip_ws();
        if self.peek() == Some(b']') {
            self.i += 1;
            return Ok(JsonValue::Array(items));
        }
        loop {
            let v = self.value()?;
            items.push(v);
            self.skip_ws();
            match self.peek() {
                Some(b',') => {
                    self.i += 1;
                }
                Some(b']') => {
                    self.i += 1;
                    return Ok(JsonValue::Array(items));
                }
                _ => return Err(self.err("expected ',' or ']' in array")),
            }
        }
    }

    fn object(&mut self) -> Result<JsonValue, ParseError> {
        self.expect(b'{')?;
        let mut members: Vec<(String, JsonValue)> = Vec::new();
        self.skip_ws();
        if self.peek() == Some(b'}') {
            self.i += 1;
            return Ok(JsonValue::Object(members));
        }
        loop {
            self.skip_ws();
            if self.peek() != Some(0x22) {
                return Err(self.err("expected string key in object"));
            }
            let key = self.string()?;
            self.skip_ws();
            self.expect(b':')?;
            let v = self.value()?;
            members.push((key, v));
            self.skip_ws();
            match self.peek() {
                Some(b',') => {
                    self.i += 1;
                }
                Some(b'}') => {
                    self.i += 1;
                    return Ok(JsonValue::Object(members));
                }
                _ => return Err(self.err("expected ',' or '}' in object")),
            }
        }
    }
}

/// Parse JSON text into a [`JsonValue`], **fail-closed**: trailing non-whitespace, malformed escapes,
/// missing parts, lone surrogates, and unexpected EOF all return `Err`. Never silently repairs.
pub fn parse(input: &str) -> Result<JsonValue, ParseError> {
    let mut p = Parser { b: input.as_bytes(), i: 0 };
    let v = p.value()?;
    p.skip_ws();
    if p.i != p.b.len() {
        return Err(p.err("trailing data after JSON value"));
    }
    Ok(v)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serialize_ordered_object() {
        let v = JsonValue::Object(vec![
            ("b".into(), JsonValue::uint(2)),
            ("a".into(), JsonValue::str("x")),
        ]);
        // order preserved (b before a), not sorted
        assert_eq!(to_string(&v), "{\"b\":2,\"a\":\"x\"}");
    }

    #[test]
    fn serialize_escapes() {
        let v = JsonValue::str("a\"b\\c\n\t");
        assert_eq!(to_string(&v), "\"a\\\"b\\\\c\\n\\t\"");
        // non-ascii becomes \uXXXX
        let v2 = JsonValue::str("\u{00e9}"); // e-acute
        assert_eq!(to_string(&v2), "\"\\u00e9\"");
    }

    #[test]
    fn roundtrip_parse_serialize() {
        let src = "{\"r\":\"REC\",\"fields\":{\"A\":\"hi\",\"N\":12.50},\"arr\":[1,2,null,true]}";
        let v = parse(src).unwrap();
        assert_eq!(to_string(&v), src);
    }

    #[test]
    fn fail_closed_trailing() {
        assert!(parse("{} junk").is_err());
        assert!(parse("[1,2,]").is_err());
        assert!(parse("\"abc").is_err());
        assert!(parse("01").is_err()); // leading-zero/trailing
        assert!(parse("nul").is_err());
    }

    #[test]
    fn parse_unicode_escape() {
        let v = parse("\"\\u00e9\"").unwrap();
        assert_eq!(v.as_str(), Some("\u{00e9}"));
    }
}