From ad32786aac0e9727df8d43213e5f5e82a80f7a94 Mon Sep 17 00:00:00 2001
From: John Mercier <moaxcp@gmail.com>
Date: Mon, 4 Dec 2023 23:22:59 -0500
Subject: [PATCH] ProtocolPluginService now sets majorOpcode on
 XProtocolPlugins and uses it instead of majorVersion as the base opcode for
 requests. This fixes a bug in loading plugins and sending requests.

---
 .idea/modules.xml                             | 11 ++++
 .idea/modules/x11-client.integrationTest.iml  |  5 ++
 .idea/modules/x11-client.main.iml             |  5 ++
 .idea/modules/x11-client.test.iml             |  8 +++
 .idea/modules/x11-client.testFixtures.iml     |  8 +++
 .idea/runConfigurations.xml                   | 10 ----
 README.md                                     |  4 ++
 .../x11protocol/xcbparser/XResult.groovy      |  6 ++
 .../x11protocol/xcbparser/XPluginSpec.groovy  |  4 ++
 .../moaxcp/x11client/QueryVersionIT.java      | 19 ++++++
 .../com/github/moaxcp/x11client/RecordIT.java | 60 +++++++++++++++++++
 .../x11client/ProtocolPluginService.java      |  8 +--
 .../moaxcp/x11client/XProtocolService.java    |  2 +-
 .../x11client/protocol/XProtocolPlugin.java   |  2 +
 14 files changed, 136 insertions(+), 16 deletions(-)
 create mode 100644 .idea/modules.xml
 create mode 100644 .idea/modules/x11-client.test.iml
 create mode 100644 .idea/modules/x11-client.testFixtures.iml
 delete mode 100644 .idea/runConfigurations.xml
 create mode 100644 src/integrationTest/java/com/github/moaxcp/x11client/QueryVersionIT.java
 create mode 100644 src/integrationTest/java/com/github/moaxcp/x11client/RecordIT.java

diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 00000000..9427cd24
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/modules/x11-client.integrationTest.iml" filepath="$PROJECT_DIR$/.idea/modules/x11-client.integrationTest.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/modules/x11-client.main.iml" filepath="$PROJECT_DIR$/.idea/modules/x11-client.main.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/modules/x11-client.test.iml" filepath="$PROJECT_DIR$/.idea/modules/x11-client.test.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/modules/x11-client.testFixtures.iml" filepath="$PROJECT_DIR$/.idea/modules/x11-client.testFixtures.iml" />
+    </modules>
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/modules/x11-client.integrationTest.iml b/.idea/modules/x11-client.integrationTest.iml
index 4a4ce554..d5b7359d 100644
--- a/.idea/modules/x11-client.integrationTest.iml
+++ b/.idea/modules/x11-client.integrationTest.iml
@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module version="4">
+  <component name="AdditionalModuleElements">
+    <content url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/integrationTest">
+      <sourceFolder url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/integrationTest" isTestSource="false" generated="true" />
+    </content>
+  </component>
   <component name="CheckStyle-IDEA-Module">
     <option name="configuration">
       <map />
diff --git a/.idea/modules/x11-client.main.iml b/.idea/modules/x11-client.main.iml
index 4a4ce554..8e67cab0 100644
--- a/.idea/modules/x11-client.main.iml
+++ b/.idea/modules/x11-client.main.iml
@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module version="4">
+  <component name="AdditionalModuleElements">
+    <content url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/main">
+      <sourceFolder url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/main" isTestSource="false" generated="true" />
+    </content>
+  </component>
   <component name="CheckStyle-IDEA-Module">
     <option name="configuration">
       <map />
diff --git a/.idea/modules/x11-client.test.iml b/.idea/modules/x11-client.test.iml
new file mode 100644
index 00000000..db191b32
--- /dev/null
+++ b/.idea/modules/x11-client.test.iml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="AdditionalModuleElements">
+    <content url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/test">
+      <sourceFolder url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/test" isTestSource="true" generated="true" />
+    </content>
+  </component>
+</module>
\ No newline at end of file
diff --git a/.idea/modules/x11-client.testFixtures.iml b/.idea/modules/x11-client.testFixtures.iml
new file mode 100644
index 00000000..ce33e0ac
--- /dev/null
+++ b/.idea/modules/x11-client.testFixtures.iml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="AdditionalModuleElements">
+    <content url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/testFixtures">
+      <sourceFolder url="file://$MODULE_DIR$/../../build/generated/sources/annotationProcessor/java/testFixtures" isTestSource="false" generated="true" />
+    </content>
+  </component>
+</module>
\ No newline at end of file
diff --git a/.idea/runConfigurations.xml b/.idea/runConfigurations.xml
deleted file mode 100644
index 797acea5..00000000
--- a/.idea/runConfigurations.xml
+++ /dev/null
@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="RunConfigurationProducerService">
-    <option name="ignoredProducers">
-      <set>
-        <option value="com.android.tools.idea.compose.preview.runconfiguration.ComposePreviewRunConfigurationProducer" />
-      </set>
-    </option>
-  </component>
-</project>
\ No newline at end of file
diff --git a/README.md b/README.md
index ca067f17..25ced40f 100644
--- a/README.md
+++ b/README.md
@@ -452,6 +452,10 @@ https://jamey.thesharps.us/2021/03/25/xcb-protocol-specifications-data/
 
 # versions
 
+## 0.13.0
+
+ProtocolPluginService now sets majorOpcode on XProtocolPlugins and uses it instead of majorVersion as the base opcode for requests. This fixes a bug in loading plugins and sending requests.
+
 ## 0.12.0
 
 Adding jbang examples
diff --git a/buildSrc/src/main/groovy/com/github/moaxcp/x11protocol/xcbparser/XResult.groovy b/buildSrc/src/main/groovy/com/github/moaxcp/x11protocol/xcbparser/XResult.groovy
index 196ee213..93ecb2ae 100644
--- a/buildSrc/src/main/groovy/com/github/moaxcp/x11protocol/xcbparser/XResult.groovy
+++ b/buildSrc/src/main/groovy/com/github/moaxcp/x11protocol/xcbparser/XResult.groovy
@@ -89,6 +89,12 @@ class XResult {
                         .initializer('$L', minorVersion)
                         .build())
 
+        builder.addField(
+                FieldSpec.builder(byte.class, 'majorOpcode', Modifier.PRIVATE)
+                        .addAnnotation(Getter.class)
+                        .addAnnotation(Setter.class)
+                        .build())
+
         builder.addField(
             FieldSpec.builder(byte.class, 'firstEvent', Modifier.PRIVATE)
                 .addAnnotation(Getter.class)
diff --git a/buildSrc/src/test/groovy/com/github/moaxcp/x11protocol/xcbparser/XPluginSpec.groovy b/buildSrc/src/test/groovy/com/github/moaxcp/x11protocol/xcbparser/XPluginSpec.groovy
index 213b7ade..99d206e9 100644
--- a/buildSrc/src/test/groovy/com/github/moaxcp/x11protocol/xcbparser/XPluginSpec.groovy
+++ b/buildSrc/src/test/groovy/com/github/moaxcp/x11protocol/xcbparser/XPluginSpec.groovy
@@ -31,6 +31,10 @@ class XPluginSpec extends XmlSpec {
               @lombok.Getter
               private byte minorVersion = 3;
             
+              @lombok.Getter
+              @lombok.Setter
+              private byte majorOpcode;
+            
               @lombok.Getter
               @lombok.Setter
               private byte firstEvent;
diff --git a/src/integrationTest/java/com/github/moaxcp/x11client/QueryVersionIT.java b/src/integrationTest/java/com/github/moaxcp/x11client/QueryVersionIT.java
new file mode 100644
index 00000000..ea33ac2c
--- /dev/null
+++ b/src/integrationTest/java/com/github/moaxcp/x11client/QueryVersionIT.java
@@ -0,0 +1,19 @@
+package com.github.moaxcp.x11client;
+
+import com.github.moaxcp.x11client.protocol.record.QueryVersion;
+import com.github.moaxcp.x11client.protocol.record.QueryVersionReply;
+import java.io.IOException;
+import lombok.extern.java.Log;
+import org.junit.jupiter.api.Test;
+
+@Log
+public class QueryVersionIT {
+  @Test
+  void record() throws IOException {
+    try (X11Client client = X11Client.connect()) {
+      QueryVersion queryVersion = QueryVersion.builder().majorVersion((short) 1).minorVersion((short) 13).build();
+      QueryVersionReply reply = client.send(queryVersion);
+      log.info(reply.toString());
+    }
+  }
+}
diff --git a/src/integrationTest/java/com/github/moaxcp/x11client/RecordIT.java b/src/integrationTest/java/com/github/moaxcp/x11client/RecordIT.java
new file mode 100644
index 00000000..e9da6365
--- /dev/null
+++ b/src/integrationTest/java/com/github/moaxcp/x11client/RecordIT.java
@@ -0,0 +1,60 @@
+package com.github.moaxcp.x11client;
+
+import com.github.moaxcp.x11client.protocol.record.*;
+import lombok.extern.java.Log;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.util.Collections;
+
+@Log
+public class RecordIT {
+    @Test
+    void test() {
+        try (X11Client client = X11Client.connect()) {
+            int rc = client.nextResourceId();
+            Range8 empty = Range8.builder().build();
+            ExtRange emptyExtRange = ExtRange.builder()
+                    .major(empty)
+                    .minor(Range16.builder().build())
+                    .build();
+            Range range = Range.builder()
+                    .deviceEvents(Range8.builder().first((byte) 2).last((byte) 6).build())
+                    .coreRequests(empty)
+                    .coreReplies(empty)
+                    .extRequests(emptyExtRange)
+                    .extReplies(emptyExtRange)
+                    .deliveredEvents(empty)
+                    .clientStarted(false)
+                    .errors(empty)
+                    .clientDied(false)
+                    .build();
+
+            CreateContext createContext = CreateContext.builder()
+                    .context(rc)
+                    .clientSpecs(Collections.singletonList(Cs.ALL_CLIENTS.getValue()))
+                    .elementHeader((byte) 0)
+                    .ranges(Collections.singletonList(range))
+                    .build();
+
+            log.info(String.format("createContext: %s, size: %d, length: %d", createContext, createContext.getSize(), createContext.getLength()));
+
+            client.send(createContext);
+
+            client.sync();
+
+            EnableContext enableContext = EnableContext
+                    .builder()
+                    .context(rc)
+                    .build();
+            EnableContextReply enableContextReply = client.send(enableContext);
+            if (enableContextReply.getCategory() == 0) {
+                for (Byte datum : enableContextReply.getData()) {
+                    System.out.println(datum);
+                }
+            }
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}
diff --git a/src/main/java/com/github/moaxcp/x11client/ProtocolPluginService.java b/src/main/java/com/github/moaxcp/x11client/ProtocolPluginService.java
index 0bfcfc4e..71cb36e1 100644
--- a/src/main/java/com/github/moaxcp/x11client/ProtocolPluginService.java
+++ b/src/main/java/com/github/moaxcp/x11client/ProtocolPluginService.java
@@ -53,9 +53,7 @@ boolean activatePlugin(String name, byte majorOpcode, byte firstEvent, byte firs
     Optional<XProtocolPlugin> loaded = loadedPlugin(name);
     if(loaded.isPresent()) {
       XProtocolPlugin plugin = loaded.get();
-      if(plugin.getMajorVersion() != majorOpcode) {
-        return false; //client must match server version
-      }
+      plugin.setMajorOpcode(majorOpcode);
       plugin.setFirstEvent(firstEvent);
       plugin.setFirstError(firstError);
       activatedPlugins.add(plugin);
@@ -74,11 +72,11 @@ boolean activatedPlugin(String name) {
     return getActivatedPlugin(name).isPresent();
   }
 
-  byte majorVersionForRequest(XRequest request) {
+  byte majorOpcodeForRequest(XRequest request) {
     return activatedPlugins.stream()
         .filter(p -> p.supportedRequest(request))
         .findFirst()
-        .map(XProtocolPlugin::getMajorVersion)
+        .map(XProtocolPlugin::getMajorOpcode)
         .orElseThrow(() -> new UnsupportedOperationException("Plugin missing or not activated for request. Could not find majorOpcode for request: " + request));
   }
 
diff --git a/src/main/java/com/github/moaxcp/x11client/XProtocolService.java b/src/main/java/com/github/moaxcp/x11client/XProtocolService.java
index 61ec37ad..f1e24341 100644
--- a/src/main/java/com/github/moaxcp/x11client/XProtocolService.java
+++ b/src/main/java/com/github/moaxcp/x11client/XProtocolService.java
@@ -72,7 +72,7 @@ public void send(OneWayRequest request) {
 
   private void actuallySend(XRequest request) {
     try {
-      request.write(pluginService.majorVersionForRequest(request), out);
+      request.write(pluginService.majorOpcodeForRequest(request), out);
     } catch(IOException e) {
       throw new X11ClientException("exception writing request \"" + request + "\"", e);
     }
diff --git a/src/main/java/com/github/moaxcp/x11client/protocol/XProtocolPlugin.java b/src/main/java/com/github/moaxcp/x11client/protocol/XProtocolPlugin.java
index 9cf1304d..c23a5a11 100644
--- a/src/main/java/com/github/moaxcp/x11client/protocol/XProtocolPlugin.java
+++ b/src/main/java/com/github/moaxcp/x11client/protocol/XProtocolPlugin.java
@@ -6,6 +6,8 @@ public interface XProtocolPlugin {
   String getName();
   byte getMajorVersion();
   byte getMinorVersion();
+  byte getMajorOpcode();
+  void setMajorOpcode(byte firstOpcode);
   byte getFirstEvent();
   void setFirstEvent(byte firstEvent);
   byte getFirstError();