Commit `31a2b8c364`

Michael Bartnett <michaelbartnett@users.noreply.github.com>

2023-01-16 13:24:47

std: Handle field struct defaults in std.mem.zeroInit

I originally started monkeying with this because std.mem.zeroes doesn't support sentinel-terminated const slices even with defaults in 0.10.x. I see that std.mem.zeroes was modified in #13256 to allow setting these slices to "". That got me partway to where I wanted, but there was still an issue fields whose types are structs, they wouldn't get their defaults. So when iterating struct fields looking for default values, when there is no default value and the type is .Struct, it will delegate to a call to zeroInit. * Initialize struct fields in zeroInit exactly once In my changes, similar to the previous implementation, the priority order for fields being initialized is: 1. If the `init` argument is a tuple, the nth element corresponding to the nth field of the struct. 2. Otherwise, if the `init` argument is not a tuple, try to find a matching field name on `init` and use that field. 3. Is the field has a default value, initalize with that value. 4. Fall back to what the field would have been initialized to via a recursive call to `std.mem.zeroInit`. But instead of initializing a default instance of the struct and then running multiple passes over it, the init method is chosen per-field and each field is initialized exactly once.

master

1 parent 99febb5

Changed files (1)

lib

std

mem.zig

@@ -431,34 +431,48 @@ pub fn zeroInit(comptime T: type, init: anytype) T {
         .Struct => |struct_info| {
             switch (@typeInfo(Init)) {
                 .Struct => |init_info| {
-                    var value = std.mem.zeroes(T);
-
-                    inline for (struct_info.fields) |field| {
-                        if (field.default_value) |default_value_ptr| {
-                            const default_value = @ptrCast(*align(1) const field.type, default_value_ptr).*;
-                            @field(value, field.name) = default_value;
-                        }
-                    }
-
                     if (init_info.is_tuple) {
-                        inline for (init_info.fields) |field, i| {
-                            @field(value, struct_info.fields[i].name) = @field(init, field.name);
+                        if (init_info.fields.len > struct_info.fields.len) {
+                            @compileError("Tuple initializer has more elments than there are fields in `" ++ @typeName(T) ++ "`");
+                        }
+                    } else {
+                        inline for (init_info.fields) |field| {
+                            if (!@hasField(T, field.name)) {
+                                @compileError("Encountered an initializer for `" ++ field.name ++ "`, but it is not a field of " ++ @typeName(T));
+                            }
                         }
-                        return value;
                     }
 
-                    inline for (init_info.fields) |field| {
-                        if (!@hasField(T, field.name)) {
-                            @compileError("Encountered an initializer for `" ++ field.name ++ "`, but it is not a field of " ++ @typeName(T));
+                    var value: T = undefined;
+
+                    inline for (struct_info.fields) |field, i| {
+                        if (field.is_comptime) {
+                            continue;
                         }
 
-                        switch (@typeInfo(field.type)) {
-                            .Struct => {
-                                @field(value, field.name) = zeroInit(field.type, @field(init, field.name));
-                            },
-                            else => {
-                                @field(value, field.name) = @field(init, field.name);
-                            },
+                        if (init_info.is_tuple and init_info.fields.len > i) {
+                            @field(value, field.name) = @field(init, init_info.fields[i].name);
+                        } else if (@hasField(@TypeOf(init), field.name)) {
+                            switch (@typeInfo(field.type)) {
+                                .Struct => {
+                                    @field(value, field.name) = zeroInit(field.type, @field(init, field.name));
+                                },
+                                else => {
+                                    @field(value, field.name) = @field(init, field.name);
+                                },
+                            }
+                        } else if (field.default_value) |default_value_ptr| {
+                            const default_value = @ptrCast(*align(1) const field.type, default_value_ptr).*;
+                            @field(value, field.name) = default_value;
+                        } else {
+                            switch (@typeInfo(field.type)) {
+                                .Struct => {
+                                    @field(value, field.name) = std.mem.zeroInit(field.type, .{});
+                                },
+                                else => {
+                                    @field(value, field.name) = std.mem.zeroes(@TypeOf(@field(value, field.name)));
+                                },
+                            }
                         }
                     }
 
@@ -538,6 +552,24 @@ test "zeroInit" {
         .foo = 69,
         .bar = 420,
     }, b);
+
+    const Baz = struct {
+        foo: [:0]const u8 = "bar",
+    };
+
+    const baz1 = zeroInit(Baz, .{});
+    try testing.expectEqual(Baz{}, baz1);
+
+    const baz2 = zeroInit(Baz, .{ .foo = "zab" });
+    try testing.expectEqualSlices(u8, "zab", baz2.foo);
+
+    const NestedBaz = struct {
+        bbb: Baz,
+    };
+    const nested_baz = zeroInit(NestedBaz, .{});
+    try testing.expectEqual(NestedBaz{
+        .bbb = Baz{},
+    }, nested_baz);
 }
 
 /// Compares two slices of numbers lexicographically. O(n).

Commit 31a2b8c364

Commit `31a2b8c364`