# SPDX-License-Identifier: ISC import bigints import std/[base64, endians, json, hashes, macros, sets, streams, tables, typetraits] type PreserveKind* = enum pkBoolean, pkFloat, pkDouble, pkSignedInteger, pkBigInteger, pkString, pkByteString, pkSymbol, pkRecord, pkSequence, pkSet, pkDictionary, pkEmbedded Preserve* {.acyclic.} = object ## Type that stores a Preserves value. case kind*: PreserveKind of pkBoolean: bool*: bool of pkFloat: float*: float32 of pkDouble: double*: float64 of pkSignedInteger: int*: BiggestInt of pkBigInteger: bigint*: BigInt of pkString: string*: string of pkByteString: bytes*: seq[byte] of pkSymbol: symbol*: string of pkRecord: record*: seq[Preserve] # label is last of pkSequence: sequence*: seq[Preserve] of pkSet: set*: HashSet[Preserve] of pkDictionary: dict*: Table[Preserve, Preserve] of pkEmbedded: embedded*: pointer proc assertValid*(prs: Preserve) = case prs.kind of pkBigInteger: assert(BiggestInt.low.initBigInt < prs.bigint and prs.bigint < BiggestInt.high.initBigInt) of pkRecord: assert(prs.record.len > 0, "invalid Preserves record " & prs.repr) assert(prs.record[prs.record.high].kind < pkRecord) for v in prs.record: assertValid(v) of pkSequence: for v in prs.sequence: assertValid(v) of pkSet: for v in prs.set: assertValid(v) of pkDictionary: for key, val in prs.dict.pairs: assert(key.kind < pkRecord) assertValid(key) assertValid(val) else: discard proc isNil*(prs: Preserve): bool = ## Check if ``prs`` is equivalent to the zero-initialized ``Preserve``. prs.kind == pkBoolean and prs.bool == false proc `<`(x, y: string | seq[byte]): bool = for i in 0 .. min(x.high, y.high): if x[i] < y[i]: return true x.len < y.len proc `<`*(x, y: Preserve): bool = if x.kind != y.kind: if x.kind == pkSignedInteger and y.kind == pkBigInteger: result = x.int.initBigInt < y.bigint elif x.kind == pkBigInteger and y.kind == pkSignedInteger: result = x.bigint < y.int.initBigInt else: result = x.kind < y.kind else: case x.kind of pkBoolean: result = (not x.bool) and y.bool of pkSignedInteger: result = x.int < y.int of pkBigInteger: result = x.bigint < y.bigint of pkString: result = x.string < y.string of pkByteString: result = x.bytes < y.bytes of pkSymbol: result = x.symbol < y.symbol else: discard proc hash*(prs: Preserve): Hash = var h = hash(prs.kind.int) case prs.kind of pkBoolean: h = h !& hash(prs.bool) of pkFloat: h = h !& hash(prs.float) of pkDouble: h = h !& hash(prs.double) of pkSignedInteger: h = h !& hash(prs.int) of pkBigInteger: h = h !& hash(prs.bigint.flags) h = h !& hash(prs.bigint) of pkString: h = h !& hash(prs.string) of pkByteString: h = h !& hash(prs.bytes) of pkSymbol: h = h !& hash(prs.symbol) of pkRecord: for val in prs.record: h = h !& hash(val) of pkSequence: for val in prs.sequence: h = h !& hash(val) of pkSet: for val in prs.set.items: h = h !& hash(val) of pkDictionary: for (key, val) in prs.dict.pairs: h = h !& hash(val) of pkEmbedded: h = h !& hash(prs.embedded) !$h proc `==`*(x, y: Preserve): bool = if x.kind == y.kind: case x.kind of pkBoolean: result = x.bool == y.bool of pkFloat: result = x.float == y.float of pkDouble: result = x.double == y.double of pkSignedInteger: result = x.int == y.int of pkBigInteger: result = x.bigint == y.bigint of pkString: result = x.string == y.string of pkByteString: result = x.bytes == y.bytes of pkSymbol: result = x.symbol == y.symbol of pkRecord: for i, val in x.record: if y.record[i] != val: return false result = true of pkSequence: for i, val in x.sequence: if y.sequence[i] != val: return false result = true of pkSet: for val in x.set.items: if not y.set.contains(val): return false for val in y.set.items: if not x.set.contains(val): return false result = true of pkDictionary: for (key, val) in x.dict.pairs: if y.dict[key] != val: return false result = true of pkEmbedded: result = x.embedded == y.embedded proc `$`*(prs: Preserve): string = case prs.kind: of pkBoolean: case prs.bool of false: result = "#f" of true: result = "#t" of pkFloat: result = $prs.float & "f" of pkDouble: result = $prs.double of pkSignedInteger: result = $prs.int of pkBigInteger: result = $prs.bigint of pkString: result = escapeJson(prs.string) of pkByteString: result.add("#[") result.add(base64.encode(prs.bytes)) result.add(']') of pkSymbol: result.add(escapeJsonUnquoted(prs.symbol)) of pkRecord: assert(prs.record.len > 0) result.add('<') result.add($prs.record[prs.record.high]) for i in 0..') of pkSequence: result.add('[') for i, val in prs.sequence: if i > 0: result.add(' ') result.add($val) result.add(']') of pkSet: result.add("#{") for val in prs.set.items: result.add($val) result.add(' ') if result.len > 1: result.setLen(result.high) result.add('}') of pkDictionary: result.add('{') for (key, value) in prs.dict.pairs: result.add($key) result.add(": ") result.add($value) result.add(' ') if result.len > 1: result.setLen(result.high) result.add('}') of pkEmbedded: result.add(prs.embedded.repr) iterator items*(prs: Preserve): Preserve = case prs.kind of pkRecord: for i in 0..prs.record.high.pred: yield prs.record[i] of pkSequence: for e in prs.sequence.items: yield e of pkSet: for e in prs.set.items: yield e of pkDictionary: for k, v in prs.dict.pairs: yield k # key can be an arbitrary Preserve yield v else: discard func isRecord*(prs: Preserve): bool = if prs.kind == pkRecord: result = true assert(prs.record.len > 0) proc label*(prs: Preserve): Preserve {.inline.} = ## Return the label of a record value. prs.record[prs.record.high] proc arity*(prs: Preserve): int {.inline.} = ## Return the number of fields in a record value. pred(prs.record.len) proc fields*(prs: Preserve): seq[Preserve] {.inline.} = ## Return the fields of a record value. prs.record[0..prs.record.high.pred] iterator fields*(prs: Preserve): Preserve = ## Iterate the fields of a record value. for i in 0.. 0: write(n.pred, i shr 8) str.write(i.uint8) write(byteCount, prs.int) of pkBigInteger: doAssert(Negative notin prs.bigint.flags, "negative big integers not implemented") var bytes = newSeqOfCap[uint8](prs.bigint.limbs.len * 4) var begun = false for i in countdown(prs.bigint.limbs.high, 0): let limb = prs.bigint.limbs[i] for j in countdown(24, 0, 8): let b = uint8(limb shr j) begun = begun or (b != 0) if begun: bytes.add(b) if bytes.len <= 16: str.write(0xa0'u8 or bytes.high.uint8) else: str.write(0xb0'u8) str.writeVarint(bytes.len) str.write(cast[string](bytes)) of pkString: str.write(0xb1'u8) str.writeVarint(prs.string.len) str.write(prs.string) of pkByteString: str.write(0xb2'u8) str.writeVarint(prs.bytes.len) str.write(prs.bytes) of pkSymbol: str.write(0xb3'u8) str.writeVarint(prs.symbol.len) str.write(prs.symbol) of pkRecord: assert(prs.record.len > 0) str.write(0xb4'u8) str.write(prs.record[prs.record.high]) for i in 0.. 0x9c: 0xa0 else: 0x90)) of 0xa0: let len = (tag.int and 0x0f) + 1 if len <= 8: result = Preserve(kind: pkSignedInteger, int: s.readUint8().BiggestInt) if (result.int and 0x80) != 0: result.int.dec(0x100) for i in 1.. ## ``` template unpreservable*() {.pragma.} ## Pragma to forbid a type from being converted by `toPreserve`. proc toPreserve*[T](x: T): Preserve = ## Serializes `x` to Preserves; uses `toPreserveHook(x: A)` if it's in scope to ## customize serialization. when T is Preserve: result = x elif T is Bigint: result = Preserve(kind: pkBigInteger, bigint: x) elif compiles(toPreserveHook(x)): result = toPreserveHook(x) elif T is array | seq: result = Preserve(kind: pkSequence) for v in x.items: result.sequence.add(toPreserve(v)) elif T is bool: result = Preserve(kind: pkBoolean, bool: x) elif T is distinct: result = toPreserve(x.distinctBase) elif T is float: result = Preserve(kind: pkFloat, float: x) elif T is float64: result = Preserve(kind: pkDouble, double: x) elif T is object | tuple: when T.hasCustomPragma(unpreservable): {.error.} elif T.hasCustomPragma(record): result = Preserve(kind: pkRecord) for _, f in x.fieldPairs: result.record.add(toPreserve(f)) result.record.add(symbol(T.getCustomPragmaVal(record))) else: result = Preserve(kind: pkDictionary) for k, v in x.fieldPairs: result.dict[symbol(k)] = toPreserve(v) elif T is Ordinal: result = Preserve(kind: pkSignedInteger, int: x.ord.BiggestInt) elif T is ptr | ref: if system.`==`(x, nil): result = symbol"null" else: result = toPreserve(x[]) elif T is string: result = Preserve(kind: pkString, string: x) elif T is SomeInteger: result = Preserve(kind: pkSignedInteger, int: x.BiggestInt) else: raiseAssert("cannot convert to Preserves: " & $T) proc toPreserveHook*[T](set: HashSet[T]): Preserve = Preserve(kind: pkSet, set: set.map(toPreserve)) proc toPreserveHook*(js: JsonNode): Preserve = case js.kind of JString: result = Preserve(kind: pkString, string: js.str) of JInt: result = Preserve(kind: pkSignedInteger, int: js.num) of JFloat: result = Preserve(kind: pkDouble, double: js.fnum) of JBool: result = case js.bval of false: symbol"false" of true: symbol"true" of JNull: result = symbol"null" of JObject: result = Preserve(kind: pkDictionary) for key, val in js.fields.pairs: result.dict[Preserve(kind: pkString, string: key)] = toPreserveHook(val) of JArray: result = Preserve(kind: pkSequence, sequence: newSeq[Preserve](js.elems.len)) for i, e in js.elems: result.sequence[i] = toPreserveHook(e) proc toJsonHook*(prs: Preserve): JsonNode = case prs.kind: of pkBoolean: result = newJBool(prs.bool) of pkFloat: result = newJFloat(prs.float) of pkDouble: result = newJFloat(prs.double) of pkSignedInteger: result = newJInt(prs.int) of pkBigInteger: raise newException(ValueError, "cannot convert big integer to JSON") of pkString: result = newJString(prs.string) of pkByteString: raise newException(ValueError, "cannot convert bytes to JSON") of pkSymbol: case prs.symbol of "false": result = newJBool(false) of "true": result = newJBool(true) of "null": result = newJNull() else: raise newException(ValueError, "cannot convert symbol to JSON") of pkRecord: raise newException(ValueError, "cannot convert record to JSON") of pkSequence: result = newJArray() for val in prs.sequence: result.add(toJsonHook(val)) of pkSet: raise newException(ValueError, "cannot convert set to JSON") of pkDictionary: result = newJObject() for (key, val) in prs.dict.pairs: if key.kind != pkString: raise newException(ValueError, "cannot convert non-string dictionary key to JSON") result[key.string] = toJsonHook(val) of pkEmbedded: raise newException(ValueError, "cannot convert embedded value to JSON") proc checkRecordLabel(T: typedesc; prs: Preserve) = when T.hasCustomPragma(record): const label = symbol(T.getCustomPragmaVal(record)) if prs.label != label: raise newException(ValueError, $prs & " is not a record of class " & label.string) else: raise newException(Defect, $T & " lacks a {.record: \"…\".} annotation") proc fromPreserve*[T](result: var T; prs: Preserve) = # Inplace version of `preserveTo`. when compiles(fromPreserveHook(result, prs)): fromPreserveHook(result, prs) elif T is Preserve: result = prs elif T is Bigint: result = prs.bigint elif T is bool: result = prs.bool elif T is SomeInteger: result = T(prs.int) elif T is float: result = prs.float elif T is seq: result.setLen(prs.sequence.len) for i, val in prs.sequence: fromPreserve(result[i], val) elif T is float64: result = prs.double elif T is object | tuple: case prs.kind of pkRecord: checkRecordLabel(T, prs) var i: int for k, v in result.fieldPairs: fromPreserve(v, prs.record[i]) inc(i) of pkDictionary: for k, v in result.fieldPairs: fromPreserve(v, prs.dict[symbol(k)]) else: raise newException(ValueError, "cannot convert to Preserves value to type " & $T) elif T is Ordinal | SomeInteger: result = (T)prs.int elif T is ptr | ref: if system.`==`(x, nil): result = symbol"null" else: result = toPreserve(x[]) elif T is string: result = prs.string else: raiseAssert("cannot convert from Preserves: " & $T) proc preserveTo*(prs: Preserve; T: typedesc): T = ## Reverse of `toPreserve`. fromPreserve(result, prs) proc len*(prs: Preserve): int = ## Return the number of values one level below ``prs``. case prs.kind of pkRecord: prs.record.len.pred of pkSequence: prs.sequence.len of pkSet: prs.set.len of pkDictionary: prs.dict.len else: 0 proc `[]`*(prs: Preserve; i: int): Preserve = case prs.kind of pkRecord: prs.record[i] of pkSequence: prs.sequence[i] else: raise newException(ValueError, "`[]` is not valid for " & $prs.kind)