feat: Add unmarshal_to to modify an existing object

.github/workflows/ci.yml

@@ -12,12 +12,33 @@ on:
   pull_request:
 
 jobs:
-  test:
+
+  linux:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout Sources
       uses: actions/checkout@v3
     - name: Setup V
       uses: prantlf/setup-v-action@v1
-    - name: Test
-      run: v test .
+    - name: Build and Test
+      run: make
+
+  macos:
+    runs-on: macos-latest
+    steps:
+    - name: Checkout Sources
+      uses: actions/checkout@v3
+    - name: Setup V
+      uses: prantlf/setup-v-action@v1
+    - name: Build and Test
+      run: make
+
+  windows:
+    runs-on: windows-latest
+    steps:
+    - name: Checkout Sources
+      uses: actions/checkout@v3
+    - name: Setup V
+      uses: prantlf/setup-v-action@v1
+    - name: Build
+      run: make

.gitignore

@@ -1,3 +1,3 @@
 .DS_Store
-unmarshal_test
-unmarshal_test.dSYM
+*_test
+*.dSYM

.vscode/settings.json

@@ -1,9 +1,8 @@
 {
   "files.exclude": {
     "**/.git": true,
-    "**/.DS_Store": true
-  },
-  "search.exclude": {
-    "**/node_modules": true
+    "**/.DS_Store": true,
+    "**/*_test": true,
+    "**/*.dSYM": true
   }
 }

Makefile

@@ -0,0 +1,14 @@
+all: check test
+
+check:
+	v fmt -w .
+	v vet .
+
+test:
+	NO_COLOR=1 v test .
+
+clean:
+	rm -rf src/*_test src/*.dSYM
+
+version:
+	npx conventional-changelog-cli -p angular -i CHANGELOG.md -s

README.md

@@ -61,20 +61,20 @@ Parses an input string in the YAML format to an `Any` value. See [jany] for more
 input := r'
   answer: 42
 '
-any := parse_text(input)
+any := parse_text(input)!
 ```
 
 ### parse_file(path string) !Any
 
 Loads the contents of a text file in the YAML format and parses it to an `Any` value. See [jany] for more information about the `Any` type.
 
 ```go
-any := parse_file('config.yaml')
+any := parse_file('config.yaml')!
 ```
 
-### unmarshal_text[T](input string, opts UnmarshalOpts) !T
+### unmarshal_text[T](input string, opts &UnmarshalOpts) !T
 
-Unmarshals an input string in the YAML format to an instance of `T`. See [jany] for more information about the `Any` type and the `UnmarshalOpts` struct.
+Unmarshals an input string in the YAML format to a new instance of `T`. See [jany] for more information about the `Any` type and the `UnmarshalOpts` struct.
 
 ```go
 struct Config {
@@ -84,19 +84,48 @@ struct Config {
 input := r'
   answer: 42
 '
-config := unmarshal_text[Config](input)
+config := unmarshal_text[Config](input, UnmarshalOpts{})!
 ```
 
-### unmarshal_file[T](path string, opts UnmarshalOpts) !T
+### unmarshal_text_to[T](input string, mut obj T, opts &UnmarshalOpts) !
 
-Loads the contents of a text file in the YAML format and unmarshals it to an instance of `T`. See [jany] for more information about the `Any` type and the `UnmarshalOpts` struct.
+Unmarshals an input string in the YAML format to an existing instance of `T`. See [jany] for more information about the `Any` type and the `UnmarshalOpts` struct.
 
 ```go
 struct Config {
 	answer int
 }
 
-config := unmarshal_file[Config]('config.yaml')
+input := r'
+  answer: 42
+'
+mut config := Config{}
+config := unmarshal_text_to(input, mut config, UnmarshalOpts{})!
+```
+
+### unmarshal_file[T](path string, opts &UnmarshalOpts) !T
+
+Loads the contents of a text file in the YAML format and unmarshals it to a new instance of `T`. See [jany] for more information about the `Any` type and the `UnmarshalOpts` struct.
+
+```go
+struct Config {
+	answer int
+}
+
+config := unmarshal_file[Config]('config.yaml', UnmarshalOpts{})!
+```
+
+### unmarshal_file_to[T](path string, mut obj T, opts UnmarshalOpts) !
+
+Loads the contents of a text file in the YAML format and unmarshals it to an existing instance of `T`. See [jany] for more information about the `Any` type and the `UnmarshalOpts` struct.
+
+```go
+struct Config {
+	answer int
+}
+
+mut config := Config{}
+config := unmarshal_file_to('config.yaml', mut config, UnmarshalOpts{})!
 ```
 
 ## Performance

bench/bench-float.vsh

@@ -0,0 +1,76 @@
+#!/usr/bin/env -S v -prod run
+
+import benchmark
+import rand
+import strconv
+import time
+
+fn C.strtod(charptr, &charptr) f64
+fn C.strtol(charptr, &charptr, int) int
+
+fn strtod(s string) !f64 {
+	end := unsafe { nil }
+	C.errno = 0
+	n := C.strtod(s.str, &end)
+	if C.errno != 0 {
+		return error('out of range')
+	}
+	if unsafe { s.str + s.len != end } {
+		return error('not a number')
+	}
+	return n
+}
+
+fn strtol(s string) !int {
+	end := unsafe { nil }
+	C.errno = 0
+	n := C.strtol(s.str, &end, 10)
+	if C.errno != 0 {
+		return error('out of range')
+	}
+	if unsafe { s.str + s.len != end } {
+		return error('not a number')
+	}
+	return n
+}
+
+fn str_to_num(s string) !f64 {
+	if s.contains_any('.eE') {
+		return strtod(s)!
+	}
+	return f64(strconv.atoi(s) or { strtod(s)! })
+}
+
+rand.seed([u32(time.now().unix), 0])
+
+sample_size := 1500
+mut strings := []string{}
+for _ in 0 .. sample_size {
+	n := rand.int_in_range(0, 10000000) or { 0 }
+	strings << '${n}'
+	d := rand.int_in_range(0, 10000000) or { 0 }
+	f := rand.int_in_range(0, 10000000) or { 0 }
+	strings << '${d}.${f}'
+}
+
+mut b := benchmark.start()
+
+for s in strings {
+	_ := strconv.atof64(s)!
+}
+b.measure('parsing floats')
+
+for s in strings {
+	_ := strtod(s)!
+}
+b.measure('parsing floats with C')
+
+for s in strings {
+	_ := f64(strconv.atoi(s) or { strtod(s)! })
+}
+b.measure('parsing integers and floats')
+
+for s in strings {
+	_ := str_to_num(s)!
+}
+b.measure('parsing integers and floats with check')

bench/bench-int.vsh

@@ -0,0 +1,80 @@
+#!/usr/bin/env -S v -prod run
+
+import benchmark
+import rand
+import strconv
+import time
+
+fn C.strtod(charptr, &charptr) f64
+fn C.strtol(charptr, &charptr, int) int
+
+fn strtod(s string) !f64 {
+	C.errno = 0
+	n := C.strtod(s.str, 0)
+	if C.errno != 0 {
+		return error('range overflow')
+	}
+	return n
+}
+
+fn strtol(s string) !int {
+	C.errno = 0
+	n := C.strtol(s.str, 0, 10)
+	if C.errno != 0 {
+		return error('range overflow')
+	}
+	return n
+}
+
+rand.seed([u32(time.now().unix), 0])
+
+sample_size := 3000
+mut strings := []string{}
+for _ in 0 .. sample_size {
+	n := rand.int_in_range(0, 10000000) or { 0 }
+	strings << '${n}'
+}
+
+mut b := benchmark.start()
+for s in strings {
+	_ := f64(strconv.atoi(s)!)
+}
+b.measure('parsing integers')
+
+for s in strings {
+	C.errno = 0
+	_ := f64(C.strtol(s.str, 0, 10))
+	if C.errno != 0 {
+		panic('range overflow')
+	}
+}
+b.measure('parsing integers with C')
+
+for s in strings {
+	_ := f64(strtol(s)!)
+}
+b.measure('parsing integers with C wrapped')
+
+for s in strings {
+	_ := strconv.atof64(s)!
+}
+b.measure('parsing floats')
+
+for s in strings {
+	_ := strconv.atof_quick(s)
+}
+b.measure('parsing floats quickly')
+
+for s in strings {
+	C.errno = 0
+	_ := C.strtod(s.str, 0)
+	if C.errno != 0 {
+		panic('range overflow')
+	}
+}
+b.measure('parsing floats with C')
+
+for s in strings {
+	_ := strtod(s)!
+}
+b.measure('parsing floats with C wrapped')

parse_bench.vsh → bench/parse_bench.vsh

@@ -7,8 +7,8 @@ import prantlf.yaml
 
 const repeats = 20
 
-json_in := os.read_file('vlang.io.har.json')!
-yaml_in := os.read_file('vlang.io.har.yaml')!
+json_in := os.read_file('src/testdata/vlang.io.har.json')!
+yaml_in := os.read_file('src/testdata/vlang.io.har.yaml')!
 
 opts := json.ParseOpts{}
 

errors.v → src/errors.v

@@ -2,6 +2,7 @@ module yaml
 
 import prantlf.jany { Any }
 
+[noinit]
 pub struct YamlError {
 	Error
 	message string

src/unmarshal.v

@@ -0,0 +1,25 @@
+module yaml
+
+import prantlf.jany { UnmarshalOpts }
+
+pub fn unmarshal_text[T](input string, opts &UnmarshalOpts) !T {
+	mut obj := T{}
+	unmarshal_text_to[T](input, mut obj, opts)!
+	return obj
+}
+
+pub fn unmarshal_text_to[T](input string, mut obj T, opts &UnmarshalOpts) ! {
+	a := parse_text(input)!
+	jany.unmarshal_to[T](a, mut obj, opts)!
+}
+
+pub fn unmarshal_file[T](path string, opts &UnmarshalOpts) !T {
+	mut obj := T{}
+	unmarshal_file_to[T](path, mut obj, opts)!
+	return obj
+}
+
+pub fn unmarshal_file_to[T](path string, mut obj T, opts &UnmarshalOpts) ! {
+	a := parse_file(path)!
+	jany.unmarshal_to[T](a, mut obj, opts)!
+}