treeland-protocol-template.xml

<?xml version="1.0" encoding="UTF-8"?>
<protocol name="treeland_example_v1">
    <copyright><![CDATA[
    SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd.
    SPDX-License-Identifier: MIT
    ]]></copyright>

    <description summary="one-line protocol summary">
        Replace this description with the protocol's purpose, object model, and
        lifecycle guarantees.

        If this specification uses RFC 2119 keywords normatively, include the
        standard interpretation paragraph here.
    </description>

    <interface name="treeland_example_manager_v1" version="1">
        <description summary="manager global">
            Describe what this global creates, any singleton or binding rules,
            and a brief high-level workflow for clients.
        </description>

        <enum name="error">
            <entry name="invalid_argument" value="0"
                summary="an invalid argument was provided"/>
        </enum>

        <request name="destroy" type="destructor">
            <description summary="destroy the manager object">
                Describe whether child objects must be destroyed first.
            </description>
        </request>

        <request name="create_example">
            <description summary="create an example object">
                Describe ownership, required call scenarios, preconditions, and
                lifetime expectations.
            </description>
            <arg name="id" type="new_id" interface="treeland_example_object_v1"/>
            <arg name="surface" type="object" interface="wl_surface"/>
        </request>
    </interface>

    <interface name="treeland_example_object_v1" version="1">
        <description summary="example per-object interface">
            Describe the object's state, lifetime, and relation to Wayland core objects.
        </description>

        <enum name="mode">
            <entry name="default" value="0" summary="default mode"/>
        </enum>

        <request name="destroy" type="destructor">
            <description summary="destroy the object">
                Describe any ordering constraints with related objects.
            </description>
        </request>

        <request name="set_mode">
            <description summary="set pending mode">
                Describe whether this is immediate or latched until commit.
            </description>
            <arg name="mode" type="uint" enum="mode" summary="requested mode"/>
        </request>

        <event name="configured">
            <description summary="notify current state">
                Describe event meaning, compositor-side trigger timing, and what
                the client should do next.
            </description>
            <arg name="serial" type="uint" summary="configuration serial"/>
        </event>
    </interface>
</protocol>