ground_truth/libraries/src/JSON/Grammar.dfy

// RUN: %verify "%s"

/// ==========================================
///  Low-level JSON grammar (Concrete syntax)
/// ==========================================
///
/// See ``JSON.Values`` for the high-level interface.

include "../BoundedInts.dfy"
include "Utils/Views.dfy"

module {:options "-functionSyntax:4"} JSON.Grammar {
  import opened BoundedInts
  import opened Utils.Views.Core

  const EMPTY := View.OfBytes([])
  const DOUBLEQUOTE := View.OfBytes(['\"' as byte])
  const PERIOD := View.OfBytes(['.' as byte])
  const E := View.OfBytes(['e' as byte])
  const COLON := View.OfBytes([':' as byte])
  const COMMA := View.OfBytes([',' as byte])
  const LBRACE := View.OfBytes(['{' as byte])
  const RBRACE := View.OfBytes(['}' as byte])
  const LBRACKET := View.OfBytes(['[' as byte])
  const RBRACKET := View.OfBytes([']' as byte])
  const MINUS := View.OfBytes(['-' as byte])

  type jchar = v: View | v.Length() == 1 witness View.OfBytes(['b' as byte])
  type jquote = v: View | v.Char?('\"') witness DOUBLEQUOTE
  type jperiod = v: View | v.Char?('.') witness PERIOD
  type je = v: View | v.Char?('e') || v.Char?('E') witness E
  type jcolon = v: View | v.Char?(':') witness COLON
  type jcomma = v: View | v.Char?(',') witness COMMA
  type jlbrace = v: View | v.Char?('{') witness LBRACE
  type jrbrace = v: View | v.Char?('}') witness RBRACE
  type jlbracket = v: View | v.Char?('[') witness LBRACKET
  type jrbracket = v: View | v.Char?(']') witness RBRACKET
  type jminus = v: View | v.Char?('-') || v.Empty? witness MINUS
  type jsign = v: View | v.Char?('-') || v.Char?('+') || v.Empty? witness EMPTY

  predicate Blank?(b: byte) { b == 0x20 || b == 0x09 || b == 0x0A || b == 0x0D }
  ghost predicate Blanks?(v: View) { forall b | b in v.Bytes() :: Blank?(b) }
  type jblanks = v: View | Blanks?(v) witness View.OfBytes([])

  datatype Structural<+T> =
    Structural(before: jblanks, t: T, after: jblanks)

  datatype Maybe<+T> = Empty() | NonEmpty(t: T)

  datatype Suffixed<+T, +S> =
    Suffixed(t: T, suffix: Maybe<Structural<S>>)

  type SuffixedSequence<+D, +S> = s: seq<Suffixed<D, S>> | NoTrailingSuffix(s)
  ghost predicate NoTrailingSuffix<S, D>(s: seq<Suffixed<D, S>>) {
    forall idx | 0 <= idx < |s| :: s[idx].suffix.Empty? <==> idx == |s| - 1
  }

  datatype Bracketed<+L, +D, +S, +R> =
    Bracketed(l: Structural<L>, data: SuffixedSequence<D, S>, r: Structural<R>)

  const NULL: bytes := ['n' as byte, 'u' as byte, 'l' as byte, 'l' as byte]
  const TRUE: bytes := ['t' as byte, 'r' as byte, 'u' as byte, 'e' as byte]
  const FALSE: bytes := ['f' as byte, 'a' as byte, 'l' as byte, 's' as byte, 'e' as byte]

  ghost predicate Null?(v: View) { v.Bytes() == NULL }
  ghost predicate Bool?(v: View) { v.Bytes() in {TRUE, FALSE} }
  predicate Digit?(b: byte) { '0' as byte <= b <= '9' as byte }
  ghost predicate Digits?(v: View) { forall b | b in v.Bytes() :: Digit?(b) }
  ghost predicate Num?(v: View) { Digits?(v) && !v.Empty? }
  ghost predicate Int?(v: View) { v.Char?('0') || (Num?(v) && v.At(0) != '0' as byte) }

  type jnull = v: View | Null?(v) witness View.OfBytes(NULL)
  type jbool = v: View | Bool?(v) witness View.OfBytes(TRUE)
  type jdigits = v: View | Digits?(v) witness View.OfBytes([])
  type jnum = v: View | Num?(v) witness View.OfBytes(['0' as byte])
  type jint = v: View | Int?(v) witness View.OfBytes(['0' as byte])
  type jstr = v: View | true witness View.OfBytes([]) // TODO: Enforce quoting and escaping
  datatype jstring = JString(lq: jquote, contents: jstr, rq: jquote)
  datatype jKeyValue = KeyValue(k: jstring, colon: Structural<jcolon>, v: Value)

  // TODO enforce no leading space before closing bracket to disambiguate WS { WS WS } WS
  type jobject = Bracketed<jlbrace, jKeyValue, jcomma, jrbrace>
  type jarray = Bracketed<jlbracket, Value, jcomma, jrbracket>
  type jmembers = SuffixedSequence<jKeyValue, jcomma>
  type jmember = Suffixed<jKeyValue, jcomma>
  type jitems = SuffixedSequence<Value, jcomma>
  type jitem = Suffixed<Value, jcomma>

  datatype jfrac = JFrac(period: jperiod, num: jnum)
  datatype jexp = JExp(e: je, sign: jsign, num: jnum)
  datatype jnumber = JNumber(minus: jminus, num: jnum, frac: Maybe<jfrac>, exp: Maybe<jexp>)

  datatype Value =
    | Null(n: jnull)
    | Bool(b: jbool)
    | String(str: jstring)
    | Number(num: jnumber)
    | Object(obj: jobject)
    | Array(arr: jarray)

  type JSON = Structural<Value>
}