v0.3.0 format a document, each comment with its owner; fewer allocations on the hot path
Test / test (push) Canceled after 0s
Test / test (push) Canceled after 0s
* Benchmarks for the parse, decode, encode and document paths A command's payload from text to its struct, a settings file with comment blocks, a scenario file of arrays of inline tables across lines, decoding and encoding that scenario, and ParseDocument: the readings the changes that follow are measured by. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ThctvSRwt5kV1pVMKtsdWc * Fewer allocations on the parse, decode and encode paths The parser's lexer drops what it never reads: a comment's text and a number's literal, which the parser parses from the input bytes in place. A string without escapes is one allocation, one with escapes is decoded into a buffer sized to its source. The lexer scans ASCII bytewise, the parser holds its lexer by value, keeps key paths on the stack, gathers an array's elements in a reused buffer and allocates the array once at its length, and holds the first few frozen inline tables in place; an inline table that is an array element is not held, as no key can reach it. Decode, Marshal and Unmapped read a struct's fields from one cache per type instead of splitting every tag on every call. Decode reuses one key and one element per map; Marshal sets a map's values into one array, and writes keys, headers and numbers into its buffer without concatenating. Tokens, positions, trees, error messages, encoded bytes and decoded values are unchanged: a differential fuzz against the previous sources ran 1.7M inputs over the lexer and parser and 9.5M over Marshal and Decode without a difference. benchstat, 8 runs each, Xeon 2.1 GHz: payload, parse and decode 3.31us -> 2.30us 31 -> 14 allocs 1.41 -> 1.09 KiB parse payload 2.40us -> 1.89us 24 -> 12 allocs parse settings 10.25us -> 6.98us 68 -> 32 allocs parse scenario 536us -> 391us 4959 -> 2970 allocs decode scenario 225us -> 110us 1863 -> 776 allocs marshal scenario 397us -> 252us 2326 -> 976 allocs ParseDocument settings 21.7us -> 16.5us 128 -> 85 allocs Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ThctvSRwt5kV1pVMKtsdWc * Document: a comment goes with what fewer blank lines part it from ParseDocument lays a document out as statements, runs of statements no blank line parts, and the comment groups between them. A group belongs to the side fewer blank lines part it from, the side below on a tie: right above a statement it is that statement's own; right below a run, or apart from it, it is the run's. Between two runs several groups split at the widest gap. The file's start counts as no blank line and its end as half of one, so a comment at the top with a blank line under it, or at the end with one above it, is the file's, and one touching the last statement stays with it. Delete takes a statement with its own comments; a run going whole takes its comments too and one blank run beside it, so no comment is left orphaned and no gap doubles. Set puts a new table above the file's closing comments and a first root key above the first table's comments, a blank line apart. What v0.2.0 kept by position (the comment above a dropped key, a dropped table's heading) now goes with its owner. FuzzDocument checks that a delete leaves whole lines the document had, in order, and that adding a key loses none; it ran 12.6M inputs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ThctvSRwt5kV1pVMKtsdWc * Format: one layout for a document, every comment kept with its owner Format, and Formatter for its options, writes a document spaced as Marshal writes one: one space around = and after a comma, [1, 2] and { a = 1 }, LF line ends, a value's lines a level deeper than the line its bracket opens on, and a trailing comma exactly when the closing bracket has a line of its own. Keys, scalars and comments keep their spelling. Comments stay with what they belong to by the rule Document reads them with, and the result's blank lines encode it again: a run of blank lines becomes one, or two below a comment group that belongs above it, so a second Format reads every comment as the first did and writes the same bytes. Each table is written once, at its first header: a header opening it again gives its keys there, its comments above the key they touched or else below what is there before them, and a dotted key reaching a table that has a header moves into it with its own comments. Tables of an array of tables never merge. Options: Indent (up to 8 tabs or spaces, a tab by default), IndentTables (a level per enclosing table whose header comes first), Align (= and comments of consecutive keys). Hardening: Format refuses what Parse refuses, a comment holding a bidirectional embedding, override or isolate or a line break other than LF (U+202A-202E, U+2066-2069, U+0085, U+2028, U+2029), which can show a reader text other than what parses, and a result that would not parse to the same values. Such a rune in a string or quoted key is written as its \u escape, by Format and by the encoder alike. A line indents at most 16 levels and aligns within 32 runes of key and 80 of line, so the result stays within a fixed multiple of its source; table paths sit in a trie, so placing a key costs its length, not its square. Marshal writes { a = 1 } and no blank first line, so Format(Marshal(v)) is Marshal(v), which FuzzRoundTrip now checks. FuzzFormat checks, with the options off and on, that the result reads as the source, formats to itself, keeps every comment once, holds no CR or trailing blank and stays within the size bound; CI runs it for 10 s. All 29 TOML files in vif format idempotently to the same values; vif.toml and keymap.toml are unchanged byte for byte. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ThctvSRwt5kV1pVMKtsdWc --------- Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
1 parent
e2712e32a2
commit
170e71f10a
12 files changed
+1809
-440
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# toml
|
||||
|
||||
A deterministic TOML subset encoder/decoder using Go standard library.
|
||||
A deterministic TOML subset encoder, decoder and formatter using Go standard library.
|
||||
Requires Go 1.27.1.
|
||||
|
||||
```go
|
||||
@@ -62,7 +62,8 @@ empty containers. Duplicate struct tag names error.
|
||||
|
||||
Basic-string escapes emitted by the encoder (`\b`, `\f`, `\n`, `\r`, `\t`,
|
||||
quotes, backslashes, Unicode escapes) decode symmetrically; the TOML 1.1 `\e`
|
||||
and `\xHH` decode too. Invalid UTF-8 and unescaped control characters in
|
||||
and `\xHH` decode too. The encoder escapes the runes that can hide text, as
|
||||
`Format` does (below). Invalid UTF-8 and unescaped control characters in
|
||||
strings are rejected, as are control characters other than tab in comments and
|
||||
a carriage return outside CRLF. Encoding and typed decoding
|
||||
have recursion bounds (1000 levels), so cyclic traversals fail instead of
|
||||
@@ -74,8 +75,11 @@ change it. Errors quote keys and cut long literals, and never repeat a string
|
||||
value. `Marshal` writes a table inline once its header path would pass 256
|
||||
bytes, so output stays linear in depth.
|
||||
|
||||
`Marshal` writes an inline table as `{ a = 1 }` and a blank line above each
|
||||
header but one opening the document; its output is what `Format` writes for it.
|
||||
Comments and original formatting are not preserved by `Parse`/`Marshal`; a
|
||||
`Document` edits a file in place instead.
|
||||
`Document` edits a file in place, and `Format` rewrites one with its comments
|
||||
kept.
|
||||
|
||||
## Editing a document in place
|
||||
|
||||
@@ -89,19 +93,31 @@ data = doc.Bytes()
|
||||
```
|
||||
|
||||
`ParseDocument` parses as `Parse` does and keeps the bytes. An edit rewrites only
|
||||
the statements it names, so comments, blank lines, order and the spelling of
|
||||
every other value stay as written; the result is parsed again, and an edit it
|
||||
would not parse after is refused with the document unchanged.
|
||||
the statements it names, with the comments that are theirs, so blank lines,
|
||||
order, every other comment and the spelling of every other value stay as
|
||||
written; the result is parsed again, and an edit it would not parse after is
|
||||
refused with the document unchanged.
|
||||
|
||||
A group of comment lines belongs to whichever side fewer blank lines part it
|
||||
from, the side below on a tie: the statement right under it, or the run of
|
||||
statements (lines no blank line parts) above or below it. The file's start and
|
||||
end count as sides, so a comment at the top with a blank line under it, or at
|
||||
the end with one above it, belongs to the file and stays, while one touching
|
||||
the last statement is that statement's run's. Between two runs, several groups
|
||||
split at the widest gap.
|
||||
|
||||
- `Set` replaces the value of a key the document sets, keeping the rest of its
|
||||
line and its comment. A key it lacks goes after the last key of its table,
|
||||
spelled as that key is (`play.mouse` beside `play.hud`), else after the table's
|
||||
header, else in a `[table]` appended at the end. A key under an array of
|
||||
tables, inside an inline table or array, or naming a table fails. The value is
|
||||
encoded as `Marshal` writes one.
|
||||
header, else in a `[table]` appended at the end, above the file's closing
|
||||
comments. A root key with no other goes above the first table and its
|
||||
comments. A key under an array of tables, inside an inline table or array, or
|
||||
naming a table fails. The value is encoded as `Marshal` writes one.
|
||||
- `Delete` removes the key and every key under it: each statement setting one and
|
||||
each header naming one, in every table of an array of tables. It reports
|
||||
whether it removed anything; a key inside an inline value fails.
|
||||
each header naming one, in every table of an array of tables, each with its
|
||||
comments. A run of statements going whole takes the comments that belong to
|
||||
it and one blank run beside it. It reports whether it removed anything; a key
|
||||
inside an inline value fails.
|
||||
- `Unmapped` names the keys no field of the destination takes, matched as `Decode`
|
||||
matches them (tags, then field names; unexported and `-` fields take nothing),
|
||||
each once and sorted. A map or interface destination takes every key under it;
|
||||
@@ -111,6 +127,46 @@ would not parse after is refused with the document unchanged.
|
||||
|
||||
A token's `Pos` and `End` are its byte offsets in the input.
|
||||
|
||||
## Formatting
|
||||
|
||||
```go
|
||||
out, err := toml.Format(data)
|
||||
out, err = toml.Formatter{Indent: " ", IndentTables: true, Align: true}.Format(data)
|
||||
```
|
||||
|
||||
`Format` writes a document spaced as `Marshal` writes one: one space around `=`
|
||||
and after a comma, `[1, 2]`, `{ a = 1 }`, `[a.b]`, LF line ends. A value's lines
|
||||
go a level deeper than the line its opening bracket is on, and an array or
|
||||
inline table has a trailing comma exactly when its closing bracket has a line of
|
||||
its own. Keys, scalars and comments keep their spelling; a run of blank lines
|
||||
becomes one.
|
||||
|
||||
Every comment stays with what it belongs to, as a `Document` reads it, and the
|
||||
result's blank lines say so again: two blank lines follow a group of comments
|
||||
that belongs to what is above it, after a blank line. Each table is written
|
||||
once, at its first header. The keys of a header opening a table again go there,
|
||||
a blank line apart, the header's comments above them; a dotted key reaching a
|
||||
table that has a header moves into it, spelled from it, with its own comments.
|
||||
Tables of an array of tables stay as written.
|
||||
|
||||
- `Indent` is one level, up to 8 tabs or spaces; a tab when empty.
|
||||
- `IndentTables` puts a table a level deeper for each table it is under whose
|
||||
header comes before it: `[a.b]` after `[a]`.
|
||||
- `Align` lines up the `=` and the comments of keys on consecutive lines, with
|
||||
spaces. A comment or blank line, a value of several lines, a key over 32 runes
|
||||
or a line over 80 ends the run.
|
||||
|
||||
A line indents no deeper than 16 levels, so a result stays within a fixed
|
||||
multiple of its source. `Format` refuses what `Parse` refuses, and a comment
|
||||
holding a bidirectional embedding, override or isolate (U+202A to U+202E, U+2066
|
||||
to U+2069) or a line break other than LF (U+0085, U+2028, U+2029): such a rune
|
||||
can show a reader text other than what parses, and a comment has no escape for
|
||||
it. In a string or quoted key it is written as its `\u` escape. A result that
|
||||
would not parse to the same values is refused.
|
||||
|
||||
`Parse`, `Unmarshal` and `Decode` never format: they skip a comment without
|
||||
reading its text.
|
||||
|
||||
## Deliberate subset and deviations
|
||||
|
||||
- Datetime syntax is unsupported. Use quoted strings and parse them in the
|
||||
|
||||
Reference in new issue
Block a user