<?xml version="1.0" encoding="UTF-8"?>
<protocol name="uri_shell">
  <copyright>This file is in the Public Domain, and the author
             waives all legal rights to it.</copyright>

  <description summary="A better way to use the computer">
    Most programs operate on data with a known location. This protocol
    provides the base for a windowing system centered around URIs.

    Individual windows are not provided by single apps. Instead they
    are made up of a scheme handler, which uses a URI to retrieve some
    data, and an ad-hoc series of renderers which produces the final
    wl_surface to be rendered.

    This protocol only defines the interface for scheme handlers and
    renderers to connect and facilitate the rendering of windows. The
    mechanism by which such clients are started, routed, or otherwise
    configured is out-of-scope for this protocol. Similarly, client
    enumeration, surface enumeration, and other forms of generic IPC
    are out-of-scope.

    This document is currently unstable, and should be used with the
    assumption of breaking protocol changes without version bumps.
  </description>

  <interface name="urish_wm_base" version="1">
    <request name="register_scheme">
      <description summary="Used by all scheme handlers.">
        This is what a program wishing to handle a specific scheme
        uses to inform the WM that it will do so. Only one of these may
        exist for any scheme, in all clients. Creating a new one
        for a given scheme invalidates all others.</description>
      <arg name="handle" type="new_id" interface="urish_scheme" />
      <arg name="scheme" type="string" />
      <arg name="flags" type="uint" enum="ctor_flags" />
    </request>
    <request name="register_renderer">
      <description summary="Used by all renderers.">
        This is what any renderer uses to advertise to the WM. Slugs
        must be globally unique, and attempting to reregister one
        should error.</description>
      <arg name="handle" type="new_id" interface="urish_renderer" />
      <arg name="slug" type="string" />
      <arg name="flags" type="uint" enum="ctor_flags" />
    </request>

    <request name="open_read">
      <arg name="uri" type="string" />
    </request>
    <request name="open_write">
      <arg name="uri" type="string" />
      <arg name="mime_type" type="string" />
      <arg name="data" type="fd" />
    </request>

    <enum name="ctor_flags" bitfield="true">
      <entry name="supercedable" value="1" />
    </enum>

    <enum name="error">
      <entry name="cannot_supercede" value="1" />
    </enum>
  </interface>

  <interface name="urish_scheme" version="1">
    <description summary="The service used to start rendering a page">
      
    <event name="read_request">
      <arg name="response" type="new_id" interface="urish_response" />
      <arg name="uri" type="string" />
      <arg name="flags" type="uint" enum="request_flags" />
    </event>
    <event name="write_request">
      <arg name="response" type="new_id" interface="urish_response" />
      <arg name="uri" type="string" />
      <arg name="flags" type="uint" enum="request_flags" />
      <arg name="mime_type" type="string" />
      <arg name="data" type="fd" />
    </event>

    <enum name="request_flags" bitfield="true">
      <entry name="skip_cache" value="1" />
    </enum>

    <event name="superceded" type="destructor" />
  </interface>

  <interface name="urish_renderer" version="1">
    <event name="render">
      <arg name="response" type="new_id" interface="urish_response" />
      <arg name="uri" type="string" />
      <arg name="flags" type="uint" enum="render_flags" />
      <arg name="mime_type" type="string" />
      <arg name="data" type="fd" />
    </event>

    <enum name="render_flags" bitfield="true">
      <entry name="was_write" value="1" />
    </enum>

    <event name="superceded" type="destructor" />
  </interface>

  <interface name="urish_response" version="1">
    <request name="surface" type="destructor">
      <arg name="page" type="new_id" interface="urish_page" />
      <arg name="surface" type="new_id" interface="urish_surface" />
      <arg name="raw_surface" type="object" interface="wl_surface" />
    </request>
    <request name="chain" type="destructor">
      <arg name="chain" type="new_id" interface="urish_chain" />
    </request>
    <request name="error" type="destructor">
      <arg name="title" type="string" />
      <arg name="message" type="string" />
    </request>

    <event name="metadata_int">
      <arg name="field" type="string" />
      <arg name="value" type="int" />
    </event>
    <event name="metadata_uint">
      <arg name="field" type="string" />
      <arg name="value" type="uint" />
    </event>
    <event name="metadata_fd">
      <arg name="field" type="string" />
      <arg name="value" type="fd" />
    </event>
    <event name="metadata_string">
      <arg name="field" type="string" />
      <arg name="value" type="string" />
    </event>
    <event name="metadata_fixed">
      <arg name="field" type="string" />
      <arg name="value" type="fixed" />
    </event>
    <event name="metadata_array">
      <arg name="field" type="string" />
      <arg name="value" type="array" />
    </event>

    <event name="cancel" type="destructor" />
  </interface>

  <interface name="urish_chain" version="1">
    <request name="finish" type="destructor">
      <arg name="page" type="new_id" interface="urish_page" />
      <arg name="mime_type" type="string" />
      <arg name="data" type="fd" />
    </request>
    <request name="cancel" type="destructor">
      <arg name="new_response" type="object" interface="urish_response" />
    </request>

    <event name="metadata_int">
      <arg name="field" type="string" />
      <arg name="value" type="int" />
    </event>
    <event name="metadata_uint">
      <arg name="field" type="string" />
      <arg name="value" type="uint" />
    </event>
    <event name="metadata_fd">
      <arg name="field" type="string" />
      <arg name="value" type="fd" />
    </event>
    <event name="metadata_string">
      <arg name="field" type="string" />
      <arg name="value" type="string" />
    </event>
    <event name="metadata_fixed">
      <arg name="field" type="string" />
      <arg name="value" type="fixed" />
    </event>
    <event name="metadata_array">
      <arg name="field" type="string" />
      <arg name="value" type="array" />
    </event>

    <event name="cancel" type="destructor" />
  </interface>

  <interface name="urish_page" version="1">
    <request name="close" type="destructor" />
    <event name="closed" type="destructor" />

    <request name="refresh" type="destructor" />
    <request name="hard_refresh" type="destructor" />

    <!-- link -->
    <request name="navigate_read" type="destructor">
      <arg name="uri" type="string" />
    </request>
    <request name="navigate_write" type="destructor">
      <arg name="uri" type="string" />
      <arg name="mime_type" type="string" />
      <arg name="data" type="fd" />
    </request>

    <!-- new tab -->
    <request name="open_read">
      <arg name="uri" type="string" />
    </request>
    <request name="open_write">
      <arg name="uri" type="string" />
      <arg name="mime_type" type="string" />
      <arg name="data" type="fd" />
    </request>

    <!-- as in, fork the renderer chain -->
    <request name="fork" type="destructor">
      <arg name="new_response" type="object" interface="urish_response" />
    </request>

    <!-- this exists to facilitate bookmarklets -->
    <request name="enable_intercept">
      <arg name="scheme" type="string" />
    </request>
    <request name="disable_intercept">
      <arg name="scheme" type="string" />
    </request>
    <event name="intercept">
      <arg name="uri" type="string" />
    </event>
  </interface>

  <interface name="urish_surface" version="1">
    <!-- TODO: steal from https://wayland.app/protocols/xdg-shell#xdg_toplevel -->
  </interface>
</protocol>