Release 1.0.0
This commit is contained in:
parent
53642eef83
commit
9ed18c279c
|
@ -1,5 +1 @@
|
|||
Nim implementation of the [Preserves data language](https://preserves.gitlab.io/preserves/preserves.html).
|
||||
|
||||
Missing features:
|
||||
* embedded values
|
||||
* ordering of compound values
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Package
|
||||
|
||||
version = "0.3.0"
|
||||
version = "1.0.0"
|
||||
author = "Emery Hemingway"
|
||||
description = "data model and serialization format"
|
||||
license = "Unlicense"
|
||||
|
|
|
@ -9,9 +9,15 @@ from std/macros import hasCustomPragma, getCustomPragmaVal
|
|||
|
||||
type
|
||||
PreserveKind* = enum
|
||||
pkBoolean, pkFloat, pkDouble, pkSignedInteger, pkBigInteger, pkString,
|
||||
pkByteString, pkSymbol, pkRecord, pkSequence, pkSet, pkDictionary, pkEmbedded
|
||||
pkBoolean, pkFloat, pkDouble, pkSignedInteger, pkBigInteger, pkString, pkByteString, pkSymbol,
|
||||
pkRecord, pkSequence, pkSet, pkDictionary,
|
||||
pkEmbedded
|
||||
|
||||
const
|
||||
atomKinds* = {pkBoolean, pkFloat, pkDouble, pkSignedInteger, pkBigInteger, pkString, pkByteString, pkSymbol}
|
||||
compoundKinds* = {pkRecord, pkSequence, pkSet, pkDictionary}
|
||||
|
||||
type
|
||||
DictEntry[EmbededType] = tuple[key: PreserveGen[EmbededType], val: PreserveGen[EmbededType]]
|
||||
|
||||
PreserveGen*[EmbeddedType] {.acyclic.} = ref object
|
||||
|
@ -67,6 +73,7 @@ proc `<`(x, y: string | seq[byte]): bool =
|
|||
x.len < y.len
|
||||
|
||||
proc `<`*[E](x, y: PreserveGen[E]): bool =
|
||||
## Preserves have a total order over Values. Check if `x` is ordered before `y`.
|
||||
if x.kind != y.kind:
|
||||
if x.kind == pkSignedInteger and y.kind == pkBigInteger:
|
||||
result = x.int.initBigInt < y.bigint
|
||||
|
@ -120,6 +127,7 @@ proc `<`*[E](x, y: PreserveGen[E]): bool =
|
|||
result = x.embedded < y.embedded
|
||||
|
||||
proc `==`*[E](x, y: PreserveGen[E]): bool =
|
||||
## Check `x` and `y` for equivalence.
|
||||
# TODO: is this necessary to define?
|
||||
if x.isNil or y.isNil:
|
||||
result = x.isNil and y.isNil
|
||||
|
@ -155,6 +163,7 @@ proc `==`*[E](x, y: PreserveGen[E]): bool =
|
|||
result = x.embedded == y.embedded
|
||||
|
||||
proc hash*[E](prs: PreserveGen[E]): Hash =
|
||||
## Produce a `Hash` of `prs` for use with a `HashSet` or `Table`.
|
||||
type Value = PreserveGen[E]
|
||||
var h = hash(prs.kind.int)
|
||||
case prs.kind
|
||||
|
@ -193,6 +202,8 @@ proc hash*[E](prs: PreserveGen[E]): Hash =
|
|||
!$h
|
||||
|
||||
proc `[]`*(prs: Preserve; i: int): Preserve =
|
||||
## Select an indexed value from `prs`.
|
||||
## Only valid for records and sequences.
|
||||
case prs.kind
|
||||
of pkRecord: prs.record[i]
|
||||
of pkSequence: prs.sequence[i]
|
||||
|
@ -200,6 +211,7 @@ proc `[]`*(prs: Preserve; i: int): Preserve =
|
|||
raise newException(ValueError, "`[]` is not valid for " & $prs.kind)
|
||||
|
||||
proc incl*[E](prs: var PreserveGen[E]; key: PreserveGen[E]) =
|
||||
## Include `key` in the Preserves set `prs`.
|
||||
for i in 0..prs.set.high:
|
||||
if key < prs.set[i]:
|
||||
insert(prs.set, [key], i)
|
||||
|
@ -207,17 +219,20 @@ proc incl*[E](prs: var PreserveGen[E]; key: PreserveGen[E]) =
|
|||
prs.set.add(key)
|
||||
|
||||
proc excl*[E](prs: var PreserveGen[E]; key: PreserveGen[E]) =
|
||||
## Exclude `key` from the Preserves set `prs`.
|
||||
for i in 0..prs.set.high:
|
||||
if prs.set[i] == key:
|
||||
delete(prs.set, i, i)
|
||||
break
|
||||
|
||||
proc `[]`*[E](prs: var PreserveGen[E]; key: PreserveGen[E]): PreserveGen[E] =
|
||||
## Select a value by `key` from the Preserves dictionary `prs`.
|
||||
for (k, v) in prs.dict.items:
|
||||
if k == key: return v
|
||||
raise newException(KeyError, "value not in Preserves dictionary")
|
||||
|
||||
proc `[]=`*[E](prs: var PreserveGen[E]; key, val: PreserveGen[E]) =
|
||||
## Insert `val` by `key` in the Preserves dictionary `prs`.
|
||||
for i in 0..prs.dict.high:
|
||||
if key < prs.dict[i].key:
|
||||
insert(prs.dict, [(key, val, )], i)
|
||||
|
@ -227,17 +242,34 @@ proc `[]=`*[E](prs: var PreserveGen[E]; key, val: PreserveGen[E]) =
|
|||
return
|
||||
prs.dict.add((key, val, ))
|
||||
|
||||
proc initRecord*(label: Preserve; args: varargs[Preserve, toPreserve]): Preserve =
|
||||
## Record constructor.
|
||||
proc symbol*(s: string; E = void): PreserveGen[E] {.inline.} =
|
||||
## Create a Preserves symbol value.
|
||||
PreserveGen[E](kind: pkSymbol, symbol: s)
|
||||
|
||||
proc initRecord*[E](label: PreserveGen[E]; args: varargs[PreserveGen[E]]): PreserveGen[E] =
|
||||
## Create a Preserves record value.
|
||||
result = Preserve(kind: pkRecord,
|
||||
record: newSeqOfCap[Preserve](1+args.len))
|
||||
for arg in args:
|
||||
#assertValid(arg)
|
||||
result.record.add(arg)
|
||||
result.record.add(label)
|
||||
|
||||
proc initRecord*(label: string; args: varargs[Preserve, toPreserve]): Preserve =
|
||||
## Convert ``label`` to a symbol and create a new record.
|
||||
runnableExamples:
|
||||
assert($initRecord("foo", 1, 2.0) == "<foo 1 2.0f>")
|
||||
initRecord(symbol(label), args)
|
||||
|
||||
proc initSet*(E = void): PreserveGen[E] = PreserveGen[E](kind: pkSet)
|
||||
## Create a Preserves set value.
|
||||
|
||||
proc initDictionary*(E = void): PreserveGen[E] = PreserveGen[E](kind: pkDictionary)
|
||||
## Create a Preserves dictionary value.
|
||||
|
||||
proc len*[E](prs: PreserveGen[E]): int =
|
||||
## Return the number of values one level below ``prs``.
|
||||
## Return the shallow count of values in ``prs``, that is the number of
|
||||
## fields in a record, items in a sequence, items in a set, or key-value pairs
|
||||
## in a dictionary.
|
||||
case prs.kind
|
||||
of pkRecord: prs.record.len.pred
|
||||
of pkSequence: prs.sequence.len
|
||||
|
@ -245,19 +277,10 @@ proc len*[E](prs: PreserveGen[E]): int =
|
|||
of pkDictionary: prs.dict.len
|
||||
else: 0
|
||||
|
||||
proc symbol*(s: string; E = void): PreserveGen[E] {.inline.} =
|
||||
## Symbol constructor.
|
||||
PreserveGen[E](kind: pkSymbol, symbol: s)
|
||||
|
||||
proc initRecord*(label: string; args: varargs[Preserve, toPreserve]): Preserve {.inline.} =
|
||||
## Record constructor that converts ``label`` to a symbol.
|
||||
initRecord(symbol(label), args)
|
||||
|
||||
proc initSet*(E = void): PreserveGen[E] = PreserveGen[E](kind: pkSet)
|
||||
|
||||
proc initDictionary*(E = void): PreserveGen[E] = PreserveGen[E](kind: pkDictionary)
|
||||
|
||||
iterator items*[E](prs: PreserveGen[E]): PreserveGen[E] =
|
||||
## Shallow iterator over `prs`, yield the fields in a record,
|
||||
## the items of a sequence, the items of a set, or the pairs
|
||||
## of a dictionary.
|
||||
case prs.kind
|
||||
of pkRecord:
|
||||
for i in 0..prs.record.high.pred:
|
||||
|
@ -276,30 +299,33 @@ proc isFalse*[E](prs: PreserveGen[E]): bool =
|
|||
## Check if ``prs`` is equivalent to the zero-initialized ``Preserve``.
|
||||
prs.kind == pkBoolean and prs.bool == false
|
||||
|
||||
proc isSymbol*(prs: Preserve; sym: string): bool =
|
||||
proc isSymbol*[E](prs: PreserveGen[E]; sym: string): bool =
|
||||
## Check if `prs` is a Preserves symbol.
|
||||
(prs.kind == pkSymbol) and (prs.symbol == sym)
|
||||
|
||||
func isRecord*(prs: Preserve): bool =
|
||||
proc isRecord*[E](prs: PreserveGen[E]): bool =
|
||||
## Check if `prs` is a Preserves record.
|
||||
if prs.kind == pkRecord:
|
||||
result = true
|
||||
assert(prs.record.len > 0)
|
||||
|
||||
func isDictionary*(prs: Preserve): bool =
|
||||
proc isDictionary*[E](prs: PreserveGen[E]): bool =
|
||||
## Check if `prs` is a Preserves dictionary.
|
||||
prs.kind == pkDictionary
|
||||
|
||||
proc label*(prs: Preserve): Preserve {.inline.} =
|
||||
## Return the label of a record value.
|
||||
proc label*[E](prs: PreserveGen[E]): PreserveGen[E] {.inline.} =
|
||||
## Return the label of record value.
|
||||
prs.record[prs.record.high]
|
||||
|
||||
proc arity*(prs: Preserve): int {.inline.} =
|
||||
## Return the number of fields in a record value.
|
||||
proc arity*[E](prs: PreserveGen[E]): int {.inline.} =
|
||||
## Return the number of fields in record `prs`.
|
||||
pred(prs.record.len)
|
||||
|
||||
proc fields*(prs: Preserve): seq[Preserve] {.inline.} =
|
||||
proc fields*[E](prs: PreserveGen[E]): seq[PreserveGen[E]] {.inline.} =
|
||||
## Return the fields of a record value.
|
||||
prs.record[0..prs.record.high.pred]
|
||||
|
||||
iterator fields*(prs: Preserve): Preserve =
|
||||
iterator fields*[E](prs: PreserveGen[E]): PreserveGen[E] =
|
||||
## Iterate the fields of a record value.
|
||||
for i in 0..<prs.record.high: yield prs.record[i]
|
||||
|
||||
|
@ -324,6 +350,7 @@ proc readVarint(s: Stream): int =
|
|||
shift.inc 7
|
||||
|
||||
proc write*[E](str: Stream; prs: PreserveGen[E]) =
|
||||
## Write the binary-encoding of a Preserves value to a stream.
|
||||
case prs.kind:
|
||||
of pkBoolean:
|
||||
case prs.bool
|
||||
|
@ -423,12 +450,16 @@ proc write*[E](str: Stream; prs: PreserveGen[E]) =
|
|||
str.write(prs.embedded.toPreserve)
|
||||
|
||||
proc encode*[E](prs: PreserveGen[E]): string =
|
||||
## Return the binary-encoding of a Preserves value.
|
||||
let s = newStringStream()
|
||||
s.write prs
|
||||
s.setPosition 0
|
||||
result = s.readAll
|
||||
|
||||
proc decodePreserves*(s: Stream; E = void): PreserveGen[E] =
|
||||
## Decode a Preserves value from a binary-encoded stream.
|
||||
## ``E`` is the Nim type of embedded values where ``void``
|
||||
## selects a ``Preserve`` representation.
|
||||
type Value = PreserveGen[E]
|
||||
proc assertStream(check: bool) =
|
||||
if not check:
|
||||
|
@ -515,27 +546,24 @@ proc decodePreserves*(s: Stream; E = void): PreserveGen[E] =
|
|||
assertStream(false)
|
||||
|
||||
proc decodePreserves*(s: string, E = void): PreserveGen[E] =
|
||||
## Decode a string of binary-encoded Preserves.
|
||||
s.newStringStream.decodePreserves E
|
||||
|
||||
proc decodePreserves*(s: seq[byte], E = void): PreserveGen[E] =
|
||||
## Decode a byte-string of binary-encoded Preserves.
|
||||
cast[string](s).decodePreserves E
|
||||
|
||||
template record*(label: string) {.pragma.}
|
||||
## Serialize this object or tuple as a record.
|
||||
##
|
||||
## ```
|
||||
## type Foo {.record: "foobar".} = tuple
|
||||
## a, b: int
|
||||
## let r: Foo = (1, 2)
|
||||
## assert($r.toPreserve == "<foobar 1 2>")
|
||||
## ```
|
||||
## Serialize this object or tuple as a record. See ``toPreserve``.
|
||||
|
||||
template unpreservable*() {.pragma.}
|
||||
## Pragma to forbid a type from being converted by `toPreserve`.
|
||||
## Pragma to forbid a type from being converted by ``toPreserve``.
|
||||
|
||||
proc toPreserve*[T](x: T; E = void): PreserveGen[E] =
|
||||
## Serializes `x` to Preserves; uses `toPreserveHook(x: T)` if it's in scope to
|
||||
## customize serialization.
|
||||
## Serializes ``x`` to Preserves. Can be customized by defining
|
||||
## ``toPreserveHook(x: T)`` in the calling scope.
|
||||
## ``E`` is the embedded type where ``void`` returns embedded
|
||||
## values as Preserves.
|
||||
type Value = PreserveGen[E]
|
||||
when (T is Value): result = x
|
||||
elif T is E: result = Value(kind: pkEmbedded, embedded: x)
|
||||
|
@ -579,26 +607,26 @@ proc toPreserve*[T](x: T; E = void): PreserveGen[E] =
|
|||
raiseAssert("unpreservable type" & $T)
|
||||
|
||||
proc toPreserveHook*[T](set: HashSet[T]): Preserve =
|
||||
## Hook for preserving ``HashSet``.
|
||||
Preserve(kind: pkSet, set: set.map(toPreserve))
|
||||
|
||||
proc toPreserveHook*[A, B](table: Table[A, B]|TableRef[A, B]): Preserve =
|
||||
## Hook for preserving ``Table``.
|
||||
result = Preserve(kind: pkDictionary, dict: initTable[Preserve, Preserve](table.len))
|
||||
for k, v in table.pairs: result.dict.add((toPreserve(k), toPreserve(v), ))
|
||||
|
||||
proc fromPreserve*[E, T](v: var T; prs: PreserveGen[E]): bool =
|
||||
## Inplace version of `preserveTo`.
|
||||
## Partial matches on compond values may leave artifacts in ``v``.
|
||||
## Inplace version of `preserveTo`. Returns ``true`` on
|
||||
## a complete match, otherwise returns ``false``.
|
||||
# TODO: {.raises: [].}
|
||||
runnableExamples:
|
||||
import std/options, preserves, preserves/parse
|
||||
import preserves, preserves/parse
|
||||
type Foo {.record: "foo".} = object
|
||||
x, y, z: int
|
||||
|
||||
x, y: int
|
||||
var foo: Foo
|
||||
assert(fromPreserve(foo, parsePreserves("""<foo 1 2 3>""")))
|
||||
assert(fromPreserve(foo, parsePreserves("""<foo 1 2>""")))
|
||||
assert(foo.x == 1)
|
||||
assert(foo.y == 2)
|
||||
assert(foo.z == 3)
|
||||
type Value = PreserveGen[E]
|
||||
when T is Value:
|
||||
v = prs
|
||||
|
@ -683,18 +711,20 @@ proc fromPreserve*[E,T](v: var T; prs: PreserveGen[E]): bool =
|
|||
result = fromPreserve(result.distinctBase, prs)
|
||||
else:
|
||||
raiseAssert("no conversion of type Preserve to " & $T)
|
||||
if not result: reset v
|
||||
|
||||
proc preserveTo*[E](prs: PreserveGen[E]; T: typedesc): Option[T] =
|
||||
## Reverse of `toPreserve`.
|
||||
##
|
||||
# TODO: {.raises: [].}
|
||||
runnableExamples:
|
||||
import std/options, preserves, preserves/parse
|
||||
type Foo {.record: "foo".} = object
|
||||
x, y, z: int
|
||||
x, y: int
|
||||
|
||||
assert(parsePreserves("""<foo "abc">""").preserveTo(Foo).isNone)
|
||||
assert(parsePreserves("""<bar 1 2 3>""").preserveTo(Foo).isNone)
|
||||
assert(parsePreserves("""<foo 1 2 3>""").preserveTo(Foo).isSome)
|
||||
assert(parsePreserves("""<bar 1 2>""").preserveTo(Foo).isNone)
|
||||
assert(parsePreserves("""<foo 1 2>""").preserveTo(Foo).isSome)
|
||||
var v: T
|
||||
if fromPreserve(v, prs):
|
||||
result = some(move v)
|
||||
|
@ -775,3 +805,4 @@ proc concat[E](result: var string; prs: PreserveGen[E]) =
|
|||
result.add($prs.embedded)
|
||||
|
||||
proc `$`*[E](prs: PreserveGen[E]): string = concat(result, prs)
|
||||
## Generate the textual representation of ``prs``.
|
||||
|
|
|
@ -245,7 +245,8 @@ proc toConst(name: string; def: SchemaNode): Pnode =
|
|||
of pkSymbol:
|
||||
discard result.add nn(nkCall,
|
||||
ident"symbol",
|
||||
PNode(kind: nkStrLit, strVal: def.value.symbol))
|
||||
PNode(kind: nkStrLit, strVal: def.value.symbol),
|
||||
ident"EmbeddedType")
|
||||
else:
|
||||
raiseAssert("cannot convert " & $def & " to a Nim literal")
|
||||
else: discard
|
||||
|
@ -256,7 +257,8 @@ proc toNimLit(sn: SchemaNode): PNode =
|
|||
of pkSymbol:
|
||||
nkCall.newNode.add(
|
||||
ident"symbol",
|
||||
PNode(kind: nkStrLit, strVal: sn.value.symbol))
|
||||
PNode(kind: nkStrLit, strVal: sn.value.symbol),
|
||||
ident"EmbeddedType")
|
||||
else:
|
||||
raiseAssert("no Nim literal for " & $sn)
|
||||
|
||||
|
@ -338,7 +340,9 @@ proc generateProcs(result: var seq[PNode]; name: string; sn: SchemaNode) =
|
|||
of snkRecord:
|
||||
var
|
||||
params = nn(nkFormalParams, ident"Preserve")
|
||||
initRecordCall = nn(nkCall, ident"initRecord", sn.nodes[0].toNimLit)
|
||||
initRecordCall = nn(nkCall,
|
||||
nn(nkBracketExpr, ident"initRecord", ident"EmbeddedType"),
|
||||
sn.nodes[0].toNimLit)
|
||||
for i, field in sn.nodes:
|
||||
if i > 0:
|
||||
let id = field.ident
|
||||
|
@ -349,7 +353,8 @@ proc generateProcs(result: var seq[PNode]; name: string; sn: SchemaNode) =
|
|||
ident"Preserve",
|
||||
field.typeIdent),
|
||||
newEmpty())
|
||||
initRecordCall.add(id)
|
||||
initRecordCall.add(
|
||||
nn(nkCall, ident"toPreserve", id, ident"EmbeddedType"))
|
||||
result.add nn(nkProcDef,
|
||||
exportIdent("prs" & name),
|
||||
newEmpty(),
|
||||
|
@ -366,7 +371,16 @@ proc generateNimFile*(scm: Schema; path: string) =
|
|||
typeSection = newNode nkTypeSection
|
||||
constSection = newNode nkConstSection
|
||||
procs: seq[PNode]
|
||||
if scm.embeddedType != "":
|
||||
if scm.embeddedType == "":
|
||||
typeSection.add nn(nkTypeDef,
|
||||
ident"EmbeddedType",
|
||||
newEmpty(),
|
||||
ident"void")
|
||||
else:
|
||||
typeSection.add nn(nkTypeDef,
|
||||
ident"EmbeddedType",
|
||||
newEmpty(),
|
||||
ident(scm.embeddedType))
|
||||
typeSection.add nn(nkTypeDef,
|
||||
ident"Preserve",
|
||||
newEmpty(),
|
||||
|
|
Loading…
Reference in New Issue