15 Commits

Author SHA1 Message Date
Robin Voetter
34d30d0e64 Vulkan 1.2.175 compatibility 2021-04-13 19:52:30 +02:00
Robin Voetter
efb63a5cac Stop fixing up bitmasks.
This seems to not be required anymore.
2021-04-08 13:06:22 +02:00
Robin Voetter
fb5ca7cf90 Stop fixing up tags.
This seems to not be needed anymore.
2021-04-08 13:06:11 +02:00
Robin Voetter
272c1160eb Stop filtering out promoted extensions (Fixes #10)
This seems to not be needed anymore.
2021-04-08 13:06:00 +02:00
Robin Voetter
2064c912aa Allow F as floating-point suffix 2021-04-07 21:36:28 +02:00
Robin Voetter
954ca65ed9 Fix parse error 2021-04-07 21:36:17 +02:00
Robin Voetter
9321da3426 CI: Split out build & fetch vk.xml steps 2021-04-07 21:36:07 +02:00
Robin Voetter
bda8c7213a Vulkan 1.2.170 compatibility 2021-04-07 21:35:25 +02:00
Robin Voetter
9aae495eab Use linkLibC instead of linkSystemLibrary to link libc 2021-04-07 21:35:16 +02:00
Robin Voetter
01a64c1f9c Clarify on compatible zig versions (#8) 2021-02-10 00:07:10 +01:00
Robin Voetter
ffb9e9ff3e Remove some old code 2021-02-10 00:07:04 +01:00
Robin Voetter
8e48a8aa03 Allow top level comments in xml parser 2021-02-10 00:06:57 +01:00
Robin Voetter
50177211cb Small styling fix 2021-02-10 00:06:50 +01:00
Robin Voetter
9eac24ee39 Make API-enums non-exhaustive
The Vulkan implementation is not required to
filter enums on values supported by the requested
API, and so may return values that the
implementation doesn't know about. By making
these enums non-exhaustive, the programmer is
forced to deal with these kinds of cases
appropriately.
2021-02-10 00:06:41 +01:00
Robin Voetter
2cb1fcc354 Generate fully qualified alias enum variants 2021-02-10 00:06:31 +01:00
19 changed files with 1153 additions and 2302 deletions

View File

@@ -2,9 +2,9 @@ name: Build
on: on:
push: push:
branches: [ zig-0.8.0-compat ] branches: [ master ]
pull_request: pull_request:
branches: [ zig-0.8.0-compat ] branches: [ master ]
schedule: schedule:
- cron: '0 6 * * *' - cron: '0 6 * * *'
@@ -18,7 +18,7 @@ jobs:
- name: Setup Zig - name: Setup Zig
uses: goto-bus-stop/setup-zig@v1.3.0 uses: goto-bus-stop/setup-zig@v1.3.0
with: with:
version: 0.8.0 version: master
- name: Test - name: Test
run: | run: |
@@ -27,7 +27,7 @@ jobs:
- name: Fetch Vulkan SDK - name: Fetch Vulkan SDK
run: | run: |
wget -qO - https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add - wget -qO - https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add -
sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.2.176-focal.list https://packages.lunarg.com/vulkan/1.2.176/lunarg-vulkan-1.2.176-focal.list sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.2.162-focal.list https://packages.lunarg.com/vulkan/1.2.162/lunarg-vulkan-1.2.162-focal.list
sudo apt update sudo apt update
sudo apt install shaderc libglfw3 libglfw3-dev sudo apt install shaderc libglfw3 libglfw3-dev
@@ -38,9 +38,3 @@ jobs:
- name: Build with latest zig & vk.xml - name: Build with latest zig & vk.xml
run: | run: |
zig build -Dvulkan-registry=./vk.xml zig build -Dvulkan-registry=./vk.xml
- name: Archive vk.xml
uses: actions/upload-artifact@v2
with:
name: vk.zig
path: zig-cache/vk.zig

1
.gitignore vendored
View File

@@ -1,2 +1 @@
zig-cache/ zig-cache/
zig-out/

View File

@@ -12,7 +12,7 @@ vulkan-zig is automatically tested daily against the latest vk.xml and zig, and
### Zig versions ### Zig versions
vulkan-zig aims to be always compatible with the ever-changing Zig master branch (however, development may lag a few days behind). Sometimes, the Zig master branch breaks a bunch of functionality however, which may make the latest version vulkan-zig incompatible with older releases of Zig. This repository aims to have a version compatible for both the latest Zig master, and the latest Zig release. The `master` branch is compatible with the `master` branch of Zig, and versions for older versions of Zig are maintained in the `zig-<version>-compat` branch. vulkan-zig aims to be always compatible with the ever-changing Zig master branch (however, development may lag a few days behind). Sometimes, the Zig master branch breaks a bunch of functionality however, which may make the latest version vulkan-zig incompatible with older releases of Zig. Versions compatible with older versions of zig are marked with the tag `zig-<version>`.
## Features ## Features
### CLI-interface ### CLI-interface
@@ -67,22 +67,23 @@ For each function, a wrapper is generated into one of three structs:
* InstanceWrapper. This contains wrappers for functions which are otherwise loaded by `vkGetInstanceProcAddr`. * InstanceWrapper. This contains wrappers for functions which are otherwise loaded by `vkGetInstanceProcAddr`.
* DeviceWrapper. This contains wrappers for functions which are loaded by `vkGetDeviceProcAddr`. * DeviceWrapper. This contains wrappers for functions which are loaded by `vkGetDeviceProcAddr`.
Each wrapper struct can be called with an array of the appropriate enums: Each wrapper struct is to be used as a mixin on a struct containing **just** function pointers as members:
```zig ```zig
const vk = @import("vulkan"); const vk = @import("vulkan");
const BaseDispatch = vk.BaseWrapper(.{ const BaseDispatch = struct {
.CreateInstance, vkCreateInstance: vk.PfnCreateInstance,
}); usingnamespace vk.BaseWrapper(@This());
};
``` ```
The wrapper struct then provides wrapper functions for each function pointer in the dispatch struct: The wrapper struct then provides wrapper functions for each function pointer in the dispatch struct:
```zig ```zig
pub const BaseWrapper(comptime cmds: anytype) type { pub const BaseWrapper(comptime Self: type) type {
...
const Dispatch = CreateDispatchStruct(cmds);
return struct { return struct {
dispatch: Dispatch, pub fn createInstance(
self: Self,
pub const CreateInstanceError = error{ create_info: InstanceCreateInfo,
p_allocator: ?*const AllocationCallbacks,
) error{
OutOfHostMemory, OutOfHostMemory,
OutOfDeviceMemory, OutOfDeviceMemory,
InitializationFailed, InitializationFailed,
@@ -90,14 +91,9 @@ pub const BaseWrapper(comptime cmds: anytype) type {
ExtensionNotPresent, ExtensionNotPresent,
IncompatibleDriver, IncompatibleDriver,
Unknown, Unknown,
}; }!Instance {
pub fn createInstance(
self: Self,
create_info: InstanceCreateInfo,
p_allocator: ?*const AllocationCallbacks,
) CreateInstanceError!Instance {
var instance: Instance = undefined; var instance: Instance = undefined;
const result = self.dispatch.vkCreateInstance( const result = self.vkCreateInstance(
&create_info, &create_info,
p_allocator, p_allocator,
&instance, &instance,
@@ -129,11 +125,9 @@ Wrappers are generated according to the following rules:
* As of yet, there is no specific handling of enumeration style commands or other commands which accept slices. * As of yet, there is no specific handling of enumeration style commands or other commands which accept slices.
Furthermore, each wrapper contains a function to load each function pointer member when passed either `PfnGetInstanceProcAddr` or `PfnGetDeviceProcAddr`, which attempts to load each member as function pointer and casts it to the appropriate type. These functions are loaded literally, and any wrongly named member or member with a wrong function pointer type will result in problems. Furthermore, each wrapper contains a function to load each function pointer member when passed either `PfnGetInstanceProcAddr` or `PfnGetDeviceProcAddr`, which attempts to load each member as function pointer and casts it to the appropriate type. These functions are loaded literally, and any wrongly named member or member with a wrong function pointer type will result in problems.
* For `BaseWrapper`, this function has signature `fn load(loader: anytype) !Self`, where the type of `loader` must resemble `PfnGetInstanceProcAddr` (with optionally having a different calling convention). * For `BaseWrapper`, this function has signature `fn load(loader: PfnGetInstanceProcAddr) !Self`.
* For `InstanceWrapper`, this function has signature `fn load(instance: Instance, loader: anytype) !Self`, where the type of `loader` must resemble `PfnGetInstanceProcAddr`. * For `InstanceWrapper`, this function has signature `fn load(instance: Instance, loader: PfnGetInstanceProcAddr) !Self`.
* For `DeviceWrapper`, this function has signature `fn load(device: Device, loader: anytype) !Self`, where the type of `loader` must resemble `PfnGetDeviceProcAddr`. * For `DeviceWrapper`, this function has signature `fn load(device: Device, loader: PfnGetDeviceProcAddr) !Self`.
One can access the underlying unwrapped C functions by doing `wrapper.dispatch.vkFuncYouWant(..)`.
### Bitflags ### Bitflags
Packed structs of bools are used for bit flags in vulkan-zig, instead of both a `FlagBits` and `Flags` variant. Places where either of these variants are used are both replaced by this packed struct instead. This means that even in places where just one flag would normally be accepted, the packed struct is accepted. The programmer is responsible for only enabling a single bit. Packed structs of bools are used for bit flags in vulkan-zig, instead of both a `FlagBits` and `Flags` variant. Places where either of these variants are used are both replaced by this packed struct instead. This means that even in places where just one flag would normally be accepted, the packed struct is accepted. The programmer is responsible for only enabling a single bit.

View File

@@ -34,7 +34,7 @@ pub const ResourceGenStep = struct {
return self; return self;
} }
fn renderPath(path: []const u8, writer: anytype) void { fn renderPath(self: *ResourceGenStep, path: []const u8, writer: anytype) void {
const separators = &[_]u8{ std.fs.path.sep_windows, std.fs.path.sep_posix }; const separators = &[_]u8{ std.fs.path.sep_windows, std.fs.path.sep_posix };
var i: usize = 0; var i: usize = 0;
while (std.mem.indexOfAnyPos(u8, path, i, separators)) |j| { while (std.mem.indexOfAnyPos(u8, path, i, separators)) |j| {
@@ -42,7 +42,7 @@ pub const ResourceGenStep = struct {
switch (std.fs.path.sep) { switch (std.fs.path.sep) {
std.fs.path.sep_windows => writer.writeAll("\\\\") catch unreachable, std.fs.path.sep_windows => writer.writeAll("\\\\") catch unreachable,
std.fs.path.sep_posix => writer.writeByte(std.fs.path.sep_posix) catch unreachable, std.fs.path.sep_posix => writer.writeByte(std.fs.path.sep_posix) catch unreachable,
else => unreachable, else => unreachable
} }
i = j + 1; i = j + 1;
@@ -55,7 +55,7 @@ pub const ResourceGenStep = struct {
var writer = self.resources.writer(); var writer = self.resources.writer();
writer.print("pub const {s} = @embedFile(\"", .{ name }) catch unreachable; writer.print("pub const {s} = @embedFile(\"", .{ name }) catch unreachable;
renderPath(shader_out_path, writer); self.renderPath(shader_out_path, writer);
writer.writeAll("\");\n") catch unreachable; writer.writeAll("\");\n") catch unreachable;
} }

View File

@@ -3,80 +3,85 @@ const vk = @import("vulkan");
const c = @import("c.zig"); const c = @import("c.zig");
const Allocator = std.mem.Allocator; const Allocator = std.mem.Allocator;
const required_device_extensions = [_][]const u8{vk.extension_info.khr_swapchain.name}; const required_device_extensions = [_][]const u8{
vk.extension_info.khr_swapchain.name
};
const BaseDispatch = vk.BaseWrapper(.{ const BaseDispatch = struct {
.CreateInstance, vkCreateInstance: vk.PfnCreateInstance,
}); usingnamespace vk.BaseWrapper(@This());
};
const InstanceDispatch = vk.InstanceWrapper(.{ const InstanceDispatch = struct {
.DestroyInstance, vkDestroyInstance: vk.PfnDestroyInstance,
.CreateDevice, vkCreateDevice: vk.PfnCreateDevice,
.DestroySurfaceKHR, vkDestroySurfaceKHR: vk.PfnDestroySurfaceKHR,
.EnumeratePhysicalDevices, vkEnumeratePhysicalDevices: vk.PfnEnumeratePhysicalDevices,
.GetPhysicalDeviceProperties, vkGetPhysicalDeviceProperties: vk.PfnGetPhysicalDeviceProperties,
.EnumerateDeviceExtensionProperties, vkEnumerateDeviceExtensionProperties: vk.PfnEnumerateDeviceExtensionProperties,
.GetPhysicalDeviceSurfaceFormatsKHR, vkGetPhysicalDeviceSurfaceFormatsKHR: vk.PfnGetPhysicalDeviceSurfaceFormatsKHR,
.GetPhysicalDeviceSurfacePresentModesKHR, vkGetPhysicalDeviceSurfacePresentModesKHR: vk.PfnGetPhysicalDeviceSurfacePresentModesKHR,
.GetPhysicalDeviceSurfaceCapabilitiesKHR, vkGetPhysicalDeviceSurfaceCapabilitiesKHR: vk.PfnGetPhysicalDeviceSurfaceCapabilitiesKHR,
.GetPhysicalDeviceQueueFamilyProperties, vkGetPhysicalDeviceQueueFamilyProperties: vk.PfnGetPhysicalDeviceQueueFamilyProperties,
.GetPhysicalDeviceSurfaceSupportKHR, vkGetPhysicalDeviceSurfaceSupportKHR: vk.PfnGetPhysicalDeviceSurfaceSupportKHR,
.GetPhysicalDeviceMemoryProperties, vkGetPhysicalDeviceMemoryProperties: vk.PfnGetPhysicalDeviceMemoryProperties,
.GetDeviceProcAddr, vkGetDeviceProcAddr: vk.PfnGetDeviceProcAddr,
}); usingnamespace vk.InstanceWrapper(@This());
};
const DeviceDispatch = vk.DeviceWrapper(.{ const DeviceDispatch = struct {
.DestroyDevice, vkDestroyDevice: vk.PfnDestroyDevice,
.GetDeviceQueue, vkGetDeviceQueue: vk.PfnGetDeviceQueue,
.CreateSemaphore, vkCreateSemaphore: vk.PfnCreateSemaphore,
.CreateFence, vkCreateFence: vk.PfnCreateFence,
.CreateImageView, vkCreateImageView: vk.PfnCreateImageView,
.DestroyImageView, vkDestroyImageView: vk.PfnDestroyImageView,
.DestroySemaphore, vkDestroySemaphore: vk.PfnDestroySemaphore,
.DestroyFence, vkDestroyFence: vk.PfnDestroyFence,
.GetSwapchainImagesKHR, vkGetSwapchainImagesKHR: vk.PfnGetSwapchainImagesKHR,
.CreateSwapchainKHR, vkCreateSwapchainKHR: vk.PfnCreateSwapchainKHR,
.DestroySwapchainKHR, vkDestroySwapchainKHR: vk.PfnDestroySwapchainKHR,
.AcquireNextImageKHR, vkAcquireNextImageKHR: vk.PfnAcquireNextImageKHR,
.DeviceWaitIdle, vkDeviceWaitIdle: vk.PfnDeviceWaitIdle,
.WaitForFences, vkWaitForFences: vk.PfnWaitForFences,
.ResetFences, vkResetFences: vk.PfnResetFences,
.QueueSubmit, vkQueueSubmit: vk.PfnQueueSubmit,
.QueuePresentKHR, vkQueuePresentKHR: vk.PfnQueuePresentKHR,
.CreateCommandPool, vkCreateCommandPool: vk.PfnCreateCommandPool,
.DestroyCommandPool, vkDestroyCommandPool: vk.PfnDestroyCommandPool,
.AllocateCommandBuffers, vkAllocateCommandBuffers: vk.PfnAllocateCommandBuffers,
.FreeCommandBuffers, vkFreeCommandBuffers: vk.PfnFreeCommandBuffers,
.QueueWaitIdle, vkQueueWaitIdle: vk.PfnQueueWaitIdle,
.CreateShaderModule, vkCreateShaderModule: vk.PfnCreateShaderModule,
.DestroyShaderModule, vkDestroyShaderModule: vk.PfnDestroyShaderModule,
.CreatePipelineLayout, vkCreatePipelineLayout: vk.PfnCreatePipelineLayout,
.DestroyPipelineLayout, vkDestroyPipelineLayout: vk.PfnDestroyPipelineLayout,
.CreateRenderPass, vkCreateRenderPass: vk.PfnCreateRenderPass,
.DestroyRenderPass, vkDestroyRenderPass: vk.PfnDestroyRenderPass,
.CreateGraphicsPipelines, vkCreateGraphicsPipelines: vk.PfnCreateGraphicsPipelines,
.DestroyPipeline, vkDestroyPipeline: vk.PfnDestroyPipeline,
.CreateFramebuffer, vkCreateFramebuffer: vk.PfnCreateFramebuffer,
.DestroyFramebuffer, vkDestroyFramebuffer: vk.PfnDestroyFramebuffer,
.BeginCommandBuffer, vkBeginCommandBuffer: vk.PfnBeginCommandBuffer,
.EndCommandBuffer, vkEndCommandBuffer: vk.PfnEndCommandBuffer,
.AllocateMemory, vkAllocateMemory: vk.PfnAllocateMemory,
.FreeMemory, vkFreeMemory: vk.PfnFreeMemory,
.CreateBuffer, vkCreateBuffer: vk.PfnCreateBuffer,
.DestroyBuffer, vkDestroyBuffer: vk.PfnDestroyBuffer,
.GetBufferMemoryRequirements, vkGetBufferMemoryRequirements: vk.PfnGetBufferMemoryRequirements,
.MapMemory, vkMapMemory: vk.PfnMapMemory,
.UnmapMemory, vkUnmapMemory: vk.PfnUnmapMemory,
.BindBufferMemory, vkBindBufferMemory: vk.PfnBindBufferMemory,
.CmdBeginRenderPass, vkCmdBeginRenderPass: vk.PfnCmdBeginRenderPass,
.CmdEndRenderPass, vkCmdEndRenderPass: vk.PfnCmdEndRenderPass,
.CmdBindPipeline, vkCmdBindPipeline: vk.PfnCmdBindPipeline,
.CmdDraw, vkCmdDraw: vk.PfnCmdDraw,
.CmdSetViewport, vkCmdSetViewport: vk.PfnCmdSetViewport,
.CmdSetScissor, vkCmdSetScissor: vk.PfnCmdSetScissor,
.CmdBindVertexBuffers, vkCmdBindVertexBuffers: vk.PfnCmdBindVertexBuffers,
.CmdCopyBuffer, vkCmdCopyBuffer: vk.PfnCmdCopyBuffer,
}); usingnamespace vk.DeviceWrapper(@This());
};
pub const GraphicsContext = struct { pub const GraphicsContext = struct {
vkb: BaseDispatch, vkb: BaseDispatch,
@@ -120,14 +125,14 @@ pub const GraphicsContext = struct {
self.vki = try InstanceDispatch.load(self.instance, c.glfwGetInstanceProcAddress); self.vki = try InstanceDispatch.load(self.instance, c.glfwGetInstanceProcAddress);
errdefer self.vki.destroyInstance(self.instance, null); errdefer self.vki.destroyInstance(self.instance, null);
self.surface = try createSurface(self.instance, window); self.surface = try createSurface(self.vki, self.instance, window);
errdefer self.vki.destroySurfaceKHR(self.instance, self.surface, null); errdefer self.vki.destroySurfaceKHR(self.instance, self.surface, null);
const candidate = try pickPhysicalDevice(self.vki, self.instance, allocator, self.surface); const candidate = try pickPhysicalDevice(self.vki, self.instance, allocator, self.surface);
self.pdev = candidate.pdev; self.pdev = candidate.pdev;
self.props = candidate.props; self.props = candidate.props;
self.dev = try initializeCandidate(self.vki, candidate); self.dev = try initializeCandidate(self.vki, candidate);
self.vkd = try DeviceDispatch.load(self.dev, self.vki.dispatch.vkGetDeviceProcAddr); self.vkd = try DeviceDispatch.load(self.dev, self.vki.vkGetDeviceProcAddr);
errdefer self.vkd.destroyDevice(self.dev, null); errdefer self.vkd.destroyDevice(self.dev, null);
self.graphics_queue = Queue.init(self.vkd, self.dev, candidate.queues.graphics_family); self.graphics_queue = Queue.init(self.vkd, self.dev, candidate.queues.graphics_family);
@@ -179,7 +184,7 @@ pub const Queue = struct {
} }
}; };
fn createSurface(instance: vk.Instance, window: *c.GLFWwindow) !vk.SurfaceKHR { fn createSurface(vki: InstanceDispatch, instance: vk.Instance, window: *c.GLFWwindow) !vk.SurfaceKHR {
var surface: vk.SurfaceKHR = undefined; var surface: vk.SurfaceKHR = undefined;
if (c.glfwCreateWindowSurface(instance, window, null, &surface) != .success) { if (c.glfwCreateWindowSurface(instance, window, null, &surface) != .success) {
return error.SurfaceInitFailed; return error.SurfaceInitFailed;
@@ -202,7 +207,7 @@ fn initializeCandidate(vki: InstanceDispatch, candidate: DeviceCandidate) !vk.De
.queue_family_index = candidate.queues.present_family, .queue_family_index = candidate.queues.present_family,
.queue_count = 1, .queue_count = 1,
.p_queue_priorities = &priority, .p_queue_priorities = &priority,
}, }
}; };
const queue_count: u32 = if (candidate.queues.graphics_family == candidate.queues.present_family) const queue_count: u32 = if (candidate.queues.graphics_family == candidate.queues.present_family)
@@ -276,14 +281,19 @@ fn checkSuitable(
return DeviceCandidate{ return DeviceCandidate{
.pdev = pdev, .pdev = pdev,
.props = props, .props = props,
.queues = allocation, .queues = allocation
}; };
} }
return null; return null;
} }
fn allocateQueues(vki: InstanceDispatch, pdev: vk.PhysicalDevice, allocator: *Allocator, surface: vk.SurfaceKHR) !?QueueAllocation { fn allocateQueues(
vki: InstanceDispatch,
pdev: vk.PhysicalDevice,
allocator: *Allocator,
surface: vk.SurfaceKHR
) !?QueueAllocation {
var family_count: u32 = undefined; var family_count: u32 = undefined;
vki.getPhysicalDeviceQueueFamilyProperties(pdev, &family_count, null); vki.getPhysicalDeviceQueueFamilyProperties(pdev, &family_count, null);
@@ -297,7 +307,7 @@ fn allocateQueues(vki: InstanceDispatch, pdev: vk.PhysicalDevice, allocator: *Al
for (families) |properties, i| { for (families) |properties, i| {
const family = @intCast(u32, i); const family = @intCast(u32, i);
if (graphics_family == null and properties.queue_flags.graphics_bit) { if (graphics_family == null and properties.queue_flags.contains(.{.graphics_bit = true})) {
graphics_family = family; graphics_family = family;
} }
@@ -309,7 +319,7 @@ fn allocateQueues(vki: InstanceDispatch, pdev: vk.PhysicalDevice, allocator: *Al
if (graphics_family != null and present_family != null) { if (graphics_family != null and present_family != null) {
return QueueAllocation{ return QueueAllocation{
.graphics_family = graphics_family.?, .graphics_family = graphics_family.?,
.present_family = present_family.?, .present_family = present_family.?
}; };
} }

View File

@@ -52,7 +52,7 @@ pub fn main() !void {
@intCast(c_int, extent.height), @intCast(c_int, extent.height),
app_name, app_name,
null, null,
null, null
) orelse return error.WindowInitFailed; ) orelse return error.WindowInitFailed;
defer c.glfwDestroyWindow(window); defer c.glfwDestroyWindow(window);
@@ -78,7 +78,7 @@ pub fn main() !void {
const render_pass = try createRenderPass(&gc, swapchain); const render_pass = try createRenderPass(&gc, swapchain);
defer gc.vkd.destroyRenderPass(gc.dev, render_pass, null); defer gc.vkd.destroyRenderPass(gc.dev, render_pass, null);
var pipeline = try createPipeline(&gc, pipeline_layout, render_pass); var pipeline = try createPipeline(&gc, extent, pipeline_layout, render_pass);
defer gc.vkd.destroyPipeline(gc.dev, pipeline, null); defer gc.vkd.destroyPipeline(gc.dev, pipeline, null);
var framebuffers = try createFramebuffers(&gc, allocator, render_pass, swapchain); var framebuffers = try createFramebuffers(&gc, allocator, render_pass, swapchain);
@@ -104,7 +104,7 @@ pub fn main() !void {
defer gc.vkd.freeMemory(gc.dev, memory, null); defer gc.vkd.freeMemory(gc.dev, memory, null);
try gc.vkd.bindBufferMemory(gc.dev, buffer, memory, 0); try gc.vkd.bindBufferMemory(gc.dev, buffer, memory, 0);
try uploadVertices(&gc, pool, buffer); try uploadVertices(&gc, pool, buffer, memory);
var cmdbufs = try createCommandBuffers( var cmdbufs = try createCommandBuffers(
&gc, &gc,
@@ -114,7 +114,7 @@ pub fn main() !void {
swapchain.extent, swapchain.extent,
render_pass, render_pass,
pipeline, pipeline,
framebuffers, framebuffers
); );
defer destroyCommandBuffers(&gc, pool, allocator, cmdbufs); defer destroyCommandBuffers(&gc, pool, allocator, cmdbufs);
@@ -146,18 +146,19 @@ pub fn main() !void {
swapchain.extent, swapchain.extent,
render_pass, render_pass,
pipeline, pipeline,
framebuffers, framebuffers
); );
} }
c.glfwSwapBuffers(window); c.glfwSwapBuffers(window);
c.glfwPollEvents(); c.glfwPollEvents();
} }
try swapchain.waitForAllFences(); try swapchain.waitForAllFences();
} }
fn uploadVertices(gc: *const GraphicsContext, pool: vk.CommandPool, buffer: vk.Buffer) !void { fn uploadVertices(gc: *const GraphicsContext, pool: vk.CommandPool, buffer: vk.Buffer, memory: vk.DeviceMemory) !void {
const staging_buffer = try gc.vkd.createBuffer(gc.dev, .{ const staging_buffer = try gc.vkd.createBuffer(gc.dev, .{
.flags = .{}, .flags = .{},
.size = @sizeOf(@TypeOf(vertices)), .size = @sizeOf(@TypeOf(vertices)),
@@ -296,7 +297,12 @@ fn destroyCommandBuffers(gc: *const GraphicsContext, pool: vk.CommandPool, alloc
allocator.free(cmdbufs); allocator.free(cmdbufs);
} }
fn createFramebuffers(gc: *const GraphicsContext, allocator: *Allocator, render_pass: vk.RenderPass, swapchain: Swapchain) ![]vk.Framebuffer { fn createFramebuffers(
gc: *const GraphicsContext,
allocator: *Allocator,
render_pass: vk.RenderPass,
swapchain: Swapchain
) ![]vk.Framebuffer {
const framebuffers = try allocator.alloc(vk.Framebuffer, swapchain.swap_images.len); const framebuffers = try allocator.alloc(vk.Framebuffer, swapchain.swap_images.len);
errdefer allocator.free(framebuffers); errdefer allocator.free(framebuffers);
@@ -368,6 +374,7 @@ fn createRenderPass(gc: *const GraphicsContext, swapchain: Swapchain) !vk.Render
fn createPipeline( fn createPipeline(
gc: *const GraphicsContext, gc: *const GraphicsContext,
extent: vk.Extent2D,
layout: vk.PipelineLayout, layout: vk.PipelineLayout,
render_pass: vk.RenderPass, render_pass: vk.RenderPass,
) !vk.Pipeline { ) !vk.Pipeline {
@@ -499,8 +506,7 @@ fn createPipeline(
_ = try gc.vkd.createGraphicsPipelines( _ = try gc.vkd.createGraphicsPipelines(
gc.dev, gc.dev,
.null_handle, .null_handle,
1, 1, @ptrCast([*]const vk.GraphicsPipelineCreateInfo, &gpci),
@ptrCast([*]const vk.GraphicsPipelineCreateInfo, &gpci),
null, null,
@ptrCast([*]vk.Pipeline, &pipeline), @ptrCast([*]vk.Pipeline, &pipeline),
); );

File diff suppressed because it is too large Load Diff

View File

@@ -2,64 +2,6 @@ const std = @import("std");
const mem = std.mem; const mem = std.mem;
const Allocator = mem.Allocator; const Allocator = mem.Allocator;
pub fn isZigPrimitiveType(name: []const u8) bool {
if (name.len > 1 and (name[0] == 'u' or name[0] == 'i')) {
for (name[1..]) |c| {
switch (c) {
'0'...'9' => {},
else => return false,
}
}
return true;
}
const primitives = [_][]const u8{
"void",
"comptime_float",
"comptime_int",
"bool",
"isize",
"usize",
"f16",
"f32",
"f64",
"f128",
"c_longdouble",
"noreturn",
"type",
"anyerror",
"c_short",
"c_ushort",
"c_int",
"c_uint",
"c_long",
"c_ulong",
"c_longlong",
"c_ulonglong",
};
for (primitives) |reserved| {
if (mem.eql(u8, reserved, name)) {
return true;
}
}
return false;
}
fn needZigEscape(name: []const u8) bool {
return !std.zig.fmt.isValidId(name) or isZigPrimitiveType(name);
}
pub fn writeIdentifier(out: anytype, id: []const u8) !void {
// https://github.com/ziglang/zig/issues/2897
if (isZigPrimitiveType(id)) {
try out.print("{s}_", .{id});
} else {
try out.print("{}", .{std.zig.fmtId(id)});
}
}
pub const CaseStyle = enum { pub const CaseStyle = enum {
snake, snake,
screaming_snake, screaming_snake,
@@ -196,10 +138,14 @@ pub const IdRenderer = struct {
} }
} }
pub fn render(self: IdRenderer, out: anytype, id: []const u8) !void {
try out.print("{z}", .{ id });
}
pub fn renderFmt(self: *IdRenderer, out: anytype, comptime fmt: []const u8, args: anytype) !void { pub fn renderFmt(self: *IdRenderer, out: anytype, comptime fmt: []const u8, args: anytype) !void {
self.text_cache.items.len = 0; self.text_cache.items.len = 0;
try std.fmt.format(self.text_cache.writer(), fmt, args); try std.fmt.format(self.text_cache.writer(), fmt, args);
try writeIdentifier(out, self.text_cache.items); try out.print("{z}", .{ self.text_cache.items });
} }
pub fn renderWithCase(self: *IdRenderer, out: anytype, case_style: CaseStyle, id: []const u8) !void { pub fn renderWithCase(self: *IdRenderer, out: anytype, case_style: CaseStyle, id: []const u8) !void {
@@ -216,7 +162,7 @@ pub const IdRenderer = struct {
.camel => try self.renderCamel(false, adjusted_id, tag), .camel => try self.renderCamel(false, adjusted_id, tag),
} }
try writeIdentifier(out, self.text_cache.items); try out.print("{z}", .{ self.text_cache.items });
} }
pub fn getAuthorTag(self: IdRenderer, id: []const u8) ?[]const u8 { pub fn getAuthorTag(self: IdRenderer, id: []const u8) ?[]const u8 {

View File

@@ -1,5 +1,6 @@
pub const generateVk = @import("vulkan/generator.zig").generate; pub const generateVk = @import("vulkan/generator.zig").generate;
pub const VkGenerateStep = @import("vulkan/build_integration.zig").GenerateStep; pub const VkGenerateStep = @import("vulkan/build_integration.zig").GenerateStep;
pub const generateSpirv = @import("spirv/generator.zig").generate;
pub const ShaderCompileStep = @import("build_integration.zig").ShaderCompileStep; pub const ShaderCompileStep = @import("build_integration.zig").ShaderCompileStep;
test "main" { test "main" {

View File

@@ -5,6 +5,7 @@ const usage = "Usage: {s} [-h|--help] <spec xml path> <output zig source>\n";
pub fn main() !void { pub fn main() !void {
const stderr = std.io.getStdErr(); const stderr = std.io.getStdErr();
const stdout = std.io.getStdOut();
var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator); var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
defer arena.deinit(); defer arena.deinit();
@@ -59,22 +60,15 @@ pub fn main() !void {
return; return;
}; };
const out_file = cwd.createFile(out_path, .{}) catch |err| {
try stderr.writer().print("Error: Failed to create output file '{s}' ({s})\n", .{ out_path, @errorName(err) });
return;
};
defer out_file.close();
var out_buffer = std.ArrayList(u8).init(allocator); var out_buffer = std.ArrayList(u8).init(allocator);
try generate(allocator, xml_src, out_buffer.writer()); try generate(allocator, xml_src, out_buffer.writer());
const tree = try std.zig.parse(allocator, out_buffer.items); const tree = try std.zig.parse(allocator, out_buffer.items);
const formatted = try tree.render(allocator);
defer allocator.free(formatted);
if (std.fs.path.dirname(out_path)) |dir| { _ = try std.zig.render(allocator, out_file.writer(), tree);
cwd.makePath(dir) catch |err| {
try stderr.writer().print("Error: Failed to create output directory '{s}' ({s})\n", .{ dir, @errorName(err) });
return;
};
}
cwd.writeFile(out_path, formatted) catch |err| {
try stderr.writer().print("Error: Failed to write to output file '{s}' ({s})\n", .{ out_path, @errorName(err) });
return;
};
} }

View File

@@ -65,18 +65,16 @@ pub const GenerateStep = struct {
fn make(step: *Step) !void { fn make(step: *Step) !void {
const self = @fieldParentPtr(GenerateStep, "step", step); const self = @fieldParentPtr(GenerateStep, "step", step);
const cwd = std.fs.cwd(); const cwd = std.fs.cwd();
const spec = try cwd.readFileAlloc(self.builder.allocator, self.spec_path, std.math.maxInt(usize));
var out_buffer = std.ArrayList(u8).init(self.builder.allocator); var out_buffer = std.ArrayList(u8).init(self.builder.allocator);
const spec = try cwd.readFileAlloc(self.builder.allocator, self.spec_path, std.math.maxInt(usize));
try generate(self.builder.allocator, spec, out_buffer.writer()); try generate(self.builder.allocator, spec, out_buffer.writer());
const tree = try std.zig.parse(self.builder.allocator, out_buffer.items); const tree = try std.zig.parse(self.builder.allocator, out_buffer.items);
var formatted = try tree.render(self.builder.allocator);
const dir = path.dirname(self.package.path).?; const dir = path.dirname(self.package.path).?;
try cwd.makePath(dir); try cwd.makePath(dir);
try cwd.writeFile(self.package.path, formatted); const output_file = cwd.createFile(self.package.path, .{}) catch unreachable;
defer output_file.close();
_ = try std.zig.render(self.builder.allocator, output_file.writer(), tree);
} }
}; };

View File

@@ -143,12 +143,15 @@ pub const CTokenizer = struct {
']' => kind = .rbracket, ']' => kind = .rbracket,
'(' => kind = .lparen, '(' => kind = .lparen,
')' => kind = .rparen, ')' => kind = .rparen,
else => return error.UnexpectedCharacter, else => return error.UnexpectedCharacter
} }
const start = self.offset; const start = self.offset;
_ = self.consumeNoEof(); _ = self.consumeNoEof();
return Token{ .kind = kind, .text = self.source[start..self.offset] }; return Token{
.kind = kind,
.text = self.source[start .. self.offset]
};
} }
}; };
@@ -362,7 +365,7 @@ fn parseDeclaration(allocator: *Allocator, xctok: *XmlCTokenizer) ParseError!Dec
.array = .{ .array = .{
.size = array_size, .size = array_size,
.child = child, .child = child,
}, }
}; };
// update the inner_type pointer so it points to the proper // update the inner_type pointer so it points to the proper
@@ -400,8 +403,8 @@ fn parseFnPtrSuffix(allocator: *Allocator, xctok: *XmlCTokenizer, return_type: T
.return_type = return_type_heap, .return_type = return_type_heap,
.success_codes = &[_][]const u8{}, .success_codes = &[_][]const u8{},
.error_codes = &[_][]const u8{}, .error_codes = &[_][]const u8{},
}, }
}, }
}; };
const first_param = try parseDeclaration(allocator, xctok); const first_param = try parseDeclaration(allocator, xctok);
@@ -497,10 +500,10 @@ fn parseArrayDeclarator(xctok: *XmlCTokenizer) !?ArraySize {
.int = std.fmt.parseInt(usize, size_tok.text, 10) catch |err| switch (err) { .int = std.fmt.parseInt(usize, size_tok.text, 10) catch |err| switch (err) {
error.Overflow => return error.Overflow, error.Overflow => return error.Overflow,
error.InvalidCharacter => unreachable, error.InvalidCharacter => unreachable,
}, }
}, },
.enum_name => .{.alias = size_tok.text}, .enum_name => .{.alias = size_tok.text},
else => return error.InvalidSyntax, else => return error.InvalidSyntax
}; };
_ = try xctok.expect(.rbracket); _ = try xctok.expect(.rbracket);
@@ -514,7 +517,7 @@ pub fn parseVersion(xctok: *XmlCTokenizer) ![4][]const u8 {
return error.InvalidVersion; return error.InvalidVersion;
} }
_ = try xctok.expect(.name); const name = try xctok.expect(.name);
const vk_make_version = try xctok.expect(.type_name); const vk_make_version = try xctok.expect(.type_name);
if (!mem.eql(u8, vk_make_version.text, "VK_MAKE_API_VERSION")) { if (!mem.eql(u8, vk_make_version.text, "VK_MAKE_API_VERSION")) {
return error.NotVersion; return error.NotVersion;
@@ -537,20 +540,24 @@ pub fn parseVersion(xctok: *XmlCTokenizer) ![4][]const u8 {
return version; return version;
} }
fn testTokenizer(tokenizer: anytype, expected_tokens: []const Token) !void { fn testTokenizer(tokenizer: anytype, expected_tokens: []const Token) void {
for (expected_tokens) |expected| { for (expected_tokens) |expected| {
const tok = (tokenizer.next() catch unreachable).?; const tok = (tokenizer.next() catch unreachable).?;
try testing.expectEqual(expected.kind, tok.kind); testing.expectEqual(expected.kind, tok.kind);
try testing.expectEqualSlices(u8, expected.text, tok.text); testing.expectEqualSlices(u8, expected.text, tok.text);
} }
if (tokenizer.next() catch unreachable) |_| unreachable; if (tokenizer.next() catch unreachable) |_| unreachable;
} }
test "CTokenizer" { test "CTokenizer" {
var ctok = CTokenizer{ .source = "typedef ([const)]** VKAPI_PTR 123,;aaaa" }; var ctok = CTokenizer {
.source = \\typedef ([const)]** VKAPI_PTR 123,;aaaa
};
try testTokenizer(&ctok, &[_]Token{ testTokenizer(
&ctok,
&[_]Token{
.{.kind = .kw_typedef, .text = "typedef"}, .{.kind = .kw_typedef, .text = "typedef"},
.{.kind = .lparen, .text = "("}, .{.kind = .lparen, .text = "("},
.{.kind = .lbracket, .text = "["}, .{.kind = .lbracket, .text = "["},
@@ -564,11 +571,13 @@ test "CTokenizer" {
.{.kind = .comma, .text = ","}, .{.kind = .comma, .text = ","},
.{.kind = .semicolon, .text = ";"}, .{.kind = .semicolon, .text = ";"},
.{.kind = .id, .text = "aaaa"}, .{.kind = .id, .text = "aaaa"},
}); }
);
} }
test "XmlCTokenizer" { test "XmlCTokenizer" {
const document = try xml.parse(testing.allocator, const document = try xml.parse(
testing.allocator,
\\<root>// comment <name>commented name</name> <type>commented type</type> trailing \\<root>// comment <name>commented name</name> <type>commented type</type> trailing
\\ typedef void (VKAPI_PTR *<name>PFN_vkVoidFunction</name>)(void); \\ typedef void (VKAPI_PTR *<name>PFN_vkVoidFunction</name>)(void);
\\</root> \\</root>
@@ -577,7 +586,9 @@ test "XmlCTokenizer" {
var xctok = XmlCTokenizer.init(document.root); var xctok = XmlCTokenizer.init(document.root);
try testTokenizer(&xctok, &[_]Token{ testTokenizer(
&xctok,
&[_]Token{
.{.kind = .kw_typedef, .text = "typedef"}, .{.kind = .kw_typedef, .text = "typedef"},
.{.kind = .id, .text = "void"}, .{.kind = .id, .text = "void"},
.{.kind = .lparen, .text = "("}, .{.kind = .lparen, .text = "("},
@@ -589,11 +600,13 @@ test "XmlCTokenizer" {
.{.kind = .id, .text = "void"}, .{.kind = .id, .text = "void"},
.{.kind = .rparen, .text = ")"}, .{.kind = .rparen, .text = ")"},
.{.kind = .semicolon, .text = ";"}, .{.kind = .semicolon, .text = ";"},
}); }
);
} }
test "parseTypedef" { test "parseTypedef" {
const document = try xml.parse(testing.allocator, const document = try xml.parse(
testing.allocator,
\\<root> // comment <name>commented name</name> trailing \\<root> // comment <name>commented name</name> trailing
\\ typedef const struct <type>Python</type>* pythons[4]; \\ typedef const struct <type>Python</type>* pythons[4];
\\ // more comments \\ // more comments
@@ -608,10 +621,10 @@ test "parseTypedef" {
var xctok = XmlCTokenizer.init(document.root); var xctok = XmlCTokenizer.init(document.root);
const decl = try parseTypedef(&arena.allocator, &xctok); const decl = try parseTypedef(&arena.allocator, &xctok);
try testing.expectEqualSlices(u8, "pythons", decl.name); testing.expectEqualSlices(u8, "pythons", decl.name);
const array = decl.decl_type.typedef.array; const array = decl.decl_type.typedef.array;
try testing.expectEqual(ArraySize{ .int = 4 }, array.size); testing.expectEqual(ArraySize{.int = 4}, array.size);
const ptr = array.child.pointer; const ptr = array.child.pointer;
try testing.expectEqual(true, ptr.is_const); testing.expectEqual(true, ptr.is_const);
try testing.expectEqualSlices(u8, "Python", ptr.child.name); testing.expectEqualSlices(u8, "Python", ptr.child.name);
} }

View File

@@ -29,8 +29,8 @@ const EnumFieldMerger = struct {
} }
fn deinit(self: *EnumFieldMerger) void { fn deinit(self: *EnumFieldMerger) void {
for (self.enum_extensions.values()) |*value| { for (self.enum_extensions.items()) |*entry| {
value.deinit(self.gpa); entry.value.deinit(self.gpa);
} }
self.field_set.deinit(); self.field_set.deinit();
@@ -40,10 +40,10 @@ const EnumFieldMerger = struct {
fn putEnumExtension(self: *EnumFieldMerger, enum_name: []const u8, field: reg.Enum.Field) !void { fn putEnumExtension(self: *EnumFieldMerger, enum_name: []const u8, field: reg.Enum.Field) !void {
const res = try self.enum_extensions.getOrPut(enum_name); const res = try self.enum_extensions.getOrPut(enum_name);
if (!res.found_existing) { if (!res.found_existing) {
res.value_ptr.* = std.ArrayListUnmanaged(reg.Enum.Field){}; res.entry.value = std.ArrayListUnmanaged(reg.Enum.Field){};
} }
try res.value_ptr.append(self.gpa, field); try res.entry.value.append(self.gpa, field);
} }
fn addRequires(self: *EnumFieldMerger, reqs: []const reg.Require) !void { fn addRequires(self: *EnumFieldMerger, reqs: []const reg.Require) !void {
@@ -147,37 +147,10 @@ pub const Generator = struct {
try merger.merge(); try merger.merge();
} }
// https://github.com/KhronosGroup/Vulkan-Docs/pull/1556 fn fixupTags(self: *Generator) !void {
fn fixupBitFlags(self: *Generator) !void { var fixer_upper = TagFixerUpper.init(self.gpa, &self.registry, &self.id_renderer);
var seen_bits = std.StringArrayHashMap(void).init(&self.reg_arena.allocator); defer fixer_upper.deinit();
defer seen_bits.deinit(); try fixer_upper.fixup();
for (self.registry.decls) |decl| {
const bitmask = switch (decl.decl_type) {
.bitmask => |bm| bm,
else => continue,
};
if (bitmask.bits_enum) |bits_enum| {
try seen_bits.put(bits_enum, {});
}
}
var i: usize = 0;
for (self.registry.decls) |decl| {
switch (decl.decl_type) {
.enumeration => |e| {
if (e.is_bitmask and seen_bits.get(decl.name) == null)
continue;
},
else => {},
}
self.registry.decls[i] = decl;
i += 1;
}
self.registry.decls.len = i;
} }
fn render(self: *Generator, writer: anytype) !void { fn render(self: *Generator, writer: anytype) !void {
@@ -197,6 +170,5 @@ pub fn generate(allocator: *Allocator, spec_xml: []const u8, writer: anytype) !v
defer gen.deinit(); defer gen.deinit();
try gen.mergeEnumFields(); try gen.mergeEnumFields();
try gen.fixupBitFlags();
try gen.render(writer); try gen.render(writer);
} }

View File

@@ -74,7 +74,7 @@ fn parseTypes(allocator: *Allocator, out: []registry.Declaration, types_elem: *x
} else if (mem.eql(u8, category, "funcpointer")) { } else if (mem.eql(u8, category, "funcpointer")) {
break :blk try parseFuncPointer(allocator, ty); break :blk try parseFuncPointer(allocator, ty);
} else if (mem.eql(u8, category, "enum")) { } else if (mem.eql(u8, category, "enum")) {
break :blk (try parseEnumAlias(ty)) orelse continue; break :blk (try parseEnumAlias(allocator, ty)) orelse continue;
} }
continue; continue;
@@ -118,13 +118,10 @@ fn parseBitmaskType(ty: *xml.Element) !registry.Declaration {
return registry.Declaration{ return registry.Declaration{
.name = ty.getCharData("name") orelse return error.InvalidRegistry, .name = ty.getCharData("name") orelse return error.InvalidRegistry,
.decl_type = .{ .decl_type = .{.bitmask = .{
.bitmask = .{ .bits_enum = ty.getAttribute("requires") orelse ty.getAttribute("bitvalues"), // Who knows why these are different fields
// Who knows why these are different fields
.bits_enum = ty.getAttribute("requires") orelse ty.getAttribute("bitvalues"),
.bitwidth = bitwidth, .bitwidth = bitwidth,
}, }},
},
}; };
} }
} }
@@ -135,9 +132,7 @@ fn parseHandleType(ty: *xml.Element) !registry.Declaration {
const alias = ty.getAttribute("alias") orelse return error.InvalidRegistry; const alias = ty.getAttribute("alias") orelse return error.InvalidRegistry;
return registry.Declaration{ return registry.Declaration{
.name = name, .name = name,
.decl_type = .{ .decl_type = .{.alias = .{.name = alias, .target = .other_type}},
.alias = .{ .name = alias, .target = .other_type },
},
}; };
} else { } else {
const name = ty.getCharData("name") orelse return error.InvalidRegistry; const name = ty.getCharData("name") orelse return error.InvalidRegistry;
@@ -153,7 +148,7 @@ fn parseHandleType(ty: *xml.Element) !registry.Declaration {
.handle = .{ .handle = .{
.parent = ty.getAttribute("parent"), .parent = ty.getAttribute("parent"),
.is_dispatchable = dispatchable, .is_dispatchable = dispatchable,
}, }
}, },
}; };
} }
@@ -180,9 +175,7 @@ fn parseContainer(allocator: *Allocator, ty: *xml.Element, is_union: bool) !regi
if (ty.getAttribute("alias")) |alias| { if (ty.getAttribute("alias")) |alias| {
return registry.Declaration{ return registry.Declaration{
.name = name, .name = name,
.decl_type = .{ .decl_type = .{.alias = .{.name = alias, .target = .other_type}},
.alias = .{ .name = alias, .target = .other_type },
},
}; };
} }
@@ -218,8 +211,8 @@ fn parseContainer(allocator: *Allocator, ty: *xml.Element, is_union: bool) !regi
.stype = maybe_stype, .stype = maybe_stype,
.fields = members, .fields = members,
.is_union = is_union, .is_union = is_union,
}, }
}, }
}; };
} }
@@ -297,14 +290,12 @@ fn parsePointerMeta(fields: Fields, type_info: *registry.TypeInfo, elem: *xml.El
} }
} }
fn parseEnumAlias(elem: *xml.Element) !?registry.Declaration { fn parseEnumAlias(allocator: *Allocator, elem: *xml.Element) !?registry.Declaration {
if (elem.getAttribute("alias")) |alias| { if (elem.getAttribute("alias")) |alias| {
const name = elem.getAttribute("name") orelse return error.InvalidRegistry; const name = elem.getAttribute("name") orelse return error.InvalidRegistry;
return registry.Declaration{ return registry.Declaration{
.name = name, .name = name,
.decl_type = .{ .decl_type = .{.alias = .{.name = alias, .target = .other_type}},
.alias = .{ .name = alias, .target = .other_type },
},
}; };
} }
@@ -428,9 +419,7 @@ fn parseCommand(allocator: *Allocator, elem: *xml.Element) !registry.Declaration
const name = elem.getAttribute("name") orelse return error.InvalidRegistry; const name = elem.getAttribute("name") orelse return error.InvalidRegistry;
return registry.Declaration{ return registry.Declaration{
.name = name, .name = name,
.decl_type = .{ .decl_type = .{.alias = .{.name = alias, .target = .other_command}}
.alias = .{ .name = alias, .target = .other_command },
},
}; };
} }
@@ -482,8 +471,8 @@ fn parseCommand(allocator: *Allocator, elem: *xml.Element) !registry.Declaration
.return_type = return_type, .return_type = return_type,
.success_codes = success_codes, .success_codes = success_codes,
.error_codes = error_codes, .error_codes = error_codes,
}, }
}, }
}; };
} }
@@ -557,7 +546,9 @@ fn parseDefines(types: *xml.Element, out: []registry.ApiConstant) !usize {
var xctok = cparse.XmlCTokenizer.init(ty); var xctok = cparse.XmlCTokenizer.init(ty);
out[i] = .{ out[i] = .{
.name = name, .name = name,
.value = .{ .version = cparse.parseVersion(&xctok) catch continue }, .value = .{
.version = cparse.parseVersion(&xctok) catch continue
},
}; };
} }
i += 1; i += 1;
@@ -618,7 +609,7 @@ fn parseFeature(allocator: *Allocator, feature: *xml.Element) !registry.Feature
return registry.Feature{ return registry.Feature{
.name = name, .name = name,
.level = feature_level, .level = feature_level,
.requires = allocator.shrink(requires, i), .requires = allocator.shrink(requires, i)
}; };
} }
@@ -651,10 +642,7 @@ fn parseEnumExtension(elem: *xml.Element, parent_extnumber: ?u31) !?registry.Req
return registry.Require.EnumExtension{ return registry.Require.EnumExtension{
.extends = extends, .extends = extends,
.extnumber = actual_extnumber, .extnumber = actual_extnumber,
.field = .{ .field = .{.name = name, .value = .{.int = value}},
.name = name,
.value = .{ .int = value },
},
}; };
} }
@@ -783,6 +771,7 @@ fn parseExtension(allocator: *Allocator, extension: *xml.Element) !registry.Exte
const promotedto = extension.getAttribute("promotedto") orelse break :blk .none; const promotedto = extension.getAttribute("promotedto") orelse break :blk .none;
if (mem.startsWith(u8, promotedto, "VK_VERSION_")) { if (mem.startsWith(u8, promotedto, "VK_VERSION_")) {
const feature_level = try splitFeatureLevel(promotedto["VK_VERSION_".len ..], "_"); const feature_level = try splitFeatureLevel(promotedto["VK_VERSION_".len ..], "_");
break :blk .{.feature = feature_level}; break :blk .{.feature = feature_level};
} }
@@ -827,7 +816,7 @@ fn parseExtension(allocator: *Allocator, extension: *xml.Element) !registry.Exte
.promoted_to = promoted_to, .promoted_to = promoted_to,
.platform = platform, .platform = platform,
.required_feature_level = requires_core, .required_feature_level = requires_core,
.requires = allocator.shrink(requires, i), .requires = allocator.shrink(requires, i)
}; };
} }

View File

@@ -77,7 +77,7 @@ pub const Enum = struct {
alias: struct { alias: struct {
name: []const u8, name: []const u8,
is_compat_alias: bool, is_compat_alias: bool,
}, }
}; };
pub const Field = struct { pub const Field = struct {
@@ -118,7 +118,7 @@ pub const Pointer = struct {
one, one,
many, // The length is given by some complex expression, possibly involving another field many, // The length is given by some complex expression, possibly involving another field
other_field: []const u8, // The length is given by some other field or parameter other_field: []const u8, // The length is given by some other field or parameter
zero_terminated, zero_terminated
}; };
is_const: bool, is_const: bool,

View File

@@ -9,17 +9,14 @@ const IdRenderer = id_render.IdRenderer;
const preamble = const preamble =
\\ \\
\\// This file is generated from the Khronos Vulkan XML API registry by vulkan-zig. \\// This file is generated from the Khronos Vulkan XML API registry
\\ \\
\\const std = @import("std"); \\const std = @import("std");
\\const builtin = @import("builtin"); \\const builtin = @import("builtin");
\\const root = @import("root"); \\const root = @import("root");
\\ \\pub const vulkan_call_conv: builtin.CallingConvention = if (builtin.os.tag == .windows and builtin.cpu.arch == .i386)
\\const GlobalScope = @This();
\\
\\pub const vulkan_call_conv: std.builtin.CallingConvention = if (builtin.os.tag == .windows and builtin.cpu.arch == .i386)
\\ .Stdcall \\ .Stdcall
\\ else if (builtin.abi == .android and (builtin.cpu.arch.isARM() or builtin.cpu.arch.isThumb()) and std.Target.arm.featureSetHas(builtin.cpu.features, .has_v7) and builtin.cpu.arch.ptrBitWidth() == 32) \\ else if (builtin.abi == .android and (builtin.cpu.arch.isARM() or builtin.cpu.arch.isThumb()) and builtin.Target.arm.featureSetHas(builtin.cpu.features, .has_v7) and builtin.cpu.arch.ptrBitWidth() == 32)
\\ // On Android 32-bit ARM targets, Vulkan functions use the "hardfloat" \\ // On Android 32-bit ARM targets, Vulkan functions use the "hardfloat"
\\ // calling convention, i.e. float parameters are passed in registers. This \\ // calling convention, i.e. float parameters are passed in registers. This
\\ // is true even if the rest of the application passes floats on the stack, \\ // is true even if the rest of the application passes floats on the stack,
@@ -43,7 +40,7 @@ const preamble =
\\ return fromInt(toInt(lhs) & toInt(rhs)); \\ return fromInt(toInt(lhs) & toInt(rhs));
\\ } \\ }
\\ pub fn complement(self: FlagsType) FlagsType { \\ pub fn complement(self: FlagsType) FlagsType {
\\ return fromInt(~toInt(self)); \\ return fromInt(~toInt(lhs));
\\ } \\ }
\\ pub fn subtract(lhs: FlagsType, rhs: FlagsType) FlagsType { \\ pub fn subtract(lhs: FlagsType, rhs: FlagsType) FlagsType {
\\ return fromInt(toInt(lhs) & toInt(rhs.complement())); \\ return fromInt(toInt(lhs) & toInt(rhs.complement()));
@@ -198,7 +195,7 @@ fn Renderer(comptime WriterType: type) type {
return error.InvalidRegistry; return error.InvalidRegistry;
} }
result.value_ptr.* = &decl.decl_type; result.entry.value = &decl.decl_type;
} }
return Self{ return Self{
@@ -217,7 +214,7 @@ fn Renderer(comptime WriterType: type) type {
} }
fn writeIdentifier(self: Self, id: []const u8) !void { fn writeIdentifier(self: Self, id: []const u8) !void {
try id_render.writeIdentifier(self.writer, id); try self.id_renderer.render(self.writer, id);
} }
fn writeIdentifierWithCase(self: *Self, case: CaseStyle, id: []const u8) !void { fn writeIdentifierWithCase(self: *Self, case: CaseStyle, id: []const u8) !void {
@@ -245,7 +242,7 @@ fn Renderer(comptime WriterType: type) type {
} }
} }
fn extractBitflagFieldName(bitflag_name: BitflagName, field_name: []const u8) ![]const u8 { fn extractBitflagFieldName(self: Self, bitflag_name: BitflagName, field_name: []const u8) ![]const u8 {
var flag_it = id_render.SegmentIterator.init(bitflag_name.base_name); var flag_it = id_render.SegmentIterator.init(bitflag_name.base_name);
var field_it = id_render.SegmentIterator.init(field_name); var field_it = id_render.SegmentIterator.init(field_name);
@@ -298,6 +295,16 @@ fn Renderer(comptime WriterType: type) type {
return mem.endsWith(u8, base_name, "Flags"); return mem.endsWith(u8, base_name, "Flags");
} }
fn containerHasField(self: Self, container: *const reg.Container, field_name: []const u8) bool {
for (container.fields) |field| {
if (mem.eql(u8, field, field_name)) {
return true;
}
}
return false;
}
fn isInOutPointer(self: Self, ptr: reg.Pointer) !bool { fn isInOutPointer(self: Self, ptr: reg.Pointer) !bool {
if (ptr.child.* != .name) { if (ptr.child.* != .name) {
return false; return false;
@@ -366,7 +373,7 @@ fn Renderer(comptime WriterType: type) type {
} }
}, },
.name => |name| { .name => |name| {
if ((try self.extractBitflagName(name)) != null or self.isFlags(name)) { if ((try self.extractBitflagName(param.param_type.name)) != null or self.isFlags(param.param_type.name)) {
return .bitflags; return .bitflags;
} }
}, },
@@ -380,7 +387,7 @@ fn Renderer(comptime WriterType: type) type {
return .other; return .other;
} }
fn classifyCommandDispatch(name: []const u8, command: reg.Command) CommandDispatchType { fn classifyCommandDispatch(self: Self, name: []const u8, command: reg.Command) CommandDispatchType {
const device_handles = std.ComptimeStringMap(void, .{ const device_handles = std.ComptimeStringMap(void, .{
.{"VkDevice", {}}, .{"VkDevice", {}},
.{"VkCommandBuffer", {}}, .{"VkCommandBuffer", {}},
@@ -415,7 +422,6 @@ fn Renderer(comptime WriterType: type) type {
fn render(self: *Self) !void { fn render(self: *Self) !void {
try self.renderCopyright(); try self.renderCopyright();
try self.writer.writeAll(preamble); try self.writer.writeAll(preamble);
try self.renderCommandEnums();
for (self.registry.api_constants) |api_constant| { for (self.registry.api_constants) |api_constant| {
try self.renderApiConstant(api_constant); try self.renderApiConstant(api_constant);
@@ -430,37 +436,6 @@ fn Renderer(comptime WriterType: type) type {
try self.renderWrappers(); try self.renderWrappers();
} }
fn renderCommandEnums(self: *Self) !void {
try self.renderCommandEnumOfDispatchType(.base);
try self.renderCommandEnumOfDispatchType(.instance);
try self.renderCommandEnumOfDispatchType(.device);
try self.writer.writeAll("\n");
}
fn renderCommandEnumOfDispatchType(self: *Self, dispatch_type: CommandDispatchType) !void {
const dispatch_type_name = switch (dispatch_type) {
.base => "Base",
.instance => "Instance",
.device => "Device",
};
try self.writer.print("pub const {s}Command = enum {{\n", .{dispatch_type_name});
for (self.registry.decls) |decl| {
if (decl.decl_type == .command) {
const command = decl.decl_type.command;
if (classifyCommandDispatch(decl.name, command) == dispatch_type) {
try self.writer.print("{s},\n", .{trimVkNamespace(decl.name)});
}
}
}
try self.writer.writeAll("};\n");
try self.writer.print(
\\fn {s}CommandToString(cmd: {s}Command) []const u8 {{
\\ return std.meta.tagName(cmd);
\\}}
, .{ dispatch_type_name, dispatch_type_name });
}
fn renderCopyright(self: *Self) !void { fn renderCopyright(self: *Self) !void {
var it = mem.split(self.registry.copyright, "\n"); var it = mem.split(self.registry.copyright, "\n");
while (it.next()) |line| { while (it.next()) |line| {
@@ -564,7 +539,7 @@ fn Renderer(comptime WriterType: type) type {
try self.writeIdentifierFmt("{s}Flags{s}{s}", .{ try self.writeIdentifierFmt("{s}Flags{s}{s}", .{
trimVkNamespace(bitflag_name.base_name), trimVkNamespace(bitflag_name.base_name),
@as([]const u8, if (bitflag_name.revision) |revision| revision else ""), @as([]const u8, if (bitflag_name.revision) |revision| revision else ""),
@as([]const u8, if (bitflag_name.tag) |tag| tag else ""), @as([]const u8, if (bitflag_name.tag) |tag| tag else "")
}); });
return; return;
} else if (mem.startsWith(u8, name, "vk")) { } else if (mem.startsWith(u8, name, "vk")) {
@@ -604,7 +579,7 @@ fn Renderer(comptime WriterType: type) type {
try self.writeIdentifierFmt("{s}Flags{s}{s}", .{ try self.writeIdentifierFmt("{s}Flags{s}{s}", .{
trimVkNamespace(bitflag_name.base_name), trimVkNamespace(bitflag_name.base_name),
@as([]const u8, if (bitflag_name.revision) |revision| revision else ""), @as([]const u8, if (bitflag_name.revision) |revision| revision else ""),
@as([]const u8, if (bitflag_name.tag) |tag| tag else ""), @as([]const u8, if (bitflag_name.tag) |tag| tag else "")
}); });
try self.writer.writeAll(".IntType"); try self.writer.writeAll(".IntType");
break :blk; break :blk;
@@ -735,6 +710,37 @@ fn Renderer(comptime WriterType: type) type {
try self.writeIdentifierWithCase(.snake, try self.extractEnumFieldName(name, field_name)); try self.writeIdentifierWithCase(.snake, try self.extractEnumFieldName(name, field_name));
} }
fn renderEnumerationValue(self: *Self, enum_name: []const u8, enumeration: reg.Enum, value: reg.Enum.Value) !void {
var current_value = value;
var maybe_alias_of: ?[]const u8 = null;
while (true) {
switch (current_value) {
.int => |int| try self.writer.print(" = {}, ", .{int}),
.bitpos => |pos| try self.writer.print(" = 1 << {}, ", .{pos}),
.bit_vector => |bv| try self.writer.print("= 0x{X}, ", .{bv}),
.alias => |alias| {
// Find the alias
current_value = for (enumeration.fields) |field| {
if (mem.eql(u8, field.name, alias.name)) {
maybe_alias_of = field.name;
break field.value;
}
} else return error.InvalidRegistry; // There is no alias
continue;
},
}
break;
}
if (maybe_alias_of) |alias_of| {
try self.writer.writeAll("// alias of ");
try self.renderEnumFieldName(enum_name, alias_of);
try self.writer.writeByte('\n');
}
}
fn renderEnumeration(self: *Self, name: []const u8, enumeration: reg.Enum) !void { fn renderEnumeration(self: *Self, name: []const u8, enumeration: reg.Enum) !void {
if (enumeration.is_bitmask) { if (enumeration.is_bitmask) {
try self.renderBitmaskBits(name, enumeration); try self.renderBitmaskBits(name, enumeration);
@@ -743,37 +749,17 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.writeAll("pub const "); try self.writer.writeAll("pub const ");
try self.renderName(name); try self.renderName(name);
try self.writer.writeAll(" = enum(c_int) {"); try self.writer.writeAll(" = extern enum(i32) {");
for (enumeration.fields) |field| { for (enumeration.fields) |field| {
if (field.value == .alias) if (field.value == .alias and field.value.alias.is_compat_alias)
continue; continue;
try self.renderEnumFieldName(name, field.name); try self.renderEnumFieldName(name, field.name);
switch (field.value) { try self.renderEnumerationValue(name, enumeration, field.value);
.int => |int| try self.writer.print(" = {}, ", .{int}),
.bitpos => |pos| try self.writer.print(" = 1 << {}, ", .{pos}),
.bit_vector => |bv| try self.writer.print("= 0x{X}, ", .{bv}),
.alias => unreachable,
}
} }
try self.writer.writeAll("_,"); try self.writer.writeAll("_,};\n");
for (enumeration.fields) |field| {
if (field.value != .alias or field.value.alias.is_compat_alias)
continue;
try self.writer.writeAll("pub const ");
try self.renderEnumFieldName(name, field.name);
try self.writer.writeAll(" = ");
try self.renderName(name);
try self.writer.writeByte('.');
try self.renderEnumFieldName(name, field.value.alias.name);
try self.writer.writeAll(";\n");
}
try self.writer.writeAll("};\n");
} }
fn bitmaskFlagsType(bitwidth: u8) ![]const u8 { fn bitmaskFlagsType(bitwidth: u8) ![]const u8 {
@@ -785,7 +771,12 @@ fn Renderer(comptime WriterType: type) type {
} }
fn renderUsingFlagsMixin(self: *Self, name: []const u8, bitwidth: u8) !void { fn renderUsingFlagsMixin(self: *Self, name: []const u8, bitwidth: u8) !void {
const flags_type = try bitmaskFlagsType(bitwidth); const flags_type = switch (bitwidth) {
32 => "Flags",
64 => "Flags64",
else => return error.InvalidRegistry,
};
try self.writer.writeAll("pub usingnamespace FlagsMixin("); try self.writer.writeAll("pub usingnamespace FlagsMixin(");
try self.renderName(name); try self.renderName(name);
try self.writer.print(", {s});\n", .{ flags_type }); try self.writer.print(", {s});\n", .{ flags_type });
@@ -811,7 +802,7 @@ fn Renderer(comptime WriterType: type) type {
for (flags_by_bitpos[0.. bits.bitwidth]) |maybe_flag_name, bitpos| { for (flags_by_bitpos[0.. bits.bitwidth]) |maybe_flag_name, bitpos| {
if (maybe_flag_name) |flag_name| { if (maybe_flag_name) |flag_name| {
const field_name = try extractBitflagFieldName(bitflag_name, flag_name); const field_name = try self.extractBitflagFieldName(bitflag_name, flag_name);
try self.writeIdentifierWithCase(.snake, field_name); try self.writeIdentifierWithCase(.snake, field_name);
} else { } else {
try self.writer.print("_reserved_bit_{}", .{bitpos}); try self.writer.print("_reserved_bit_{}", .{bitpos});
@@ -819,7 +810,7 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.writeAll(": bool "); try self.writer.writeAll(": bool ");
if (bitpos == 0) { // Force alignment to integer boundaries if (bitpos == 0) { // Force alignment to integer boundaries
try self.writer.print("align(@alignOf({s})) ", .{flags_type}); try self.writer.writeAll("align(@alignOf(Flags)) ");
} }
try self.writer.writeAll("= false, "); try self.writer.writeAll("= false, ");
} }
@@ -842,13 +833,15 @@ fn Renderer(comptime WriterType: type) type {
\\ = packed struct {{ \\ = packed struct {{
\\_reserved_bits: {s} = 0, \\_reserved_bits: {s} = 0,
\\pub usingnamespace FlagsMixin( \\pub usingnamespace FlagsMixin(
, .{flags_type}); , .{ flags_type }
);
try self.renderName(name); try self.renderName(name);
try self.writer.print( try self.writer.print(
\\, {s}); \\, {s});
\\}}; \\}};
\\ \\
, .{flags_type}); , .{ flags_type }
);
} }
} }
@@ -857,7 +850,7 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.writeAll("pub const "); try self.writer.writeAll("pub const ");
try self.renderName(name); try self.renderName(name);
try self.writer.print(" = enum({s}) {{null_handle = 0, _}};\n", .{backing_type}); try self.writer.print(" = extern enum({s}) {{null_handle = 0, _}};\n", .{backing_type});
} }
fn renderAlias(self: *Self, name: []const u8, alias: reg.Alias) !void { fn renderAlias(self: *Self, name: []const u8, alias: reg.Alias) !void {
@@ -945,53 +938,25 @@ fn Renderer(comptime WriterType: type) type {
} }
fn renderWrappers(self: *Self) !void { fn renderWrappers(self: *Self) !void {
try self.renderWrappersOfDispatchType(.base); try self.renderWrappersOfDispatchType("BaseWrapper", .base);
try self.renderWrappersOfDispatchType(.instance); try self.renderWrappersOfDispatchType("InstanceWrapper", .instance);
try self.renderWrappersOfDispatchType(.device); try self.renderWrappersOfDispatchType("DeviceWrapper", .device);
} }
fn renderWrappersOfDispatchType(self: *Self, dispatch_type: CommandDispatchType) !void { fn renderWrappersOfDispatchType(self: *Self, name: []const u8, dispatch_type: CommandDispatchType) !void {
const name = switch (dispatch_type) {
.base => "Base",
.instance => "Instance",
.device => "Device",
};
try self.writer.print( try self.writer.print(
\\pub fn {s}Wrapper(comptime cmds: anytype) type {{ \\pub fn {s}(comptime Self: type) type {{
\\ comptime var fields: [cmds.len]std.builtin.TypeInfo.StructField = undefined;
\\ inline for (cmds) |cmd, i| {{
\\ const cmd_name = {s}CommandToString(cmd);
\\ const cmd_type_name = "Pfn" ++ cmd_name;
\\ const cmd_type = @field(GlobalScope, cmd_type_name);
\\ fields[i] = .{{
\\ .name = "vk" ++ cmd_name,
\\ .field_type = cmd_type,
\\ .default_value = null,
\\ .is_comptime = false,
\\ .alignment = @alignOf(*cmd_type),
\\ }};
\\ }}
\\ const Dispatch = @Type(.{{
\\ .Struct = .{{
\\ .layout = .Auto,
\\ .fields = &fields,
\\ .decls = &[_]std.builtin.TypeInfo.Declaration{{}},
\\ .is_tuple = false,
\\ }},
\\ }});
\\ return struct {{ \\ return struct {{
\\ dispatch: Dispatch,
\\ \\
\\ const Self = @This(); , .{name}
, .{ name, name }); );
try self.renderWrapperLoader(dispatch_type); try self.renderWrapperLoader(dispatch_type);
for (self.registry.decls) |decl| { for (self.registry.decls) |decl| {
if (decl.decl_type == .command) { if (decl.decl_type == .command) {
const command = decl.decl_type.command; const command = decl.decl_type.command;
if (classifyCommandDispatch(decl.name, command) == dispatch_type) { if (self.classifyCommandDispatch(decl.name, command) == dispatch_type) {
try self.renderWrapper(decl.name, decl.decl_type.command); try self.renderWrapper(decl.name, decl.decl_type.command);
} }
} }
@@ -1018,15 +983,16 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.print( try self.writer.print(
\\pub fn load({s}) !Self {{ \\pub fn load({s}) !Self {{
\\ var self: Self = undefined; \\ var self: Self = undefined;
\\ inline for (std.meta.fields(Dispatch)) |field| {{ \\ inline for (std.meta.fields(Self)) |field| {{
\\ const name = @ptrCast([*:0]const u8, field.name ++ "\x00"); \\ const name = @ptrCast([*:0]const u8, field.name ++ "\x00");
\\ const cmd_ptr = loader({s}name) orelse return error.CommandLoadFailure; \\ const cmd_ptr = loader({s}name) orelse return error.InvalidCommand;
\\ @field(self.dispatch, field.name) = @ptrCast(field.field_type, cmd_ptr); \\ @field(self, field.name) = @ptrCast(field.field_type, cmd_ptr);
\\ }} \\ }}
\\ return self; \\ return self;
\\}} \\}}
\\ \\
, .{ params, loader_first_param }); , .{params, loader_first_param}
);
} }
fn derefName(name: []const u8) []const u8 { fn derefName(name: []const u8) []const u8 {
@@ -1055,8 +1021,7 @@ fn Renderer(comptime WriterType: type) type {
.bitflags, // Special stuff handled in renderWrapperCall .bitflags, // Special stuff handled in renderWrapperCall
.buffer_len, .buffer_len,
.mut_buffer_len, .mut_buffer_len,
.other, .other => {
=> {
try self.writeIdentifierWithCase(.snake, param.name); try self.writeIdentifierWithCase(.snake, param.name);
try self.writer.writeAll(": "); try self.writer.writeAll(": ");
try self.renderTypeInfo(param.param_type); try self.renderTypeInfo(param.param_type);
@@ -1068,8 +1033,8 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.writeAll(") "); try self.writer.writeAll(") ");
if (command.error_codes.len > 0) { if (command.return_type.* == .name and mem.eql(u8, command.return_type.name, "VkResult")) {
try self.renderErrorSetName(name); try self.renderErrorSet(command.error_codes);
try self.writer.writeByte('!'); try self.writer.writeByte('!');
} }
@@ -1083,7 +1048,7 @@ fn Renderer(comptime WriterType: type) type {
} }
fn renderWrapperCall(self: *Self, name: []const u8, command: reg.Command, returns: []const ReturnValue) !void { fn renderWrapperCall(self: *Self, name: []const u8, command: reg.Command, returns: []const ReturnValue) !void {
try self.writer.writeAll("self.dispatch."); try self.writer.writeAll("self.");
try self.writeIdentifier(name); try self.writeIdentifier(name);
try self.writer.writeAll("("); try self.writer.writeAll("(");
@@ -1104,7 +1069,10 @@ fn Renderer(comptime WriterType: type) type {
try self.writeIdentifierWithCase(.snake, param.name); try self.writeIdentifierWithCase(.snake, param.name);
try self.writer.writeAll(".toInt()"); try self.writer.writeAll(".toInt()");
}, },
.in_out_pointer, .buffer_len, .mut_buffer_len, .other => { .in_out_pointer,
.buffer_len,
.mut_buffer_len,
.other => {
try self.writeIdentifierWithCase(.snake, param.name); try self.writeIdentifierWithCase(.snake, param.name);
}, },
} }
@@ -1159,11 +1127,6 @@ fn Renderer(comptime WriterType: type) type {
try self.writeIdentifierFmt("{s}Result", .{trimVkNamespace(command_name)}); try self.writeIdentifierFmt("{s}Result", .{trimVkNamespace(command_name)});
} }
fn renderErrorSetName(self: *Self, name: []const u8) !void {
try self.writeIdentifierWithCase(.title, trimVkNamespace(name));
try self.writer.writeAll("Error");
}
fn renderReturnStruct(self: *Self, command_name: []const u8, returns: []const ReturnValue) !void { fn renderReturnStruct(self: *Self, command_name: []const u8, returns: []const ReturnValue) !void {
try self.writer.writeAll("pub const "); try self.writer.writeAll("pub const ");
try self.renderReturnStructName(command_name); try self.renderReturnStructName(command_name);
@@ -1173,13 +1136,16 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.writeAll(": "); try self.writer.writeAll(": ");
try self.renderTypeInfo(ret.return_value_type); try self.renderTypeInfo(ret.return_value_type);
try self.writer.writeAll(", "); try self.writer.writeAll(", ");
} }
try self.writer.writeAll("};\n"); try self.writer.writeAll("};\n");
} }
fn renderWrapper(self: *Self, name: []const u8, command: reg.Command) !void { fn renderWrapper(self: *Self, name: []const u8, command: reg.Command) !void {
const returns_vk_result = command.return_type.* == .name and mem.eql(u8, command.return_type.name, "VkResult"); const returns_vk_result = command.return_type.* == .name
const returns_void = command.return_type.* == .name and mem.eql(u8, command.return_type.name, "void"); and mem.eql(u8, command.return_type.name, "VkResult");
const returns_void = command.return_type.* == .name
and mem.eql(u8, command.return_type.name, "void");
const returns = try self.extractReturns(command); const returns = try self.extractReturns(command);
@@ -1187,14 +1153,6 @@ fn Renderer(comptime WriterType: type) type {
try self.renderReturnStruct(name, returns); try self.renderReturnStruct(name, returns);
} }
if (command.error_codes.len > 0) {
try self.writer.writeAll("pub const ");
try self.renderErrorSetName(name);
try self.writer.writeAll(" = ");
try self.renderErrorSet(command.error_codes);
try self.writer.writeAll(";\n");
}
try self.renderWrapperPrototype(name, command, returns); try self.renderWrapperPrototype(name, command, returns);
if (returns.len == 1 and returns[0].origin == .inner_return_value) { if (returns.len == 1 and returns[0].origin == .inner_return_value) {
@@ -1264,13 +1222,13 @@ fn Renderer(comptime WriterType: type) type {
try self.writer.writeAll(") {\n"); try self.writer.writeAll(") {\n");
for (command.success_codes) |success| { for (command.success_codes) |success| {
try self.writer.writeAll("Result."); try self.writer.writeByte('.');
try self.renderEnumFieldName("VkResult", success); try self.renderEnumFieldName("VkResult", success);
try self.writer.writeAll(" => {},"); try self.writer.writeAll(" => {},");
} }
for (command.error_codes) |err| { for (command.error_codes) |err| {
try self.writer.writeAll("Result."); try self.writer.writeByte('.');
try self.renderEnumFieldName("VkResult", err); try self.renderEnumFieldName("VkResult", err);
try self.writer.writeAll(" => return error."); try self.writer.writeAll(" => return error.");
try self.renderResultAsErrorName(err); try self.renderResultAsErrorName(err);

View File

@@ -7,13 +7,13 @@ const ArrayList = std.ArrayList;
pub const Attribute = struct { pub const Attribute = struct {
name: []const u8, name: []const u8,
value: []const u8, value: []const u8
}; };
pub const Content = union(enum) { pub const Content = union(enum) {
CharData: []const u8, CharData: []const u8,
Comment: []const u8, Comment: []const u8,
Element: *Element, Element: *Element
}; };
pub const Element = struct { pub const Element = struct {
@@ -50,7 +50,7 @@ pub const Element = struct {
return switch (child.children.items[0]) { return switch (child.children.items[0]) {
.CharData => |char_data| char_data, .CharData => |char_data| char_data,
else => null, else => null
}; };
} }
@@ -74,7 +74,7 @@ pub const Element = struct {
pub fn findChildrenByTag(self: *Element, tag: []const u8) FindChildrenByTagIterator { pub fn findChildrenByTag(self: *Element, tag: []const u8) FindChildrenByTagIterator {
return .{ return .{
.inner = self.elements(), .inner = self.elements(),
.tag = tag, .tag = tag
}; };
} }
@@ -129,7 +129,7 @@ pub const Element = struct {
pub const XmlDecl = struct { pub const XmlDecl = struct {
version: []const u8, version: []const u8,
encoding: ?[]const u8, encoding: ?[]const u8,
standalone: ?bool, standalone: ?bool
}; };
pub const Document = struct { pub const Document = struct {
@@ -154,7 +154,7 @@ const ParseContext = struct {
.source = source, .source = source,
.offset = 0, .offset = 0,
.line = 0, .line = 0,
.column = 0, .column = 0
}; };
} }
@@ -232,7 +232,7 @@ const ParseContext = struct {
ws = true; ws = true;
_ = self.consumeNoEof(); _ = self.consumeNoEof();
}, },
else => break, else => break
} }
} }
@@ -257,46 +257,46 @@ const ParseContext = struct {
test "ParseContext" { test "ParseContext" {
{ {
var ctx = ParseContext.init("I like pythons"); var ctx = ParseContext.init("I like pythons");
try testing.expectEqual(@as(?u8, 'I'), ctx.peek()); testing.expectEqual(@as(?u8, 'I'), ctx.peek());
try testing.expectEqual(@as(u8, 'I'), ctx.consumeNoEof()); testing.expectEqual(@as(u8, 'I'), ctx.consumeNoEof());
try testing.expectEqual(@as(?u8, ' '), ctx.peek()); testing.expectEqual(@as(?u8, ' '), ctx.peek());
try testing.expectEqual(@as(u8, ' '), try ctx.consume()); testing.expectEqual(@as(u8, ' '), try ctx.consume());
try testing.expect(ctx.eat('l')); testing.expect(ctx.eat('l'));
try testing.expectEqual(@as(?u8, 'i'), ctx.peek()); testing.expectEqual(@as(?u8, 'i'), ctx.peek());
try testing.expectEqual(false, ctx.eat('a')); testing.expectEqual(false, ctx.eat('a'));
try testing.expectEqual(@as(?u8, 'i'), ctx.peek()); testing.expectEqual(@as(?u8, 'i'), ctx.peek());
try ctx.expect('i'); try ctx.expect('i');
try testing.expectEqual(@as(?u8, 'k'), ctx.peek()); testing.expectEqual(@as(?u8, 'k'), ctx.peek());
try testing.expectError(error.UnexpectedCharacter, ctx.expect('a')); testing.expectError(error.UnexpectedCharacter, ctx.expect('a'));
try testing.expectEqual(@as(?u8, 'k'), ctx.peek()); testing.expectEqual(@as(?u8, 'k'), ctx.peek());
try testing.expect(ctx.eatStr("ke")); testing.expect(ctx.eatStr("ke"));
try testing.expectEqual(@as(?u8, ' '), ctx.peek()); testing.expectEqual(@as(?u8, ' '), ctx.peek());
try testing.expect(ctx.eatWs()); testing.expect(ctx.eatWs());
try testing.expectEqual(@as(?u8, 'p'), ctx.peek()); testing.expectEqual(@as(?u8, 'p'), ctx.peek());
try testing.expectEqual(false, ctx.eatWs()); testing.expectEqual(false, ctx.eatWs());
try testing.expectEqual(@as(?u8, 'p'), ctx.peek()); testing.expectEqual(@as(?u8, 'p'), ctx.peek());
try testing.expectEqual(false, ctx.eatStr("aaaaaaaaa")); testing.expectEqual(false, ctx.eatStr("aaaaaaaaa"));
try testing.expectEqual(@as(?u8, 'p'), ctx.peek()); testing.expectEqual(@as(?u8, 'p'), ctx.peek());
try testing.expectError(error.UnexpectedEof, ctx.expectStr("aaaaaaaaa")); testing.expectError(error.UnexpectedEof, ctx.expectStr("aaaaaaaaa"));
try testing.expectEqual(@as(?u8, 'p'), ctx.peek()); testing.expectEqual(@as(?u8, 'p'), ctx.peek());
try testing.expectError(error.UnexpectedCharacter, ctx.expectStr("pytn")); testing.expectError(error.UnexpectedCharacter, ctx.expectStr("pytn"));
try testing.expectEqual(@as(?u8, 'p'), ctx.peek()); testing.expectEqual(@as(?u8, 'p'), ctx.peek());
try ctx.expectStr("python"); try ctx.expectStr("python");
try testing.expectEqual(@as(?u8, 's'), ctx.peek()); testing.expectEqual(@as(?u8, 's'), ctx.peek());
} }
{ {
var ctx = ParseContext.init(""); var ctx = ParseContext.init("");
try testing.expectEqual(ctx.peek(), null); testing.expectEqual(ctx.peek(), null);
try testing.expectError(error.UnexpectedEof, ctx.consume()); testing.expectError(error.UnexpectedEof, ctx.consume());
try testing.expectEqual(ctx.eat('p'), false); testing.expectEqual(ctx.eat('p'), false);
try testing.expectError(error.UnexpectedEof, ctx.expect('p')); testing.expectError(error.UnexpectedEof, ctx.expect('p'));
} }
} }
@@ -311,7 +311,7 @@ pub const ParseError = error{
InvalidStandaloneValue, InvalidStandaloneValue,
NonMatchingClosingTag, NonMatchingClosingTag,
InvalidDocument, InvalidDocument,
OutOfMemory, OutOfMemory
}; };
pub fn parse(backing_allocator: *Allocator, source: []const u8) !Document { pub fn parse(backing_allocator: *Allocator, source: []const u8) !Document {
@@ -323,7 +323,7 @@ fn parseDocument(ctx: *ParseContext, backing_allocator: *Allocator) !Document {
var doc = Document{ var doc = Document{
.arena = ArenaAllocator.init(backing_allocator), .arena = ArenaAllocator.init(backing_allocator),
.xml_decl = null, .xml_decl = null,
.root = undefined, .root = undefined
}; };
errdefer doc.deinit(); errdefer doc.deinit();
@@ -376,7 +376,7 @@ fn parseNameNoDupe(ctx: *ParseContext) ![]const u8 {
switch (ch) { switch (ch) {
' ', '\t', '\n', '\r' => break, ' ', '\t', '\n', '\r' => break,
'&', '"', '\'', '<', '>', '?', '=', '/' => break, '&', '"', '\'', '<', '>', '?', '=', '/' => break,
else => _ = ctx.consumeNoEof(), else => _ = ctx.consumeNoEof()
} }
} }
@@ -392,7 +392,7 @@ fn tryParseCharData(ctx: *ParseContext, alloc: *Allocator) !?[]const u8 {
while (ctx.peek()) |ch| { while (ctx.peek()) |ch| {
switch (ch) { switch (ch) {
'<' => break, '<' => break,
else => _ = ctx.consumeNoEof(), else => _ = ctx.consumeNoEof()
} }
} }
@@ -477,41 +477,41 @@ test "tryParseElement" {
{ {
var ctx = ParseContext.init("<= a='b'/>"); var ctx = ParseContext.init("<= a='b'/>");
try testing.expectEqual(@as(?*Element, null), try tryParseElement(&ctx, alloc)); testing.expectEqual(@as(?*Element, null), try tryParseElement(&ctx, alloc));
try testing.expectEqual(@as(?u8, '<'), ctx.peek()); testing.expectEqual(@as(?u8, '<'), ctx.peek());
} }
{ {
var ctx = ParseContext.init("<python size='15' color = \"green\"/>"); var ctx = ParseContext.init("<python size='15' color = \"green\"/>");
const elem = try tryParseElement(&ctx, alloc); const elem = try tryParseElement(&ctx, alloc);
try testing.expectEqualSlices(u8, elem.?.tag, "python"); testing.expectEqualSlices(u8, elem.?.tag, "python");
const size_attr = elem.?.attributes.items[0]; const size_attr = elem.?.attributes.items[0];
try testing.expectEqualSlices(u8, size_attr.name, "size"); testing.expectEqualSlices(u8, size_attr.name, "size");
try testing.expectEqualSlices(u8, size_attr.value, "15"); testing.expectEqualSlices(u8, size_attr.value, "15");
const color_attr = elem.?.attributes.items[1]; const color_attr = elem.?.attributes.items[1];
try testing.expectEqualSlices(u8, color_attr.name, "color"); testing.expectEqualSlices(u8, color_attr.name, "color");
try testing.expectEqualSlices(u8, color_attr.value, "green"); testing.expectEqualSlices(u8, color_attr.value, "green");
} }
{ {
var ctx = ParseContext.init("<python>test</python>"); var ctx = ParseContext.init("<python>test</python>");
const elem = try tryParseElement(&ctx, alloc); const elem = try tryParseElement(&ctx, alloc);
try testing.expectEqualSlices(u8, elem.?.tag, "python"); testing.expectEqualSlices(u8, elem.?.tag, "python");
try testing.expectEqualSlices(u8, elem.?.children.items[0].CharData, "test"); testing.expectEqualSlices(u8, elem.?.children.items[0].CharData, "test");
} }
{ {
var ctx = ParseContext.init("<a>b<c/>d<e/>f<!--g--></a>"); var ctx = ParseContext.init("<a>b<c/>d<e/>f<!--g--></a>");
const elem = try tryParseElement(&ctx, alloc); const elem = try tryParseElement(&ctx, alloc);
try testing.expectEqualSlices(u8, elem.?.tag, "a"); testing.expectEqualSlices(u8, elem.?.tag, "a");
try testing.expectEqualSlices(u8, elem.?.children.items[0].CharData, "b"); testing.expectEqualSlices(u8, elem.?.children.items[0].CharData, "b");
try testing.expectEqualSlices(u8, elem.?.children.items[1].Element.tag, "c"); testing.expectEqualSlices(u8, elem.?.children.items[1].Element.tag, "c");
try testing.expectEqualSlices(u8, elem.?.children.items[2].CharData, "d"); testing.expectEqualSlices(u8, elem.?.children.items[2].CharData, "d");
try testing.expectEqualSlices(u8, elem.?.children.items[3].Element.tag, "e"); testing.expectEqualSlices(u8, elem.?.children.items[3].Element.tag, "e");
try testing.expectEqualSlices(u8, elem.?.children.items[4].CharData, "f"); testing.expectEqualSlices(u8, elem.?.children.items[4].CharData, "f");
try testing.expectEqualSlices(u8, elem.?.children.items[5].Comment, "g"); testing.expectEqualSlices(u8, elem.?.children.items[5].Comment, "g");
} }
} }
@@ -565,24 +565,24 @@ test "tryParseProlog" {
{ {
var ctx = ParseContext.init("<?xmla version='aa'?>"); var ctx = ParseContext.init("<?xmla version='aa'?>");
try testing.expectEqual(@as(?*XmlDecl, null), try tryParseProlog(&ctx, alloc)); testing.expectEqual(@as(?*XmlDecl, null), try tryParseProlog(&ctx, alloc));
try testing.expectEqual(@as(?u8, '<'), ctx.peek()); testing.expectEqual(@as(?u8, '<'), ctx.peek());
} }
{ {
var ctx = ParseContext.init("<?xml version='aa'?>"); var ctx = ParseContext.init("<?xml version='aa'?>");
const decl = try tryParseProlog(&ctx, alloc); const decl = try tryParseProlog(&ctx, alloc);
try testing.expectEqualSlices(u8, "aa", decl.?.version); testing.expectEqualSlices(u8, "aa", decl.?.version);
try testing.expectEqual(@as(?[]const u8, null), decl.?.encoding); testing.expectEqual(@as(?[]const u8, null), decl.?.encoding);
try testing.expectEqual(@as(?bool, null), decl.?.standalone); testing.expectEqual(@as(?bool, null), decl.?.standalone);
} }
{ {
var ctx = ParseContext.init("<?xml version=\"aa\" encoding = 'bbb' standalone \t = 'yes'?>"); var ctx = ParseContext.init("<?xml version=\"aa\" encoding = 'bbb' standalone \t = 'yes'?>");
const decl = try tryParseProlog(&ctx, alloc); const decl = try tryParseProlog(&ctx, alloc);
try testing.expectEqualSlices(u8, "aa", decl.?.version); testing.expectEqualSlices(u8, "aa", decl.?.version);
try testing.expectEqualSlices(u8, "bbb", decl.?.encoding.?); testing.expectEqualSlices(u8, "bbb", decl.?.encoding.?);
try testing.expectEqual(@as(?bool, true), decl.?.standalone.?); testing.expectEqual(@as(?bool, true), decl.?.standalone.?);
} }
} }
@@ -605,14 +605,17 @@ fn tryParseComment(ctx: *ParseContext, alloc: *Allocator) !?[]const u8 {
} }
fn unescapeEntity(text: []const u8) !u8 { fn unescapeEntity(text: []const u8) !u8 {
const EntitySubstition = struct { text: []const u8, replacement: u8 }; const EntitySubstition = struct {
text: []const u8,
replacement: u8
};
const entities = [_]EntitySubstition{ const entities = [_]EntitySubstition{
.{.text = "&lt;", .replacement = '<'}, .{.text = "&lt;", .replacement = '<'},
.{.text = "&gt;", .replacement = '>'}, .{.text = "&gt;", .replacement = '>'},
.{.text = "&amp;", .replacement = '&'}, .{.text = "&amp;", .replacement = '&'},
.{.text = "&apos;", .replacement = '\''}, .{.text = "&apos;", .replacement = '\''},
.{ .text = "&quot;", .replacement = '"' }, .{.text = "&quot;", .replacement = '"'}
}; };
for (entities) |entity| { for (entities) |entity| {
@@ -646,12 +649,12 @@ test "dupeAndUnescape" {
defer arena.deinit(); defer arena.deinit();
var alloc = &arena.allocator; var alloc = &arena.allocator;
try testing.expectEqualSlices(u8, "test", try dupeAndUnescape(alloc, "test")); testing.expectEqualSlices(u8, "test", try dupeAndUnescape(alloc, "test"));
try testing.expectEqualSlices(u8, "a<b&c>d\"e'f<", try dupeAndUnescape(alloc, "a&lt;b&amp;c&gt;d&quot;e&apos;f&lt;")); testing.expectEqualSlices(u8, "a<b&c>d\"e'f<", try dupeAndUnescape(alloc, "a&lt;b&amp;c&gt;d&quot;e&apos;f&lt;"));
try testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&")); testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&"));
try testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&&")); testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&&"));
try testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&test;")); testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&test;"));
try testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&boa")); testing.expectError(error.InvalidEntity, dupeAndUnescape(alloc, "python&boa"));
} }
test "Top level comments" { test "Top level comments" {
@@ -660,5 +663,5 @@ test "Top level comments" {
var alloc = &arena.allocator; var alloc = &arena.allocator;
const doc = try parse(alloc, "<?xml version='aa'?><!--comment--><python color='green'/><!--another comment-->"); const doc = try parse(alloc, "<?xml version='aa'?><!--comment--><python color='green'/><!--another comment-->");
try testing.expectEqualSlices(u8, "python", doc.root.tag); testing.expectEqualSlices(u8, "python", doc.root.tag);
} }