From cfbb906358fbc75d7773f3636fbf802dc817013f Mon Sep 17 00:00:00 2001
From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Fri, 10 Feb 2023 10:47:42 +1000
Subject: [PATCH] protocol: rename type to context_type

type is a reserved keyword in many languages, let's not make this harder
to use than necessary
---
 proto/protocol.xml            | 14 ++++++++------
 src/libei-connection-setup.c  | 10 +++++-----
 src/libeis-connection-setup.c |  4 ++--
 3 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/proto/protocol.xml b/proto/protocol.xml
index d39c3ca..e3953d0 100644
--- a/proto/protocol.xml
+++ b/proto/protocol.xml
@@ -105,8 +105,8 @@
       <entry name="sender" value="1"/>
     </enum>
 
-    <request name="type" since="1">
-      <description summary="type request">
+    <request name="context_type" since="1">
+      <description summary="context type request">
         Notify the EIS implementation of the type of this context.
 
         This request is optional, the default client type is context_type.receiver.
@@ -159,8 +159,8 @@
         sent by the client must be provided in this version
         or any lower version.
 
-        This event is sent immediately after connection. A client
-        should not issue any requests until processing this version.
+        This event is sent immediately after connection to the EIS implementation.
+        A client should not issue any requests until processing this version.
 
         Note that the EIS implementation assumes that the supported
         client version of this interface is 1 unless and until the client
@@ -171,7 +171,7 @@
         summary="the highest version supported by the EIS implementation"/>
     </event>
 
-    <event name="connection" since="1">
+    <event name="connection" type="destructor" since="1">
       <description summary="the core connection object">
         Provides the client with the connection object that is the top-level
         object for all future requests and events.
@@ -278,7 +278,9 @@
 
     <event name="done" type="destructor" since="1">
       <description summary="done event">
-        Notify the client when the related request is done.
+        Notify the client when the related request is done. Immediately after this event
+        the ei_callback object is destroyed by the EIS implementation and as such the
+        client must not attempt to use it after that point.
       </description>
       <arg name="callback_data" type="uint" summary="request-specific data for the callback"/>
     </event>
diff --git a/src/libei-connection-setup.c b/src/libei-connection-setup.c
index a911375..9d682d1 100644
--- a/src/libei-connection-setup.c
+++ b/src/libei-connection-setup.c
@@ -73,11 +73,11 @@ ei_connection_setup_initialize(struct ei_connection_setup *setup, uint32_t versi
 {
 	struct ei *ei = ei_connection_setup_get_context(setup);
 
-	if (version >= EI_CONNECTION_SETUP_REQUEST_TYPE_SINCE_VERSION)
-		ei_connection_setup_request_type(setup,
-						 ei->is_sender ?
-							EI_CONNECTION_SETUP_CONTEXT_TYPE_SENDER :
-							EI_CONNECTION_SETUP_CONTEXT_TYPE_RECEIVER);
+	if (version >= EI_CONNECTION_SETUP_REQUEST_CONTEXT_TYPE_SINCE_VERSION)
+		ei_connection_setup_request_context_type(setup,
+							 ei->is_sender ?
+								EI_CONNECTION_SETUP_CONTEXT_TYPE_SENDER :
+								EI_CONNECTION_SETUP_CONTEXT_TYPE_RECEIVER);
 
 	if (version >= EI_CONNECTION_SETUP_REQUEST_NAME_SINCE_VERSION)
 		ei_connection_setup_request_name(setup, ei->name);
diff --git a/src/libeis-connection-setup.c b/src/libeis-connection-setup.c
index ffd0626..51e5a30 100644
--- a/src/libeis-connection-setup.c
+++ b/src/libeis-connection-setup.c
@@ -107,7 +107,7 @@ client_msg_name(struct eis_connection_setup *setup, const char *name)
 }
 
 static int
-client_msg_type(struct eis_connection_setup *setup, uint32_t type)
+client_msg_context_type(struct eis_connection_setup *setup, uint32_t type)
 {
 	switch(type) {
 	case EIS_CONNECTION_SETUP_CONTEXT_TYPE_SENDER:
@@ -168,7 +168,7 @@ client_msg_interface_version(struct eis_connection_setup *setup, const char *nam
 
 static const struct eis_connection_setup_interface interface = {
 	.done = client_msg_done,
-	.type = client_msg_type,
+	.context_type = client_msg_context_type,
 	.name = client_msg_name,
 	.interface_version = client_msg_interface_version,
 };