Skip to content

feat(dock): support compositor-driven dock resize - #1732

Open
gugullll wants to merge 1 commit into
linuxdeepin:masterfrom
gugullll:master
Open

feat(dock): support compositor-driven dock resize#1732
gugullll wants to merge 1 commit into
linuxdeepin:masterfrom
gugullll:master

Conversation

@gugullll

@gugullll gugullll commented Sep 10, 2026

Copy link
Copy Markdown

Add a client wrapper for the treeland layer-shell-extension protocol and wire it into the dock so the compositor owns the interactive resize (referenced protocol PR linuxdeepin/treeland-protocols#104).

加入 layer-shell-extension 协议客户端封装,合成器接管 dock 交互缩放,
替代客户端自身拖拽逻辑。

Log: dock 支持合成器接管缩放
PMS: BUG-294673
Influence: 合成器接管 dock 缩放交互,状态机改为 compositorOwnsResize 驱动,
拖拽期间屏蔽客户端手动计算,flow 与可执行尺寸更稳定。

Summary by Sourcery

Enable the compositor to own dock resize interactions while retaining client-side resizing as a fallback.

New Features:

  • Add compositor-driven interactive dock resizing through the Treeland layer-shell extension protocol.

Bug Fixes:

  • Prevent client-side drag calculations and stray pointer releases from interfering while the compositor controls resizing.

Enhancements:

  • Expose resize-edge metadata and synchronize dock size and resize state with compositor configure events.

Build:

  • Generate and compile the Treeland layer-shell extension Wayland client protocol.

@deepin-ci-robot

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gugullll

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sourcery-ai

sourcery-ai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Reviewer's Guide

The dock now negotiates compositor-owned interactive resizing through the Treeland layer-shell extension, passing Wayland input and size constraints to the compositor and adapting the QML drag state machine to consume compositor-driven size and lifecycle updates, with legacy client-side resizing retained as a fallback.

Sequence diagram for compositor-driven dock resize

sequenceDiagram
    actor User
    participant DragArea
    participant DockPanel
    participant LayerShell as LayerShellExtension
    participant Compositor

    User->>DragArea: onPressed
    DragArea->>DockPanel: beginDockResize(edges)
    DockPanel->>LayerShell: getLayerShellExtensionObject(surface)
    DockPanel->>LayerShell: beginResize(seat, serial, edges, constraints)
    LayerShell->>Compositor: begin_resize(...)
    Compositor-->>LayerShell: resizing(1)
    LayerShell-->>DockPanel: resizingChanged(true)
    DockPanel-->>DragArea: onIsResizingChanged(true)
    Compositor-->>DragArea: configure size
    DragArea->>DragArea: update dockSize from width or height
    User-->>Compositor: release pointer
    Compositor-->>LayerShell: resizing(0)
    LayerShell-->>DockPanel: resizingChanged(false)
    DockPanel-->>DragArea: onIsResizingChanged(false)
    DragArea->>DragArea: finishResize()
Loading

Flow diagram for dock resize fallback

flowchart TD
    Press["Dock drag begins"] --> Begin["Panel.beginDockResize(edges)"]
    Begin --> Available{"Layer-shell extension active and Wayland handles available?"}
    Available -->|Yes| Compositor["Compositor owns resize"]
    Compositor --> Ignore["Ignore client-side position calculations"]
    Ignore --> Configure["Apply compositor-driven width or height"]
    Configure --> End["resizingChanged(false) and finishResize()"]
    Available -->|No| Legacy["Use legacy client-side drag logic"]
    Legacy --> End
Loading

File-Level Changes

Change Details Files
Add a Qt Wayland client wrapper for Treeland’s layer-shell extension resize protocol.
  • Generate the new protocol client sources during the dock build.
  • Wrap the manager and per-surface object, including resize requests and compositor resizing notifications.
  • Track the native wl_surface and expose resize-state changes to the dock panel.
panels/dock/CMakeLists.txt
panels/dock/layershellextension.h
panels/dock/layershellextension.cpp
Route dock resize initiation through the compositor when the extension is available, while preserving the legacy fallback.
  • Create the protocol manager on Wayland and lazily bind an extension object to the current dock surface.
  • Pass the current seat, pointer serial, resize edge, and orientation-specific size limits to begin_resize.
  • Forward compositor resize notifications into the panel resize state and return failure when the protocol path cannot be used.
panels/dock/dockpanel.h
panels/dock/dockpanel.cpp
panels/dock/constants.h
Update the QML drag state machine to defer interactive resizing and completion to the compositor.
  • Add compositor ownership and notification state flags around drag initiation.
  • Skip client-side mouse-delta resizing while compositor ownership is active and synchronize dockSize from compositor-driven width or height changes.
  • Ignore stray pointer releases during compositor resizing and finalize state when the compositor reports resizing ended.
panels/dock/package/main.qml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've found 2 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="panels/dock/package/main.qml" line_range="656-671" />
<code_context>
             recentDeltas = []
             Panel.requestClosePopup()
+
+            var edges = 0
+            if (Panel.position === Dock.Bottom) {
+                edges = Dock.ResizeEdgeTop
+            } else if (Panel.position === Dock.Top) {
+                edges = Dock.ResizeEdgeBottom
+            } else if (Panel.position === Dock.Right) {
+                edges = Dock.ResizeEdgeLeft
+            } else if (Panel.position === Dock.Left) {
+                edges = Dock.ResizeEdgeRight
+            }
+            dock.resizingReceived = false
+            var accepted = Panel.beginDockResize(edges)
</code_context>
<issue_to_address>
**issue (bug_risk):** The mouse release can arrive before the compositor's asynchronous `resizing(1)` event. In that order `resizingReceived` is still false, so `finishResize()` clears `compositorOwnsResize` and releases the grab even though the compositor resize has already been requested; the later compositor resize events then run against a completed client drag and the resize state is lost.

**Triggers:** When the user presses and releases quickly before the compositor's `resizing(1)` event reaches the client.

**Suggested fix:** Track that a compositor resize was requested independently of receipt of `resizing(1)`, and defer finishing the drag until the compositor explicitly reports the resize has ended.
</issue_to_address>

### Comment 2
<location path="panels/dock/layershellextension.h" line_range="47-48" />
<code_context>
+
+    void beginResize(struct ::wl_seat *seat, uint32_t serial, uint32_t edges, int32_t minWidth, int32_t minHeight, int32_t maxWidth, int32_t maxHeight);
+
+    // Rejects begin_resize once that surface is destroyed; callers compare it
+    // against the window's current wl_surface and re-bind when it changed.
+    struct ::wl_surface *nativeSurface() const;
+
+Q_SIGNALS:
</code_context>
<issue_to_address>
**nitpick:** The comment says the wrapper rejects `begin_resize` after the surface is destroyed, but `nativeSurface()` only returns a stored pointer and performs no validity check or rejection. The actual safety behavior depends entirely on the caller comparing the pointer, so the wrapper's documented contract is false and future callers can invoke the protocol operation with a stale surface association.

**Suggested fix:** Change the comment to describe the caller-side comparison, or make `beginResize()` validate the native surface/object lifetime before issuing the request.

```suggestion
    // Returns the surface associated with this object; callers compare it
    // against the window's current wl_surface and re-bind when it changed.
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread panels/dock/package/main.qml
Comment thread panels/dock/layershellextension.h Outdated
Add a client wrapper for the treeland layer-shell-extension protocol and wire
it into the dock so the compositor owns the interactive resize (referenced
protocol PR linuxdeepin/treeland-protocols#104).

加入 layer-shell-extension 协议客户端封装,合成器接管 dock 交互缩放,
替代客户端自身拖拽逻辑。

Log: dock 支持合成器接管缩放
PMS: BUG-294673
Influence: 合成器接管 dock 缩放交互,状态机改为 compositorOwnsResize 驱动,
          拖拽期间屏蔽客户端手动计算,flow 与可执行尺寸更稳定。
@deepin-ci-robot

Copy link
Copy Markdown

deepin pr auto review

🤖 AI 代码审查报告

总体评分: 93 分 (通过阈值: 70分)

Pass


📊 总体评价

项目 结果
审查结论 代码审查通过
评分详情 总体评分 93 分,大于 70 分通过阈值。本次变更新增 layer-shell-extension 协议客户端封装,实现合成器驱动的 dock 交互缩放,代码结构清晰,无安全漏洞,建议补充防御性编程和日志输出。

🔍 详细分析

1. 语法逻辑 ✅

评价: 良好 ✅ 通过

潜在问题:

  1. panels/dock/dockpanel.cpp:540 - window()->handle() 调用前未检查 window() 是否为空,缺少防御性编程
  2. panels/dock/dockpanel.h:94 - beginDockResize 的 edges 参数未校验枚举值有效性

建议: 在 window()->handle() 调用前增加 window() 空指针检查;在 beginDockResize 入口处对 edges 参数进行枚举值校验


2. 代码质量 ✅

评价: 良好 ✅ 通过

潜在问题:

  1. panels/dock/constants.h:59 - ResizeEdge 枚举缺少注释说明其匹配 Wayland 协议枚举而非位掩码
  2. panels/dock/dockpanel.cpp:540 - 多个失败路径静默返回 false,缺少日志输出
  3. panels/dock/layershellextension.cpp:20 - 构造函数参数 surface 命名与实际类型不符,应为 object 或 extensionObject

建议: 为 ResizeEdge 枚举添加注释说明其匹配 Wayland 协议枚举;在失败路径添加日志输出;将构造函数第一个参数重命名为 object 或 extensionObject


3. 代码性能 ✅

评价: 优秀 ✅ 通过

潜在问题:
✅ 未发现明显问题

建议: 性能良好,无需优化


4. 代码安全 🔒

评价: 优秀 ✅ 通过

🔐 发现 0 个安全漏洞

安全漏洞详情:
✅ 未发现安全漏洞

建议: 无安全漏洞,代码使用 QScopedPointer 进行 RAII 资源管理,Wayland 协议调用参数约束合理


💡 改进建议代码示例

// dockpanel.cpp - 增加防御性检查和日志
bool DockPanel::beginDockResize(uint edges)
{
    // 校验 edges 参数
    switch (edges) {
    case ResizeEdgeTop: case ResizeEdgeBottom: case ResizeEdgeLeft:
    case ResizeEdgeTopLeft: case ResizeEdgeBottomLeft: case ResizeEdgeRight:
    case ResizeEdgeTopRight: case ResizeEdgeBottomRight:
        break;
    default:
        qCWarning(dockLog) << "beginDockResize: invalid edges value" << edges;
        return false;
    }

    if (!m_dockShellExtensionManager)
        return false;
    if (!m_dockShellExtensionManager->isActive())
        return false;

    auto *w = window();
    if (!w) {
        qCWarning(dockLog) << "beginDockResize: window is null";
        return false;
    }

    auto *waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow *>(w->handle());
    if (!waylandWindow) {
        qCWarning(dockLog) << "beginDockResize: failed to get QWaylandWindow";
        return false;
    }
    // ... remaining checks with logging
}

本报告由 AI 代码审查工具自动生成

@deepin-bot

deepin-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown

TAG Bot

New tag: 2.0.54
DISTRIBUTION: unstable
Suggest: synchronizing this PR through rebase #1733

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants