wgsl-parse 0.1.1

Parse a wgsl source file to a syntax tree
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# wgsl-parse

A parser and syntax tree for WGSL files, written directly from the [specification] with [lalrpop].

It supports WESL language extensions guarded by feature flags.

## WESL Features

| name       | description                                    | WESL Specification       |
|------------|------------------------------------------------|--------------------------|
| wesl       | enable all WESL extensions below               |                          |
| imports    | `import` statements and inline qualified paths | [complete][generics]     |
| attributes | extra attributes locations on statements       | [complete][condcomp]     |
| condcomp   | `@if` attributes                               | [complete][condcomp]     |
| generics   | `@type` attributes                             | [experimental][generics] |

## Parsing and Stringification

[`TranslationUnit`][syntax::TranslationUnit] implements [`FromStr`][std::str::FromStr].
Other syntax nodes also implement `FromStr`: `GlobalDirective`, `GlobalDeclaration`, `Statement`
and `Expression`.

The syntax tree elements implement [`Display`][std::fmt::Display].
The display is always pretty-printed.

```rust
# use crate::syntax::TranslationUnit;
let source = "@fragment fn frag_main() -> @location(0) vec4f { return vec4(1); }";
let mut module = TranslationUnit::from_str(source).unwrap();
// modify the module as needed...
println!("{module}");
```

[lalrpop]: https://lalrpop.github.io/lalrpop/
[specification]: https://www.w3.org/TR/WGSL/
[wesl]: https://github.com/wgsl-tooling-wg/wesl-spec
[condcomp]: https://github.com/wgsl-tooling-wg/wesl-spec/blob/main/ConditionalTranslation.md
[imports]: https://github.com/wgsl-tooling-wg/wesl-spec/blob/main/Imports.md
[generics]: https://github.com/wgsl-tooling-wg/wesl-spec/blob/main/Generics.md