json_token_parser.pony

  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
use @strtod[F64](nptr: Pointer[U8] tag, endptr: Pointer[Pointer[U8] box] ref)

class ref JsonTokenParser
  """
  Streaming JSON token parser.

  Parses a JSON string and emits tokens to a JsonTokenNotify callback.
  This is the lower-level API — most users should use JsonParser.parse()
  instead. Use this when you need to process large documents without
  materializing the full tree.
  """

  var _notify: JsonTokenNotify
  var _source: String box = ""
  var _offset: USize = 0
  var _token_start: USize = 0
  var _line: USize = 1
  var _abort: Bool = false
  var _error_message: String = ""
  // Null-terminated view of _source, computed once per parse() so `_read_float`
  // can hand strtod a pointer into it without re-terminating the whole source
  // on every number. For a non-null-terminated source this is a temporary copy
  // held only by this raw pointer, alive only for the synchronous parse() that
  // set it — never dereference it outside the current parse().
  var _source_cstr: Pointer[U8] tag = Pointer[U8]

  var last_number: (I64 | F64) = I64(0)
    """The most recently parsed number value."""

  var last_string: String = ""
    """The most recently parsed string or key value."""

  new ref create(notify': JsonTokenNotify) =>
    _notify = notify'

  fun ref parse(source': String box) ? =>
    """
    Parse a JSON document, emitting tokens to the notify callback. Raises on
    malformed input and on a numeric literal outside `F64` range.
    """
    _source = source'
    _source_cstr = source'.cstring()
    _offset = 0
    _token_start = 0
    _line = 1
    _abort = false
    _error_message = ""
    last_number = I64(0)
    last_string = ""

    _skip_whitespace()
    if _offset >= _source.size() then return end
    _parse_value()?
    _skip_whitespace()
    if _offset < _source.size() then error end

  fun ref abort() =>
    """Signal the parser to stop after the current token."""
    _abort = true

  fun token_start(): USize =>
    """Byte offset where the current token starts."""
    _token_start

  fun token_end(): USize =>
    """Byte offset where the current token ends."""
    _offset

  fun line(): USize =>
    """Current line number (1-based)."""
    _line

  fun describe_error(): String =>
    """
    Human-readable description of the most recent error: a specific reason (such
    as an out-of-range number) when one has been recorded, otherwise the error's
    byte-offset location.
    """
    if _error_message != "" then
      _error_message
    elseif _offset < _source.size() then
      "Invalid JSON at byte offset " + _offset.string()
        + ", line " + _line.string()
    else
      "Unexpected end of JSON at byte offset "
        + _source.size().string()
        + ", line " + _line.string()
    end

  // --- Private parsing methods ---

  fun ref _emit(token: JsonToken) ? =>
    _notify(this, token)
    if _abort then error end

  fun ref _parse_value() ? =>
    """
    Parse one JSON value and all its descendants, emitting tokens.

    Iterative rather than recursive: an explicit stack of container contexts
    bounds nesting depth by the heap instead of the scheduler thread's native
    stack, which deeply nested input would otherwise overflow. The token
    sequence, token-offset bookkeeping, and abort/error behavior match a
    straightforward recursive descent exactly.
    """
    let stack = Array[_ParseCtx]
    match \exhaustive\ _read_value()?
    | _ReadComplete => return
    | _ReadOpenObject => stack.push(_ParseCtx(true))
    | _ReadOpenArray => stack.push(_ParseCtx(false))
    end

    while stack.size() > 0 do
      let ctx = try stack(stack.size() - 1)? else _Unreachable(); return end
      if ctx.expect_separator then
        _skip_whitespace()
        _token_start = _offset
        match _next()?
        | ',' => ctx.expect_separator = false
        | '}' if ctx.is_object =>
          _emit(JsonTokenObjectEnd)?
          try stack.pop()? else _Unreachable() end
        | ']' if not ctx.is_object =>
          _emit(JsonTokenArrayEnd)?
          try stack.pop()? else _Unreachable() end
        else
          error
        end
      else
        if ctx.is_object then
          _skip_whitespace()
          _token_start = _offset
          _parse_string(true)? // parse key
          _skip_whitespace()
          _eat(':')?
        end
        // The current element's value follows. A container value sets this
        // context to the separator phase before its own context is pushed,
        // so when the child closes we resume looking for ',' or the bracket.
        match \exhaustive\ _read_value()?
        | _ReadComplete => ctx.expect_separator = true
        | _ReadOpenObject =>
          ctx.expect_separator = true
          stack.push(_ParseCtx(true))
        | _ReadOpenArray =>
          ctx.expect_separator = true
          stack.push(_ParseCtx(false))
        end
      end
    end

  fun ref _read_value(): _ReadResult ? =>
    """
    Read a single value at the current position.

    Scalars emit their token and return _ReadComplete. A container emits its
    start token; an empty one also emits its end token and returns
    _ReadComplete, while a non-empty one returns _ReadOpenObject or
    _ReadOpenArray for the caller to track on the work stack.
    """
    _skip_whitespace()
    _token_start = _offset
    match _peek()?
    | '{' =>
      _next()? // consume '{'
      _emit(JsonTokenObjectStart)?
      _skip_whitespace()
      if _peek()? == '}' then
        // Anchor token_start at the closing '}', not the opening '{' set
        // above, so the end token spans only the closing bracket — matching
        // the non-empty close path in _parse_value.
        _token_start = _offset
        _next()?
        _emit(JsonTokenObjectEnd)?
        _ReadComplete
      else
        _ReadOpenObject
      end
    | '[' =>
      _next()? // consume '['
      _emit(JsonTokenArrayStart)?
      _skip_whitespace()
      if _peek()? == ']' then
        // Anchor token_start at the closing ']', not the opening '[' set
        // above, so the end token spans only the closing bracket — matching
        // the non-empty close path in _parse_value.
        _token_start = _offset
        _next()?
        _emit(JsonTokenArrayEnd)?
        _ReadComplete
      else
        _ReadOpenArray
      end
    | '"' => _parse_string(false)?; _ReadComplete
    | 't' => _parse_true()?; _ReadComplete
    | 'f' => _parse_false()?; _ReadComplete
    | 'n' => _parse_null()?; _ReadComplete
    | let c: U8 if (c == '-') or ((c >= '0') and (c <= '9')) =>
      _parse_number()?
      _ReadComplete
    else
      error
    end

  fun ref _parse_true() ? =>
    _eat('t')?; _eat('r')?; _eat('u')?; _eat('e')?
    _emit(JsonTokenTrue)?

  fun ref _parse_false() ? =>
    _eat('f')?; _eat('a')?; _eat('l')?; _eat('s')?; _eat('e')?
    _emit(JsonTokenFalse)?

  fun ref _parse_null() ? =>
    _eat('n')?; _eat('u')?; _eat('l')?; _eat('l')?
    _emit(JsonTokenNull)?

  fun ref _parse_number() ? =>
    // The whole literal, including any sign, starts here; the float path hands
    // this span to strtod, the integer path accumulates directly.
    let num_start = _offset
    let sign: I64 = if _peek_safe() == '-' then _next()?; -1 else 1 end
    let int_start = _offset
    let integer = _read_digits()?
    let int_digits = _offset - int_start

    // RFC 8259: leading zeros not allowed (e.g., 01, 00, 007)
    if try (_source(int_start)? == '0') and (int_digits > 1)
    else false end then
      error
    end

    // An integer of more than 18 digits can exceed I64, so it is read as an F64
    // even with no fraction or exponent.
    var is_float = int_digits > 18

    if _peek_safe() == '.' then
      _next()?
      _read_digits()? // require at least one fraction digit
      is_float = true
    end

    match _peek_safe()
    | 'e' | 'E' =>
      _next()?
      let c = _peek()?
      if (c == '+') or (c == '-') then _next()? end
      _read_digits()? // require at least one exponent digit
      is_float = true
    end

    if is_float then
      let value = _read_float(num_start)?
      // An out-of-range literal (1e999, or a very long integer) overflows to
      // ±inf; carrying a non-finite value would hand the printer something it
      // cannot serialize to valid JSON. Underflow rounds to a finite 0 and is
      // kept. RFC 8259 permits limiting numeric range.
      if not value.finite() then
        _error_message = "Number out of range"
        error
      end
      last_number = value
    else
      last_number = sign * integer
    end
    _emit(JsonTokenNumber)?

  fun ref _read_digits(): I64 ? =>
    var result: I64 = 0
    var count: USize = 0
    while _offset < _source.size() do
      let c = _source(_offset)?
      if (c >= '0') and (c <= '9') then
        result = (result * 10) + (c - '0').i64()
        _offset = _offset + 1
        count = count + 1
      else
        break
      end
    end
    if count == 0 then error end
    result

  fun ref _read_float(num_start: USize): F64 ? =>
    // Correctly-rounded value of the validated number text [num_start, _offset)
    // via strtod — no intermediate over/underflow, unlike a hand-rolled
    // mantissa*10^exp. _source_cstr is the null-terminated source (set once in
    // parse()); strtod stops at the delimiter or end of input. The caller's
    // finite() check judges range (overflow is ±inf, underflow rounds to a
    // finite 0); errno is not used because it conflates the two.
    var endp: Pointer[U8] box = Pointer[U8]
    let value = @strtod(_source_cstr.offset(num_start), addressof endp)
    // strtod must consume the whole validated span; reject a shortfall rather
    // than accept a partial value.
    if endp != _source_cstr.offset(_offset) then
      _error_message = "Invalid number"
      error
    end
    value

  fun ref _parse_string(is_key: Bool) ? =>
    // token_start is already anchored at the opening '"' by the caller
    // (_read_value for a string value, _parse_value for a key). Don't
    // re-anchor it after _eat — that would drop the opening quote from the
    // String/Key token's span.
    _eat('"')?
    var buf = recover String end
    while true do
      match \exhaustive\ _next()?
      | '"' => break
      | '\\' =>
        match _next()?
        | '"'  => buf.push('"')
        | '\\' => buf.push('\\')
        | '/'  => buf.push('/')
        | 'b'  => buf.push(0x08)
        | 'f'  => buf.push(0x0C)
        | 'n'  => buf.push('\n')
        | 'r'  => buf.push('\r')
        | 't'  => buf.push('\t')
        | 'u'  => buf = _parse_unicode(consume buf)?
        else error
        end
      | let c: U8 if c < 0x20 => error
      | let c: U8 => buf.push(c)
      end
    end
    last_string = consume buf
    _emit(if is_key then JsonTokenKey else JsonTokenString end)?

  fun ref _parse_unicode(buf: String iso): String iso^ ? =>
    let value = _read_hex4()?

    if (value >= 0xD800) and (value < 0xDC00) then
      // High surrogate — expect \uXXXX low surrogate
      _eat('\\')?; _eat('u')?
      let low = _read_hex4()?
      if (low >= 0xDC00) and (low < 0xE000) then
        let combined =
          0x10000 + (((value and 0x3FF) << 10) or (low and 0x3FF))
        buf.append(recover val String.from_utf32(combined) end)
      else
        error
      end
    elseif (value >= 0xDC00) and (value < 0xE000) then
      error // lone low surrogate
    else
      buf.append(recover val String.from_utf32(value) end)
    end
    consume buf

  fun ref _read_hex4(): U32 ? =>
    var result: U32 = 0
    var i: USize = 0
    while i < 4 do
      let c = _next()?
      let digit: U32 = if (c >= '0') and (c <= '9') then
        (c - '0').u32()
      elseif (c >= 'a') and (c <= 'f') then
        (c - 'a').u32() + 10
      elseif (c >= 'A') and (c <= 'F') then
        (c - 'A').u32() + 10
      else
        error
      end
      result = (result << 4) or digit
      i = i + 1
    end
    result

  // --- Character primitives ---

  fun _peek(): U8 ? =>
    _source(_offset)?

  fun _peek_safe(): U8 =>
    try _source(_offset)? else 0 end

  fun ref _next(): U8 ? =>
    let c = _source(_offset)?
    _offset = _offset + 1
    if c == '\n' then _line = _line + 1 end
    c

  fun ref _eat(expected: U8) ? =>
    if _source(_offset)? != expected then error end
    _offset = _offset + 1
    if expected == '\n' then _line = _line + 1 end

  fun ref _skip_whitespace() =>
    while _offset < _source.size() do
      match try _source(_offset)? else return end
      | ' ' | '\t' | '\r' => _offset = _offset + 1
      | '\n' => _offset = _offset + 1; _line = _line + 1
      else return
      end
    end

primitive _ReadComplete
  """`_read_value` read a complete value (a scalar or an empty container)."""
primitive _ReadOpenObject
  """`_read_value` opened a non-empty object; its context must be tracked."""
primitive _ReadOpenArray
  """`_read_value` opened a non-empty array; its context must be tracked."""

type _ReadResult is (_ReadComplete | _ReadOpenObject | _ReadOpenArray)
  """What `_read_value` did: completed a value, or opened a container."""

class _ParseCtx
  """
  One open container on the parser's work stack.

  `is_object` distinguishes `{}` from `[]`. `expect_separator` is the phase
  toggle: `false` means the next thing to read is an element (a key/value pair
  for an object, a value for an array); `true` means it is a separator (`,`) or
  the closing bracket.
  """
  let is_object: Bool
  var expect_separator: Bool

  new create(is_object': Bool) =>
    is_object = is_object'
    expect_separator = false