Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gen: extended headers #270

Merged
merged 10 commits into from
Mar 3, 2024
Merged

gen: extended headers #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5503b6d
gen-check: show better error in CI
rajveermalviya Feb 11, 2024
9a2769b
Generation & Validation for multiple yamls
rajveermalviya Feb 11, 2024
7ed6145
enum extensions
rajveermalviya Feb 11, 2024
8d90f24
yaml order matters
rajveermalviya Feb 11, 2024
54d61ef
add readme section
rajveermalviya Feb 11, 2024
fcb3096
comments
rajveermalviya Feb 11, 2024
3b3fd84
object extensions
rajveermalviya Feb 11, 2024
2121161
bitflag extensions
rajveermalviya Feb 11, 2024
158a995
add implicit suffix & namespaces
rajveermalviya Feb 24, 2024
b5e31c5
specify namespace in yaml
rajveermalviya Mar 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@ gen: schema.json webgpu.yml
go run ./gen -schema schema.json -yaml webgpu.yml -header webgpu.h

gen-check: gen
@git diff --quiet -- webgpu.h || { git diff -- webgpu.h; exit 1; }
@git diff --quiet -- webgpu.h || { \
echo "error: The re-generated header from yml doesn't match the checked-in header"; \
git diff -- webgpu.h; \
exit 1; \
}
12 changes: 12 additions & 0 deletions gen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

The generator for generating `webgpu.h` header and other extension headers or implementation specific headers from the yaml spec files.

# Generate implementation specific header

The generator also allows generating custom implementation specific headers that build on top of `webgpu.h` header. The generator accepts the combination of `-yaml` & `-header` flags in sequence, which it uses to validate the specifications and then generate their headers.

For example, if `wgpu.yml` contains the implementation specific API, the header can be generated using:

```shell
> go run ./gen -schema schema.json -yaml webgpu.yml -header webgpu.h -yaml wgpu.yml -header wgpu.h
```

Since the generator does some duplication validation, the order of the files matter, so generator mandates the core `webgpu.yml` to be first in the sequence.

# yaml spec

### Types
Expand Down
131 changes: 62 additions & 69 deletions gen/cheader.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{- MCommentN .Copyright 0}}

#ifndef {{.Name | ConstantCase}}_H_
#define {{.Name | ConstantCase}}_H_
#ifndef {{.HeaderName | ConstantCase}}_H_
#define {{.HeaderName | ConstantCase}}_H_

#if defined(WGPU_SHARED_LIBRARY)
# if defined(_WIN32)
Expand Down Expand Up @@ -37,7 +37,17 @@
#define WGPU_NULLABLE
#endif{{"\n" -}}

{{if eq .Name "webgpu"}}
{{- if ne .Name "webgpu"}}
#if !defined(__WGPU_EXTEND_ENUM)
#ifdef __cplusplus
#define __WGPU_EXTEND_ENUM(E, N, V) static const E N = E(V)
#else
#define __WGPU_EXTEND_ENUM(E, N, V) static const E N = (E)(V)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we need a WGPU_ENUM_EXTENDED_VALUE_ATTRIBUTE here. I'm not really clear on when Swift needs NS_REFINED_FOR_SWIFT exactly, but it seems like it probably would need one here in order to refine our enums into Swift enums?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know syntactically where the NS_REFINED_FOR_SWIFT would need to go.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This does not block landing the PR. I don't think #179 is fully resolved right now anyway.)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just defer this to when someone asks for it.

#endif
#endif // !defined(__WGPU_EXTEND_ENUM)
{{ end}}

{{- if eq .Name "webgpu"}}
#include <stdint.h>
#include <stddef.h>
{{else}}
Expand All @@ -46,8 +56,8 @@

{{- if .Constants}}
{{- range .Constants}}
{{- MComment .Doc 0}}
#define WGPU_{{.Name | ConstantCase}} ({{.Value | CValue}})
{{- MComment .Doc 0}}
#define WGPU_{{.Name | ConstantCase}}{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}} ({{.Value | CValue}})
{{- end}}
{{ end}}

Expand All @@ -59,61 +69,51 @@ typedef uint32_t WGPUBool;
{{- if .Objects}}
{{- range .Objects}}
{{- if not .IsStruct}}
typedef struct WGPU{{.Name | PascalCase}}Impl* WGPU{{.Name | PascalCase}} WGPU_OBJECT_ATTRIBUTE;
typedef struct WGPU{{.Name | PascalCase}}{{$.ExtSuffix}}Impl* WGPU{{.Name | PascalCase}}{{$.ExtSuffix}} WGPU_OBJECT_ATTRIBUTE;
{{- end}}
{{- end}}
{{ end}}

{{- if .Structs}}
// Structure forward declarations
{{- range .Structs}}
struct WGPU{{.Name | PascalCase}};
struct WGPU{{.Name | PascalCase}}{{$.ExtSuffix}};
{{- end}}
{{ end}}

{{- range $entry := .Enums}}
{{- MComment .Doc 0}}
typedef enum WGPU{{.Name | PascalCase}} {
{{- range $entryIndex, $_ := .Entries}}
{{- MComment .Doc 4}}
{{- $entryValue := 0}}
{{- if eq .Value ""}}
{{- $entryValue = $entryIndex}}
{{- else}}
{{- $entryValue = ParseUint .Value 16}}
{{- range $enum := .Enums}}
{{- if .Extended}}
{{- range $entryIndex, $_ := .Entries}}
__WGPU_EXTEND_ENUM(WGPU{{$enum.Name | PascalCase}}, WGPU{{$enum.Name | PascalCase}}_{{.Name | PascalCase}}{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}}, {{EnumValue $.EnumPrefix $enum $entryIndex}});
{{- end}}
{{- else}}
{{- MComment .Doc 0}}
typedef enum WGPU{{.Name | PascalCase}}{{$.ExtSuffix}} {
{{- range $entryIndex, $_ := .Entries}}
{{- MComment .Doc 4}}
WGPU{{$enum.Name | PascalCase}}_{{.Name | PascalCase}}{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}} = {{EnumValue $.EnumPrefix $enum $entryIndex}},
{{- end}}
WGPU{{$entry.Name | PascalCase}}_{{.Name | PascalCase}} = {{printf "%s%.4X," $.EnumPrefix $entryValue}}
WGPU{{$enum.Name | PascalCase}}_Force32{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}} = 0x7FFFFFFF
} WGPU{{$enum.Name | PascalCase}}{{$.ExtSuffix}} WGPU_ENUM_ATTRIBUTE;
{{- end}}
WGPU{{.Name | PascalCase}}_Force32 = 0x7FFFFFFF
} WGPU{{.Name | PascalCase}} WGPU_ENUM_ATTRIBUTE;
{{ end}}

{{- range $entry := .Bitflags}}
{{- MComment .Doc 0}}
typedef enum WGPU{{.Name | PascalCase}} {
{{- range $entryIndex, $_ := .Entries}}
{{- MComment .Doc 4}}
{{- $entryValue := ""}}
{{- $valueCombination := .ValueCombination}}
{{- range $valueIndex, $v := .ValueCombination}}
{{- $v = printf "WGPU%s_%s" ($entry.Name | PascalCase) ($v | PascalCase)}}
{{- if IsLast $valueIndex $valueCombination}}
{{- $entryValue = print $entryValue $v}}
{{- else}}
{{- $entryValue = print $entryValue $v " | "}}
{{- end}}
{{- else}}
{{- if eq .Value ""}}
{{- $entryValue = printf "0x%.8X" (BitFlagValue $entryIndex)}}
{{- else}}
{{- $entryValue = printf "0x%.8X" (ParseUint .Value 64)}}
{{- end}}
{{- range $bitflag := .Bitflags}}
{{- if .Extended}}
{{- range $entryIndex, $_ := .Entries}}
__WGPU_EXTEND_ENUM(WGPU{{$bitflag.Name | PascalCase}}, WGPU{{$bitflag.Name | PascalCase}}_{{.Name | PascalCase}}{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}}, {{BitflagValue $bitflag $entryIndex}});
{{- end}}
WGPU{{$entry.Name | PascalCase}}_{{.Name | PascalCase}} = {{$entryValue}},
{{- else}}
{{- MComment .Doc 0}}
typedef enum WGPU{{.Name | PascalCase}}{{$.ExtSuffix}} {
{{- range $entryIndex, $_ := .Entries}}
{{- MComment .Doc 4}}
WGPU{{$bitflag.Name | PascalCase}}_{{.Name | PascalCase}}{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}} = {{BitflagValue $bitflag $entryIndex}},
{{- end}}
WGPU{{$bitflag.Name | PascalCase}}_Force32{{if $.ExtSuffix}}_{{$.ExtSuffix}}{{end}} = 0x7FFFFFFF
} WGPU{{$bitflag.Name | PascalCase}}{{$.ExtSuffix}} WGPU_ENUM_ATTRIBUTE;
typedef WGPUFlags WGPU{{$bitflag.Name | PascalCase}}Flags{{$.ExtSuffix}} WGPU_ENUM_ATTRIBUTE;
{{- end}}
WGPU{{.Name | PascalCase}}_Force32 = 0x7FFFFFFF
} WGPU{{.Name | PascalCase}} WGPU_ENUM_ATTRIBUTE;
typedef WGPUFlags WGPU{{.Name | PascalCase}}Flags WGPU_ENUM_ATTRIBUTE;
{{ end}}

{{- if eq .Name "webgpu"}}
Expand All @@ -122,15 +122,15 @@ typedef void (*WGPUProc)(void) WGPU_FUNCTION_ATTRIBUTE;

{{- range .FunctionTypes}}
{{- MComment .Doc 0}}
typedef {{FunctionReturns .}} (*WGPU{{.Name | PascalCase}})({{FunctionArgs . nil}}) WGPU_FUNCTION_ATTRIBUTE;
typedef {{FunctionReturns .}} (*WGPU{{.Name | PascalCase}}{{$.ExtSuffix}})({{FunctionArgs . nil}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}

{{- if .Objects}}
{{ range $object := .Objects}}
{{- range $method := .Methods}}
{{- if .ReturnsAsync}}
{{- MComment .Doc 0}}
typedef void (*WGPU{{$object.Name | PascalCase}}{{$method.Name | PascalCase}}Callback)({{CallbackArgs .}}) WGPU_FUNCTION_ATTRIBUTE;
typedef void (*WGPU{{$object.Name | PascalCase}}{{$method.Name | PascalCase}}Callback{{$.ExtSuffix}})({{CallbackArgs .}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{- end}}
{{- end}}
Expand All @@ -148,9 +148,9 @@ typedef struct WGPUChainedStructOut {
} WGPUChainedStructOut WGPU_STRUCTURE_ATTRIBUTE;
{{ end}}

{{- range .Structs}}
{{- range $struct := .Structs}}
{{- MComment .Doc 0}}
typedef struct WGPU{{.Name | PascalCase}} {
typedef struct WGPU{{.Name | PascalCase}}{{$.ExtSuffix}} {
{{- if eq .Type "base_in" }}
WGPUChainedStruct const * nextInChain;
{{- else if eq .Type "base_out" }}
Expand All @@ -160,17 +160,10 @@ typedef struct WGPU{{.Name | PascalCase}} {
{{- else if eq .Type "extension_out"}}
WGPUChainedStructOut chain;
{{- end}}
{{- range .Members}}
{{- if IsArray .Type}}
size_t {{.Name | CamelCase | Singularize}}Count;
{{- MComment .Doc 4}}
{{ArrayType .Type .Pointer}} {{.Name | CamelCase}};
{{- else}}
{{- MComment .Doc 4}}
{{if .Optional}}WGPU_NULLABLE {{end}}{{CType .Type .Pointer}} {{.Name | CamelCase}};
{{- end}}
{{- range $memberIndex, $_ := .Members}}
{{ StructMember $struct $memberIndex}}
{{- end}}
} WGPU{{.Name | PascalCase}} WGPU_STRUCTURE_ATTRIBUTE;
} WGPU{{.Name | PascalCase}}{{$.ExtSuffix}} WGPU_STRUCTURE_ATTRIBUTE;
{{ end}}{{"\n" -}}

#ifdef __cplusplus
Expand All @@ -181,7 +174,7 @@ extern "C" {

{{- range .Functions}}
{{- MComment .Doc 0}}
typedef {{FunctionReturns .}} (*WGPUProc{{.Name | PascalCase}})({{FunctionArgs . nil}}) WGPU_FUNCTION_ATTRIBUTE;
typedef {{FunctionReturns .}} (*WGPUProc{{.Name | PascalCase}}{{$.ExtSuffix}})({{FunctionArgs . nil}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{- if eq .Name "webgpu"}}
typedef WGPUProc (*WGPUProcGetProcAddress)(WGPUDevice device, char const * procName) WGPU_FUNCTION_ATTRIBUTE;
Expand All @@ -191,11 +184,11 @@ typedef WGPUProc (*WGPUProcGetProcAddress)(WGPUDevice device, char const * procN
// Procs of {{$object.Name | PascalCase}}
{{- range $object.Methods}}
{{- MComment .Doc 0}}
typedef {{FunctionReturns .}} (*WGPUProc{{$object.Name | PascalCase}}{{.Name | PascalCase}})({{FunctionArgs . $object}}) WGPU_FUNCTION_ATTRIBUTE;
typedef {{FunctionReturns .}} (*WGPUProc{{$object.Name | PascalCase}}{{.Name | PascalCase}}{{$.ExtSuffix}})({{FunctionArgs . $object}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{- if not .IsStruct}}
typedef void (*WGPUProc{{.Name | PascalCase}}Reference)(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
typedef void (*WGPUProc{{.Name | PascalCase}}Release)(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
{{- if not (or .IsStruct .Extended)}}
typedef void (*WGPUProc{{.Name | PascalCase}}Reference{{$.ExtSuffix}})(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
typedef void (*WGPUProc{{.Name | PascalCase}}Release{{$.ExtSuffix}})(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{ end}}{{"\n" -}}

Expand All @@ -205,7 +198,7 @@ typedef void (*WGPUProc{{.Name | PascalCase}}Release)(WGPU{{.Name | PascalCase}}

{{- range .Functions}}
{{- MComment .Doc 0}}
WGPU_EXPORT {{FunctionReturns .}} wgpu{{.Name | PascalCase}}({{FunctionArgs . nil}}) WGPU_FUNCTION_ATTRIBUTE;
WGPU_EXPORT {{FunctionReturns .}} wgpu{{.Name | PascalCase}}{{$.ExtSuffix}}({{FunctionArgs . nil}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{- if eq .Name "webgpu"}}
WGPU_EXPORT WGPUProc wgpuGetProcAddress(WGPUDevice device, char const * procName) WGPU_FUNCTION_ATTRIBUTE;
Expand All @@ -215,11 +208,11 @@ WGPU_EXPORT WGPUProc wgpuGetProcAddress(WGPUDevice device, char const * procName
// Methods of {{$object.Name | PascalCase}}
{{- range $object.Methods}}
{{- MComment .Doc 0}}
WGPU_EXPORT {{FunctionReturns .}} wgpu{{$object.Name | PascalCase}}{{.Name | PascalCase}}({{FunctionArgs . $object}}) WGPU_FUNCTION_ATTRIBUTE;
WGPU_EXPORT {{FunctionReturns .}} wgpu{{$object.Name | PascalCase}}{{.Name | PascalCase}}{{$.ExtSuffix}}({{FunctionArgs . $object}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{- if not .IsStruct}}
WGPU_EXPORT void wgpu{{.Name | PascalCase}}Reference(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
WGPU_EXPORT void wgpu{{.Name | PascalCase}}Release(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
{{- if not (or .IsStruct .Extended)}}
WGPU_EXPORT void wgpu{{.Name | PascalCase}}Reference{{$.ExtSuffix}}(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
WGPU_EXPORT void wgpu{{.Name | PascalCase}}Release{{$.ExtSuffix}}(WGPU{{.Name | PascalCase}} {{.Name | CamelCase}}) WGPU_FUNCTION_ATTRIBUTE;
{{- end}}
{{ end}}{{"\n" -}}

Expand All @@ -229,4 +222,4 @@ WGPU_EXPORT void wgpu{{.Name | PascalCase}}Release(WGPU{{.Name | PascalCase}} {{
} // extern "C"
#endif

#endif // {{.Name | ConstantCase}}_H_
#endif // {{.HeaderName | ConstantCase}}_H_
Loading
Loading