Use .ptr for interfaces to match zig idiom

Author: Grazfather

drivers/base/Clock_Device.zig

@@ -11,9 +11,9 @@ const Clock_Device = @This();
 
 /// Pointer to the object implementing the driver.
 ///
-/// If the implementation requires no `object` pointer,
+/// If the implementation requires no `ptr` pointer,
 /// you can safely use `undefined` here.
-object: *anyopaque,
+ptr: *anyopaque,
 
 /// Virtual table for the digital i/o functions.
 vtable: *const VTable,
@@ -43,7 +43,7 @@ pub fn sleep_us(td: Clock_Device, time_us: u64) void {
 
 /// VTable methods
 pub fn get_time_since_boot(td: Clock_Device) mdf.time.Absolute {
-    return td.vtable.get_time_since_boot(td.object);
+    return td.vtable.get_time_since_boot(td.ptr);
 }
 
 pub const VTable = struct {
@@ -67,7 +67,7 @@ pub const Test_Device = struct {
 
     pub fn clock_device(dev: *Test_Device) Clock_Device {
         return Clock_Device{
-            .object = dev,
+            .ptr = dev,
             .vtable = &vtable,
         };
     }

drivers/base/Datagram_Device.zig

@@ -12,9 +12,9 @@ const Datagram_Device = @This();
 
 /// Pointer to the object implementing the driver.
 ///
-/// If the implementation requires no `object` pointer,
+/// If the implementation requires no `ptr` pointer,
 /// you can safely use `undefined` here.
-object: *anyopaque,
+ptr: *anyopaque,
 
 /// Virtual table for the datagram device functions.
 vtable: *const VTable,
@@ -27,14 +27,14 @@ pub const ConnectError = BaseError || error{DeviceBusy};
 /// NOTE: Call `.disconnect()` when the usage of the device is done to release it.
 pub fn connect(dd: Datagram_Device) ConnectError!void {
     if (dd.vtable.connect_fn) |connectFn| {
-        return connectFn(dd.object);
+        return connectFn(dd.ptr);
     }
 }
 
 /// Releases a device from the connection.
 pub fn disconnect(dd: Datagram_Device) void {
     if (dd.vtable.disconnect_fn) |disconnectFn| {
-        return disconnectFn(dd.object);
+        return disconnectFn(dd.ptr);
     }
 }
 
@@ -48,7 +48,7 @@ pub fn write(dd: Datagram_Device, datagram: []const u8) WriteError!void {
 /// Writes a single `datagram` to the device.
 pub fn writev(dd: Datagram_Device, datagrams: []const []const u8) WriteError!void {
     const writev_fn = dd.vtable.writev_fn orelse return error.Unsupported;
-    return writev_fn(dd.object, datagrams);
+    return writev_fn(dd.ptr, datagrams);
 }
 
 pub const ReadError = BaseError || error{ Unsupported, NotConnected, BufferOverrun };
@@ -71,7 +71,7 @@ pub fn read(dd: Datagram_Device, datagram: []u8) ReadError!usize {
 /// will be discarded.
 pub fn readv(dd: Datagram_Device, datagrams: []const []u8) ReadError!usize {
     const readv_fn = dd.vtable.readv_fn orelse return error.Unsupported;
-    return readv_fn(dd.object, datagrams);
+    return readv_fn(dd.ptr, datagrams);
 }
 
 pub const VTable = struct {
@@ -134,7 +134,7 @@ pub const Test_Device = struct {
 
     pub fn datagram_device(td: *Test_Device) Datagram_Device {
         return Datagram_Device{
-            .object = td,
+            .ptr = td,
             .vtable = &vtable,
         };
     }

drivers/base/Digital_IO.zig

@@ -10,9 +10,9 @@ const Digital_IO = @This();
 
 /// Pointer to the object implementing the driver.
 ///
-/// If the implementation requires no `object` pointer,
+/// If the implementation requires no `ptr` pointer,
 /// you can safely use `undefined` here.
-object: *anyopaque,
+ptr: *anyopaque,
 
 /// Virtual table for the digital i/o functions.
 vtable: *const VTable,
@@ -40,23 +40,23 @@ pub const Direction = enum { input, output };
 
 /// Sets the direction of the pin.
 pub fn set_direction(dio: Digital_IO, dir: Direction) SetDirError!void {
-    return dio.vtable.set_direction_fn(dio.object, dir);
+    return dio.vtable.set_direction_fn(dio.ptr, dir);
 }
 
 /// Sets if the pin has a bias towards either `low` or `high` or no bias at all.
 /// Bias is usually implemented with pull-ups and pull-downs.
 pub fn set_bias(dio: Digital_IO, bias: ?State) SetBiasError!void {
-    return dio.vtable.set_bias_fn(dio.object, bias);
+    return dio.vtable.set_bias_fn(dio.ptr, bias);
 }
 
 /// Changes the state of the pin.
 pub fn write(dio: Digital_IO, state: State) WriteError!void {
-    return dio.vtable.write_fn(dio.object, state);
+    return dio.vtable.write_fn(dio.ptr, state);
 }
 
 /// Reads the state state of the pin.
 pub fn read(dio: Digital_IO) ReadError!State {
-    return dio.vtable.read_fn(dio.object);
+    return dio.vtable.read_fn(dio.ptr);
 }
 
 pub const VTable = struct {
@@ -79,7 +79,7 @@ pub const Test_Device = struct {
 
     pub fn digital_io(dev: *Test_Device) Digital_IO {
         return Digital_IO{
-            .object = dev,
+            .ptr = dev,
             .vtable = &vtable,
         };
     }

drivers/base/Stream_Device.zig

@@ -11,9 +11,9 @@ const Stream_Device = @This();
 
 /// Pointer to the object implementing the driver.
 ///
-/// If the implementation requires no `object` pointer,
+/// If the implementation requires no `ptr` pointer,
 /// you can safely use `undefined` here.
-object: *anyopaque,
+ptr: *anyopaque,
 
 /// Virtual table for the stream device functions.
 vtable: *const VTable,
@@ -28,13 +28,13 @@ pub const ReadError = BaseError || error{ Unsupported, NotConnected };
 /// NOTE: Call `.disconnect()` when the usage of the device is done to release it.
 pub fn connect(sd: Stream_Device) ConnectError!void {
     const connect_fn = sd.vtable.connect_fn orelse return;
-    return connect_fn(sd.object);
+    return connect_fn(sd.ptr);
 }
 
 /// Releases a device from the connection.
 pub fn disconnect(sd: Stream_Device) void {
     const disconnect_fn = sd.vtable.disconnect_fn orelse return;
-    return disconnect_fn(sd.object);
+    return disconnect_fn(sd.ptr);
 }
 
 /// Writes some `bytes` to the device and returns the number of bytes written.
@@ -45,7 +45,7 @@ pub fn write(sd: Stream_Device, bytes: []const u8) WriteError!usize {
 /// Writes some `bytes` to the device and returns the number of bytes written.
 pub fn writev(sd: Stream_Device, bytes_vec: []const []const u8) WriteError!usize {
     const writev_fn = sd.vtable.writev_fn orelse return error.Unsupported;
-    return writev_fn(sd.object, bytes_vec);
+    return writev_fn(sd.ptr, bytes_vec);
 }
 
 /// Reads some `bytes` to the device and returns the number of bytes read.
@@ -56,7 +56,7 @@ pub fn read(sd: Stream_Device, bytes: []u8) ReadError!usize {
 /// Reads some `bytes` to the device and returns the number of bytes read.
 pub fn readv(sd: Stream_Device, bytes_vec: []const []u8) ReadError!usize {
     const readv_fn = sd.vtable.readv_fn orelse return error.Unsupported;
-    return readv_fn(sd.object, bytes_vec);
+    return readv_fn(sd.ptr, bytes_vec);
 }
 
 pub const Reader = std.io.Reader(Stream_Device, ReadError, reader_read);
@@ -118,7 +118,7 @@ pub const Test_Device = struct {
 
     pub fn stream_device(td: *Test_Device) Stream_Device {
         return Stream_Device{
-            .object = td,
+            .ptr = td,
             .vtable = &vtable,
         };
     }

drivers/io_expander/pcf8574.zig

@@ -88,7 +88,7 @@ pub fn PCF8574(comptime config: PCF8574_Config) type {
 
         pub fn digital_IO(self: *Self, pin: u3) Digital_IO {
             return Digital_IO{
-                .object = &self.pin_arr[pin],
+                .ptr = &self.pin_arr[pin],
                 .vtable = &vtable,
             };
         }

port/raspberrypi/rp2xxx/src/hal/drivers.zig

@@ -37,7 +37,7 @@ pub const I2C_Device = struct {
 
     pub fn datagram_device(dev: *I2C_Device) Datagram_Device {
         return .{
-            .object = dev,
+            .ptr = dev,
             .vtable = &vtable,
         };
     }
@@ -152,7 +152,7 @@ pub const SPI_Device = struct {
 
     pub fn datagram_device(dev: *SPI_Device) Datagram_Device {
         return .{
-            .object = dev,
+            .ptr = dev,
             .vtable = &vtable,
         };
     }
@@ -244,7 +244,7 @@ pub const GPIO_Device = struct {
 
     pub fn digital_io(dio: *GPIO_Device) Digital_IO {
         return Digital_IO{
-            .object = dio,
+            .ptr = dio,
             .vtable = &vtable,
         };
     }
@@ -309,7 +309,7 @@ pub const ClockDevice = struct {
     pub fn clock_device(td: *ClockDevice) Clock_Device {
         _ = td;
         return Clock_Device{
-            .object = undefined,
+            .ptr = undefined,
             .vtable = &vtable,
         };
     }