Separate View from its implementation

This is done in preperation for Xwayland support

src/command/close_view.zig

@@ -8,6 +8,6 @@ pub fn close_view(seat: *Seat, arg: Arg) void {
     if (seat.focused_view) |view| {
         // Note: we don't call arrange() here as it will be called
         // automatically when the view is unmapped.
-        c.wlr_xdg_toplevel_send_close(view.wlr_xdg_surface);
+        view.close();
     }
 }

src/cursor.zig

@@ -373,13 +373,15 @@ pub const Cursor = struct {
             if (view.floating != floating) {
                 continue;
             }
-            const surface = c.wlr_xdg_surface_surface_at(
+            const surface = switch (view.impl) {
-                view.wlr_xdg_surface,
+                .xdg_toplevel => |xdg_toplevel| c.wlr_xdg_surface_surface_at(
-                ox - @intToFloat(f64, view.current_box.x),
+                    xdg_toplevel.wlr_xdg_surface,
-                oy - @intToFloat(f64, view.current_box.y),
+                    ox - @intToFloat(f64, view.current_box.x),
-                sx,
+                    oy - @intToFloat(f64, view.current_box.y),
-                sy,
+                    sx,
-            );
+                    sy,
+                ),
+            };
             if (surface) |found| {
                 return found;
             }

src/output.zig

@@ -119,7 +119,7 @@ pub const Output = struct {
     /// when it is mapped.
     pub fn addView(self: *Self, wlr_xdg_surface: *c.wlr_xdg_surface) void {
         const node = self.root.server.allocator.create(ViewStack(View).Node) catch unreachable;
-        node.view.init(self, wlr_xdg_surface, self.current_focused_tags);
+        node.view.init_xdg_toplevel(self, self.current_focused_tags, wlr_xdg_surface);
         self.views.push(node);
     }
 

src/render.zig

@@ -207,9 +207,7 @@ fn renderView(output: Output, view: *View, now: *c.timespec) void {
             .when = now,
         };
 
-        // This calls our render_surface function for each surface among the
+        view.forEachSurface(renderSurface, &rdata);
-        // xdg_surface's toplevel and popups.
-        c.wlr_xdg_surface_for_each_surface(view.wlr_xdg_surface, renderSurface, &rdata);
     }
 }
 

src/root.zig

@@ -111,7 +111,7 @@ pub const Root = struct {
                 view.pending_serial = null;
 
                 if (view.needsConfigure()) {
-                    view.configurePending();
+                    view.configure();
                     self.pending_configures += 1;
 
                     // We save the current buffer, so we can send an early

src/seat.zig

@@ -147,10 +147,11 @@ pub const Seat = struct {
         }) {
             return;
         }
+
         // Obtain the target wlr_surface
         const target_wlr_surface = switch (focus_target) {
-            .view => |target_view| target_view.wlr_xdg_surface.surface,
+            .view => |target_view| target_view.wlr_surface.?,
-            .layer => |target_layer| target_layer.wlr_layer_surface.surface,
+            .layer => |target_layer| target_layer.wlr_layer_surface.surface.?,
             .none => null,
         };
 

src/view.zig

@@ -6,14 +6,23 @@ const Log = @import("log.zig").Log;
 const Output = @import("output.zig").Output;
 const Root = @import("root.zig").Root;
 const ViewStack = @import("view_stack.zig").ViewStack;
+const XdgToplevel = @import("xdg_toplevel.zig");
 
 pub const View = struct {
     const Self = @This();
 
-    output: *Output,
+    const ViewImpl = union(enum) {
-    wlr_xdg_surface: *c.wlr_xdg_surface,
+        xdg_toplevel: XdgToplevel,
+    };
 
-    mapped: bool,
+    /// The implementation of this view
+    impl: ViewImpl,
+
+    /// The output this view is currently associated with
+    output: *Output,
+
+    /// This is non-null exactly when the view is mapped
+    wlr_surface: ?*c.wlr_surface,
 
     /// If the view is floating or not
     floating: bool,
@@ -21,6 +30,7 @@ pub const View = struct {
     /// True if the view is currentlt focused by at lease one seat
     focused: bool,
 
+    /// The current output-relative coordinates and dimensions of the view
     current_box: Box,
     pending_box: ?Box,
 
@@ -36,25 +46,15 @@ pub const View = struct {
     // This is what we render while a transaction is in progress
     stashed_buffer: ?*c.wlr_buffer,
 
-    // Listeners that are always active over the view's lifetime
+    pub fn init_xdg_toplevel(
-    listen_destroy: c.wl_listener,
+        self: *Self,
-    listen_map: c.wl_listener,
+        output: *Output,
-    listen_unmap: c.wl_listener,
+        tags: u32,
-
+        wlr_xdg_surface: *c.wlr_xdg_surface,
-    // Listeners that are only active while the view is mapped
+    ) void {
-    listen_commit: c.wl_listener,
-
-    pub fn init(self: *Self, output: *Output, wlr_xdg_surface: *c.wlr_xdg_surface, tags: u32) void {
         self.output = output;
-        self.wlr_xdg_surface = wlr_xdg_surface;
-        wlr_xdg_surface.data = self;
 
-        // Inform the xdg toplevel that it is tiled.
+        self.wlr_surface = null;
-        // For example this prevents firefox from drawing shadows around itself
-        _ = c.wlr_xdg_toplevel_set_tiled(self.wlr_xdg_surface, c.WLR_EDGE_LEFT |
-            c.WLR_EDGE_RIGHT | c.WLR_EDGE_TOP | c.WLR_EDGE_BOTTOM);
-
-        self.mapped = false;
 
         self.focused = false;
 
@@ -73,15 +73,8 @@ pub const View = struct {
 
         self.stashed_buffer = null;
 
-        // Add listeners that are active over the view's entire lifetime
+        self.impl = .{ .xdg_toplevel = undefined };
-        self.listen_destroy.notify = handleDestroy;
+        self.impl.xdg_toplevel.init(self, wlr_xdg_surface);
-        c.wl_signal_add(&self.wlr_xdg_surface.events.destroy, &self.listen_destroy);
-
-        self.listen_map.notify = handleMap;
-        c.wl_signal_add(&self.wlr_xdg_surface.events.map, &self.listen_map);
-
-        self.listen_unmap.notify = handleUnmap;
-        c.wl_signal_add(&self.wlr_xdg_surface.events.unmap, &self.listen_unmap);
     }
 
     pub fn deinit(self: *Self) void {
@@ -99,24 +92,20 @@ pub const View = struct {
         }
     }
 
-    pub fn configurePending(self: *Self) void {
+    pub fn configure(self: Self) void {
         if (self.pending_box) |pending_box| {
-            const border_width = self.output.root.server.config.border_width;
+            switch (self.impl) {
-            const view_padding = self.output.root.server.config.view_padding;
+                .xdg_toplevel => |xdg_toplevel| xdg_toplevel.configure(pending_box),
-            self.pending_serial = c.wlr_xdg_toplevel_set_size(
+            }
-                self.wlr_xdg_surface,
-                pending_box.width - border_width * 2 - view_padding * 2,
-                pending_box.height - border_width * 2 - view_padding * 2,
-            );
         } else {
-            // TODO: log warning
+            Log.Error.log("Configre called on a View with no pending box", .{});
         }
     }
 
     pub fn sendFrameDone(self: Self) void {
         var now: c.timespec = undefined;
         _ = c.clock_gettime(c.CLOCK_MONOTONIC, &now);
-        c.wlr_surface_send_frame_done(self.wlr_xdg_surface.surface, &now);
+        c.wlr_surface_send_frame_done(self.wlr_surface.?, &now);
     }
 
     pub fn dropStashedBuffer(self: *Self) void {
@@ -129,20 +118,19 @@ pub const View = struct {
 
     pub fn stashBuffer(self: *Self) void {
         // TODO: log debug error if there is already a saved buffer
-        const wlr_surface = self.wlr_xdg_surface.surface;
+        if (self.wlr_surface) |wlr_surface| {
-        if (c.wlr_surface_has_buffer(wlr_surface)) {
+            if (c.wlr_surface_has_buffer(wlr_surface)) {
-            _ = c.wlr_buffer_ref(wlr_surface.*.buffer);
+                _ = c.wlr_buffer_ref(wlr_surface.buffer);
-            self.stashed_buffer = wlr_surface.*.buffer;
+                self.stashed_buffer = wlr_surface.buffer;
+            }
         }
     }
 
     /// Set the focued bool and the active state of the view if it is a toplevel
     pub fn setFocused(self: *Self, focused: bool) void {
         self.focused = focused;
-        if (self.wlr_xdg_surface.role ==
+        switch (self.impl) {
-            c.enum_wlr_xdg_surface_role.WLR_XDG_SURFACE_ROLE_TOPLEVEL)
+            .xdg_toplevel => |xdg_toplevel| xdg_toplevel.setActivated(focused),
-        {
-            _ = c.wlr_xdg_toplevel_set_activated(self.wlr_xdg_surface, focused);
         }
     }
 
@@ -172,99 +160,25 @@ pub const View = struct {
         self.output.views.remove(node);
         destination_output.views.push(node);
 
-        c.wlr_surface_send_leave(self.wlr_xdg_surface.surface, self.output.wlr_output);
+        c.wlr_surface_send_leave(self.wlr_surface, self.output.wlr_output);
-        c.wlr_surface_send_enter(self.wlr_xdg_surface.surface, destination_output.wlr_output);
+        c.wlr_surface_send_enter(self.wlr_surface, destination_output.wlr_output);
 
         self.output = destination_output;
     }
 
-    fn handleDestroy(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
+    pub fn close(self: Self) void {
-        const self = @fieldParentPtr(Self, "listen_destroy", listener.?);
+        switch (self.impl) {
-        const output = self.output;
+            .xdg_toplevel => |xdg_toplevel| xdg_toplevel.close(),
-
+        }
-        // Remove listeners that are active for the entire lifetime of the view
-        c.wl_list_remove(&self.listen_destroy.link);
-        c.wl_list_remove(&self.listen_map.link);
-        c.wl_list_remove(&self.listen_unmap.link);
-
-        // Remove the view from the stack
-        const node = @fieldParentPtr(ViewStack(View).Node, "view", self);
-        output.views.remove(node);
-        output.root.server.allocator.destroy(node);
     }
 
-    /// Called when the surface is mapped, or ready to display on-screen.
+    pub fn forEachSurface(
-    fn handleMap(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
+        self: Self,
-        const self = @fieldParentPtr(Self, "listen_map", listener.?);
+        iterator: c.wlr_surface_iterator_func_t,
-        const root = self.output.root;
+        user_data: ?*c_void,
-
+    ) void {
-        // Add listeners that are only active while mapped
+        switch (self.impl) {
-        self.listen_commit.notify = handleCommit;
+            .xdg_toplevel => |xdg_toplevel| xdg_toplevel.forEachSurface(iterator, user_data),
-        c.wl_signal_add(&self.wlr_xdg_surface.surface.*.events.commit, &self.listen_commit);
-
-        self.mapped = true;
-        self.floating = false;
-
-        self.natural_width = @intCast(u32, self.wlr_xdg_surface.geometry.width);
-        self.natural_height = @intCast(u32, self.wlr_xdg_surface.geometry.height);
-
-        if (self.natural_width == 0 and self.natural_height == 0) {
-            self.natural_width = @intCast(u32, self.wlr_xdg_surface.surface.*.current.width);
-            self.natural_height = @intCast(u32, self.wlr_xdg_surface.surface.*.current.height);
         }
-
-        const app_id: ?[*:0]const u8 = self.wlr_xdg_surface.unnamed_166.toplevel.*.app_id;
-        Log.Debug.log("View with app_id '{}' mapped", .{if (app_id) |id| id else "NULL"});
-
-        // Make views with app_ids listed in the float filter float
-        if (app_id) |id| {
-            for (self.output.root.server.config.float_filter.items) |filter_app_id| {
-                if (std.mem.eql(u8, std.mem.span(id), std.mem.span(filter_app_id))) {
-                    self.setFloating(true);
-                    break;
-                }
-            }
-        }
-
-        // Focus the newly mapped view. Note: if a seat is focusing a different output
-        // it will continue to do so.
-        var it = root.server.input_manager.seats.first;
-        while (it) |seat_node| : (it = seat_node.next) {
-            seat_node.data.focus(self);
-        }
-
-        c.wlr_surface_send_enter(self.wlr_xdg_surface.surface, self.output.wlr_output);
-
-        self.output.root.arrange();
-    }
-
-    /// Called when the surface is unmapped and will no longer be displayed.
-    fn handleUnmap(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
-        const self = @fieldParentPtr(Self, "listen_unmap", listener.?);
-        const root = self.output.root;
-        self.mapped = false;
-
-        // Inform all seats that the view has been unmapped so they can handle focus
-        var it = root.server.input_manager.seats.first;
-        while (it) |node| : (it = node.next) {
-            const seat = &node.data;
-            seat.handleViewUnmap(self);
-        }
-
-        root.arrange();
-
-        // Remove listeners that are only active while mapped
-        c.wl_list_remove(&self.listen_commit.link);
-    }
-
-    fn handleCommit(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
-        const self = @fieldParentPtr(Self, "listen_commit", listener.?);
-        if (self.pending_serial) |s| {
-            if (s == self.wlr_xdg_surface.configure_serial) {
-                self.output.root.notifyConfigured();
-                self.pending_serial = null;
-            }
-        }
-        // TODO: check for unexpected change in size and react as needed
     }
 };

src/view_stack.zig

@@ -75,7 +75,7 @@ pub fn ViewStack(comptime T: type) type {
             /// This function is horribly ugly, but it's well tested below.
             pub fn next(self: *Iterator) ?*Node {
                 while (self.it) |node| : (self.it = if (self.reverse) node.prev else node.next) {
-                    if (node.view.mapped and if (self.pending)
+                    if (node.view.wlr_surface != null and if (self.pending)
                         if (node.view.pending_tags) |pending_tags|
                             self.tags & pending_tags != 0
                         else

src/xdg_toplevel.zig

@@ -0,0 +1,166 @@
+const Self = @This();
+
+const c = @import("c.zig");
+const std = @import("std");
+
+const Box = @import("box.zig").Box;
+const Log = @import("log.zig").Log;
+const View = @import("view.zig").View;
+const ViewStack = @import("view_stack.zig").ViewStack;
+
+/// The view this xdg toplevel implements
+view: *View,
+
+/// The corresponding wlroots object
+wlr_xdg_surface: *c.wlr_xdg_surface,
+
+// Listeners that are always active over the view's lifetime
+listen_destroy: c.wl_listener,
+listen_map: c.wl_listener,
+listen_unmap: c.wl_listener,
+
+// Listeners that are only active while the view is mapped
+listen_commit: c.wl_listener,
+
+pub fn init(self: *Self, view: *View, wlr_xdg_surface: *c.wlr_xdg_surface) void {
+    self.view = view;
+    self.wlr_xdg_surface = wlr_xdg_surface;
+    wlr_xdg_surface.data = self;
+
+    // Inform the xdg toplevel that it is tiled.
+    // For example this prevents firefox from drawing shadows around itself
+    _ = c.wlr_xdg_toplevel_set_tiled(self.wlr_xdg_surface, c.WLR_EDGE_LEFT |
+        c.WLR_EDGE_RIGHT | c.WLR_EDGE_TOP | c.WLR_EDGE_BOTTOM);
+
+    // Add listeners that are active over the view's entire lifetime
+    self.listen_destroy.notify = handleDestroy;
+    c.wl_signal_add(&self.wlr_xdg_surface.events.destroy, &self.listen_destroy);
+
+    self.listen_map.notify = handleMap;
+    c.wl_signal_add(&self.wlr_xdg_surface.events.map, &self.listen_map);
+
+    self.listen_unmap.notify = handleUnmap;
+    c.wl_signal_add(&self.wlr_xdg_surface.events.unmap, &self.listen_unmap);
+}
+
+pub fn configure(self: Self, pending_box: Box) void {
+    const border_width = self.view.output.root.server.config.border_width;
+    const view_padding = self.view.output.root.server.config.view_padding;
+    self.view.pending_serial = c.wlr_xdg_toplevel_set_size(
+        self.wlr_xdg_surface,
+        pending_box.width - border_width * 2 - view_padding * 2,
+        pending_box.height - border_width * 2 - view_padding * 2,
+    );
+}
+
+pub fn setActivated(self: Self, activated: bool) void {
+    _ = c.wlr_xdg_toplevel_set_activated(self.wlr_xdg_surface, activated);
+}
+
+/// Close the view. This will lead to the unmap and destroy events being sent
+pub fn close(self: Self) void {
+    c.wlr_xdg_toplevel_send_close(self.wlr_xdg_surface);
+}
+
+pub fn forEachSurface(
+    self: Self,
+    iterator: c.wlr_surface_iterator_func_t,
+    user_data: ?*c_void,
+) void {
+    c.wlr_xdg_surface_for_each_surface(self.wlr_xdg_surface, iterator, user_data);
+}
+/// Called when the xdg surface is destroyed
+fn handleDestroy(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
+    const self = @fieldParentPtr(Self, "listen_destroy", listener.?);
+    const output = self.view.output;
+
+    // Remove listeners that are active for the entire lifetime of the view
+    c.wl_list_remove(&self.listen_destroy.link);
+    c.wl_list_remove(&self.listen_map.link);
+    c.wl_list_remove(&self.listen_unmap.link);
+
+    // Remove the view from the stack
+    const node = @fieldParentPtr(ViewStack(View).Node, "view", self.view);
+    output.views.remove(node);
+    output.root.server.allocator.destroy(node);
+}
+
+/// Called when the xdg surface is mapped, or ready to display on-screen.
+fn handleMap(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
+    const self = @fieldParentPtr(Self, "listen_map", listener.?);
+    const view = self.view;
+    const root = view.output.root;
+
+    // Add listeners that are only active while mapped
+    self.listen_commit.notify = handleCommit;
+    c.wl_signal_add(&self.wlr_xdg_surface.surface.*.events.commit, &self.listen_commit);
+
+    view.wlr_surface = self.wlr_xdg_surface.surface;
+    view.floating = false;
+
+    view.natural_width = @intCast(u32, self.wlr_xdg_surface.geometry.width);
+    view.natural_height = @intCast(u32, self.wlr_xdg_surface.geometry.height);
+
+    if (view.natural_width == 0 and view.natural_height == 0) {
+        view.natural_width = @intCast(u32, self.wlr_xdg_surface.surface.*.current.width);
+        view.natural_height = @intCast(u32, self.wlr_xdg_surface.surface.*.current.height);
+    }
+
+    const app_id: ?[*:0]const u8 = self.wlr_xdg_surface.unnamed_166.toplevel.*.app_id;
+    Log.Debug.log("View with app_id '{}' mapped", .{if (app_id) |id| id else "NULL"});
+
+    // Make views with app_ids listed in the float filter float
+    if (app_id) |id| {
+        for (root.server.config.float_filter.items) |filter_app_id| {
+            if (std.mem.eql(u8, std.mem.span(id), std.mem.span(filter_app_id))) {
+                view.setFloating(true);
+                break;
+            }
+        }
+    }
+
+    // Focus the newly mapped view. Note: if a seat is focusing a different output
+    // it will continue to do so.
+    var it = root.server.input_manager.seats.first;
+    while (it) |seat_node| : (it = seat_node.next) {
+        seat_node.data.focus(view);
+    }
+
+    c.wlr_surface_send_enter(self.wlr_xdg_surface.surface, view.output.wlr_output);
+
+    root.arrange();
+}
+
+/// Called when the surface is unmapped and will no longer be displayed.
+fn handleUnmap(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
+    const self = @fieldParentPtr(Self, "listen_unmap", listener.?);
+    const root = self.view.output.root;
+
+    self.view.wlr_surface = null;
+
+    // Inform all seats that the view has been unmapped so they can handle focus
+    var it = root.server.input_manager.seats.first;
+    while (it) |node| : (it = node.next) {
+        const seat = &node.data;
+        seat.handleViewUnmap(self.view);
+    }
+
+    root.arrange();
+
+    // Remove listeners that are only active while mapped
+    c.wl_list_remove(&self.listen_commit.link);
+}
+
+/// Called when the surface is comitted
+/// TODO: check for unexpected change in size and react as needed
+fn handleCommit(listener: ?*c.wl_listener, data: ?*c_void) callconv(.C) void {
+    const self = @fieldParentPtr(Self, "listen_commit", listener.?);
+    const view = self.view;
+
+    if (view.pending_serial) |s| {
+        if (s == self.wlr_xdg_surface.configure_serial) {
+            view.output.root.notifyConfigured();
+            view.pending_serial = null;
+        }
+    }
+}