Upgrading to jdk 21 with module-info.java

.github/workflows/gradle.yml

@@ -22,19 +22,19 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: temurin
-        java-version: 17
-    - name: Cache SonarCloud packages
-      uses: actions/cache@v1
-      with:
-        path: ~/.sonar/cache
-        key: ${{ runner.os }}-sonar
-        restore-keys: ${{ runner.os }}-sonar
-    - name: Cache Gradle packages
-      uses: actions/cache@v1
-      with:
-        path: ~/.gradle/caches
-        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
-        restore-keys: ${{ runner.os }}-gradle
+        java-version: 21
+#    - name: Cache SonarCloud packages
+#      uses: actions/cache@v1
+#      with:
+#        path: ~/.sonar/cache
+#        key: ${{ runner.os }}-sonar
+#        restore-keys: ${{ runner.os }}-sonar
+#    - name: Cache Gradle packages
+#      uses: actions/cache@v1
+#      with:
+#        path: ~/.gradle/caches
+#        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+#        restore-keys: ${{ runner.os }}-gradle
     - name: Grant execute permission for gradlew
       run: chmod +x gradlew
     - name: Build with Gradle
@@ -45,4 +45,4 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-      run: ./gradlew sonar --info
+      run: ./gradlew sonar

README.md

@@ -8,7 +8,7 @@ as X11lib by queuing one-way requests before sending them to the server. The
 x11-protocol project enables reading and writing the entire protocol and can
 be used to help write a x11 server.
 
-[![Java CI with Gradle](https://github.com/moaxcp/x11/workflows/Java%20CI%20with%20Gradle/badge.svg?branch=master)](https://github.com/moaxcp/x11/actions?query=workflow%3A%22Java+CI+with+Gradle%22)
+[![Java CI with Gradle](https://github.com/moaxcp/x11/actions/workflows/gradle.yml/badge.svg)](https://github.com/moaxcp/x11/actions/workflows/gradle.yml)
 [![maven central](https://img.shields.io/maven-central/v/com.github.moaxcp.x11/x11-client)](https://search.maven.org/artifact/com.github.moaxcp.x11/x11-client)
 [![javadoc](https://javadoc.io/badge2/com.github.moaxcp.x11/x11-client/javadoc.svg)](https://javadoc.io/doc/com.github.moaxcp.x11/x11-client)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=moaxcp_x11-client&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=moaxcp_x11-client)
@@ -23,21 +23,15 @@ The x11-client library can be added to your project using maven or gradle.
 <dependency>
  <groupId>com.github.moaxcp.x11</groupId>
  <artifactId>x11-client</artifactId>
- <version>0.16.0</version>
+ <version>0.18.0</version>
  <type>module</type>
 </dependency>
 ```
 
 ## Gradle
 
 ```
-implementation 'com.github.moaxcp.x11:x11-client:0.16.0'
-```
-
-The library has one dependency for using unix sockets.
-
-```
-implementation 'com.kohlschutter.junixsocket:junixsocket-core:x.x.x'
+implementation 'com.github.moaxcp.x11:x11-client:0.18.0'
 ```
 
 # Usage
@@ -99,13 +93,12 @@ server.
 client.flush();
 ```
 
-This project converts the x11 protocol to classes which implement certain
-interfaces. The client can read and write these objects using the read and 
-write methods defined in each object’s class. Here is a diagram of the class 
-hierarchy for the protocol:
+This project converts the x11 protocol to classes which implement core
+interfaces (XError, XEvent, XRequest, XReply, etc). The client can read and write these objects using the read and 
+write methods defined in each object’s class.
 
-X11ClientExceptions may be thrown when calling methods on a client. These 
-exceptions represent IOExceptions with the socket. X11ErrorExceptions represent 
+X11ProtocolExceptions may be thrown when there are IOExceptions with the socket. X11ClientExceptions are thrown with 
+client issues such as connection issues or api issues. X11ErrorExceptions represent 
 Errors from the X11 Server. Errors can be handled using the standard try/catch 
 method rather than using an error handler callback as is done with X11lib.
 
@@ -372,6 +365,9 @@ be shared without synchronization.
 
 # Contributors
 
+Support is most needed for example code. Other x11 libraries have tons of examples that prove the library works.
+So far this project only has a few basic examples.
+
 I am not an x11 programmer but I find the protocol to be an interesting 
 challenge and learning experience. The only other x11 client implementation for 
 java that I have found is escher. Escher is very hand written and has many 
@@ -398,22 +394,6 @@ enables the client to figure out which class to use when reading errors and
 events from the server. These plugins are generated durring the build process. 
 Plugins are discovered and loaded using the ServiceLoader pattern.
 
-Support is needed for a few things in the protocol before all extensions can 
-be supported. Contributions are welcome!
-
-fd – file descriptors. I believe these should work like an int field. If this 
-is true this should be easy to implement.
-
-sumOf expressions – creates a sum value which is used to determine list sizes. 
-The list is the size of a sumOf function called on another list.
-
-Polymorphism – some objects use a case switch which seems to describe a 
-polymorphic object. There is usually a type field which describes the type and 
-each switch case provides additional fields for that type. The generation code 
-needs to support generating multiple objects when it runs into an object with 
-these switch constructs. Reading and writing will be tricky since the type 
-field can be deep within the protocol. These switches may also be nested.
-
 # Frameworks
 
 There is a need for higher levels of abstraction such as Window, Pixmap, and 
@@ -455,6 +435,16 @@ https://www.x.org/releases/X11R7.6/doc/libXtst/recordlib.html
 
 # versions
 
+## 0.18.0
+
+* Switched to a multimodule project
+* Switched to jdk 21
+* Added java module system support
+* Removed delombok due to [issues](https://github.com/freefair/gradle-plugins/issues/824) with modules. This results in javadoc no longer being generated.
+* Removed dependency on junixsocket and switched to the jdk UnixDomainSocket.
+* Removed jbang
+* Moved all integration tests to the examples project with a main method.
+
 ## 0.17.0
 
 * Adding generated protocol sources to git

build.gradle

@@ -1,11 +1,11 @@
 plugins {
-  id 'org.sonarqube' version '4.4.1.3373'
-  id 'io.freefair.lombok' version '8.4' apply false
+  id 'org.sonarqube' version '5.0.0.4638'
+  id 'io.freefair.lombok' version '8.6' apply false
   id 'org.unbroken-dome.test-sets' version '4.1.0' apply false
 }
 
 allprojects {
-  version = '0.17.0'
+  version = '0.18.0'
   group = 'com.github.moaxcp.x11'
   repositories {
     mavenCentral()

examples/src/main/java/com/github/moaxcp/x11/examples/KeySymMain.java

@@ -0,0 +1,22 @@
+package com.github.moaxcp.x11.examples;
+
+import com.github.moaxcp.x11.keysym.KeySym;
+import com.github.moaxcp.x11.x11client.X11Client;
+import lombok.extern.java.Log;
+
+import java.io.IOException;
+import java.util.List;
+
+@Log
+public class KeySymMain {
+
+  public static void main(String... args) throws IOException {
+    try(X11Client client = X11Client.connect()) {
+      List<Byte> keyCodes = client.keySymToKeyCodes(KeySym.XK_Escape);
+      for(byte keyCode : keyCodes) {
+        KeySym keySym = client.keyCodeToKeySym(keyCode, (short) 0);
+        log.info(keySym.toString());
+      }
+    }
+  }
+}

examples/src/main/java/com/github/moaxcp/x11/x11client/QueryVersion.java → examples/src/main/java/com/github/moaxcp/x11/examples/QueryVersion.java

@@ -1,6 +1,7 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
 import com.github.moaxcp.x11.protocol.record.QueryVersionReply;
+import com.github.moaxcp.x11.x11client.X11Client;
 import lombok.extern.java.Log;
 
 import java.io.IOException;

examples/src/main/java/com/github/moaxcp/x11/x11client/Record.java → examples/src/main/java/com/github/moaxcp/x11/examples/Record.java

@@ -1,10 +1,11 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
-import com.github.moaxcp.x11.protocol.KeySym;
+import com.github.moaxcp.x11.keysym.KeySym;
 import com.github.moaxcp.x11.protocol.XEvent;
 import com.github.moaxcp.x11.protocol.record.*;
 import com.github.moaxcp.x11.protocol.xproto.KeyPressEvent;
 import com.github.moaxcp.x11.protocol.xproto.MotionNotifyEvent;
+import com.github.moaxcp.x11.x11client.X11Client;
 import lombok.extern.java.Log;
 
 import java.io.IOException;
@@ -67,7 +68,7 @@ public static void main(String... args) throws IOException {
 
                     if (replyData instanceof KeyPressEvent) {
                         KeyPressEvent e = (KeyPressEvent) replyData;
-                        com.github.moaxcp.x11.protocol.KeySym keysym = data.keyCodeToKeySym(e);
+                        KeySym keysym = data.keyCodeToKeySym(e);
                         if(keysym == KeySym.XK_Escape) {
                             break;
                         }

examples/src/main/java/com/github/moaxcp/x11/x11client/RecordApi.java → examples/src/main/java/com/github/moaxcp/x11/examples/RecordApi.java

@@ -1,9 +1,10 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
-import com.github.moaxcp.x11.protocol.KeySym;
+import com.github.moaxcp.x11.keysym.KeySym;
 import com.github.moaxcp.x11.protocol.record.*;
 import com.github.moaxcp.x11.protocol.xproto.GeGenericEvent;
 import com.github.moaxcp.x11.protocol.xproto.KeyPressEvent;
+import com.github.moaxcp.x11.x11client.X11Client;
 import com.github.moaxcp.x11.x11client.api.record.RecordData;
 import com.github.moaxcp.x11.x11client.api.record.RecordReply;
 import lombok.extern.java.Log;
@@ -67,7 +68,7 @@ public static void main(String... args) throws IOException {
                 while(true) {
                     RecordReply recordReply = data.record().readNextRecord();
                     log.info(String.format("%s", recordReply));
-                    Optional<com.github.moaxcp.x11.protocol.KeySym> first = recordReply.getData().stream()
+                    Optional<KeySym> first = recordReply.getData().stream()
                             .map(RecordData::getXObject)
                             .filter(obj -> obj instanceof KeyPressEvent)
                             .map(KeyPressEvent.class::cast)

examples/src/main/java/com/github/moaxcp/x11/x11client/RecordApiClientTracker.java → examples/src/main/java/com/github/moaxcp/x11/examples/RecordApiClientTracker.java

@@ -1,11 +1,12 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
-import com.github.moaxcp.x11.protocol.KeySym;
+import com.github.moaxcp.x11.keysym.KeySym;
 import com.github.moaxcp.x11.protocol.record.*;
 import com.github.moaxcp.x11.protocol.xproto.CreateWindow;
 import com.github.moaxcp.x11.protocol.xproto.GeGenericEvent;
 import com.github.moaxcp.x11.protocol.xproto.KeyPressEvent;
 import com.github.moaxcp.x11.protocol.xproto.NoOperation;
+import com.github.moaxcp.x11.x11client.X11Client;
 import com.github.moaxcp.x11.x11client.api.record.RecordData;
 import com.github.moaxcp.x11.x11client.api.record.RecordReply;
 import lombok.extern.java.Log;

examples/src/main/java/com/github/moaxcp/x11/x11client/SimpleHelloWorld.java → examples/src/main/java/com/github/moaxcp/x11/examples/SimpleHelloWorld.java

@@ -1,8 +1,9 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
 import com.github.moaxcp.x11.protocol.Utilities;
 import com.github.moaxcp.x11.protocol.XEvent;
 import com.github.moaxcp.x11.protocol.xproto.*;
+import com.github.moaxcp.x11.x11client.X11Client;
 
 import java.io.IOException;
 import java.util.ArrayList;

examples/src/main/java/com/github/moaxcp/x11/x11client/SimpleHelloWorld2.java → examples/src/main/java/com/github/moaxcp/x11/examples/SimpleHelloWorld2.java

@@ -1,8 +1,9 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
 
 import com.github.moaxcp.x11.protocol.XEvent;
 import com.github.moaxcp.x11.protocol.xproto.*;
+import com.github.moaxcp.x11.x11client.X11Client;
 
 import java.io.IOException;
 

examples/src/main/java/com/github/moaxcp/x11/x11client/SimpleHelloWorldMouse.java → examples/src/main/java/com/github/moaxcp/x11/examples/SimpleHelloWorldMouse.java

@@ -1,9 +1,10 @@
-package com.github.moaxcp.x11.x11client;
+package com.github.moaxcp.x11.examples;
 
-import com.github.moaxcp.x11.protocol.KeySym;
+import com.github.moaxcp.x11.keysym.KeySym;
 import com.github.moaxcp.x11.protocol.Utilities;
 import com.github.moaxcp.x11.protocol.XEvent;
 import com.github.moaxcp.x11.protocol.xproto.*;
+import com.github.moaxcp.x11.x11client.X11Client;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
@@ -99,7 +100,7 @@ public static void main(String... args) throws IOException {
                             .build());
                 } else if(event instanceof KeyPressEvent) {
                     KeyPressEvent keyPress = (KeyPressEvent) event;
-                    com.github.moaxcp.x11.protocol.KeySym keysym = client.keyCodeToKeySym(keyPress.getDetail(), keyPress.getState());
+                    KeySym keysym = client.keyCodeToKeySym(keyPress.getDetail(), keyPress.getState());
                     if(keysym == KeySym.XK_Escape) {
                         break;
                     }

examples/src/main/java/com/github/moaxcp/x11/x11client/X11Events/X11EventsWindow.java → examples/src/main/java/com/github/moaxcp/x11/examples/X11Events/X11EventsWindow.java

@@ -1,11 +1,12 @@
-package com.github.moaxcp.x11.x11client.X11Events;
+package com.github.moaxcp.x11.examples.X11Events;
 
+import com.github.moaxcp.x11.keysym.KeySym;
 import com.github.moaxcp.x11.protocol.DisplayName;
-import com.github.moaxcp.x11.protocol.KeySym;
 import com.github.moaxcp.x11.protocol.Utilities;
 import com.github.moaxcp.x11.protocol.XEvent;
 import com.github.moaxcp.x11.protocol.xproto.*;
 import com.github.moaxcp.x11.x11client.X11Client;
+
 import java.io.IOException;
 
 public class X11EventsWindow {

examples/src/main/java/com/github/moaxcp/x11/x11client/X11Events/X11EventsWindowMain.java → examples/src/main/java/com/github/moaxcp/x11/examples/X11Events/X11EventsWindowMain.java

@@ -1,4 +1,4 @@
-package com.github.moaxcp.x11.x11client.X11Events;
+package com.github.moaxcp.x11.examples.X11Events;
 
 import com.github.moaxcp.x11.xephyr.XephyrRunner;
 

examples/src/main/java/com/github/moaxcp/x11/x11client/basicwm/BasicWMMain.java → examples/src/main/java/com/github/moaxcp/x11/examples/basicwm/BasicWMMain.java

@@ -1,4 +1,4 @@
-package com.github.moaxcp.x11.x11client.basicwm;
+package com.github.moaxcp.x11.examples.basicwm;
 
 import com.github.moaxcp.x11.xephyr.XephyrRunner;
 

examples/src/main/java/com/github/moaxcp/x11/x11client/basicwm/BasicWindowManager.java → examples/src/main/java/com/github/moaxcp/x11/examples/basicwm/BasicWindowManager.java

@@ -1,8 +1,13 @@
-package com.github.moaxcp.x11.x11client.basicwm;
+package com.github.moaxcp.x11.examples.basicwm;
 
-import com.github.moaxcp.x11.protocol.*;
+import com.github.moaxcp.x11.keysym.KeySym;
+import com.github.moaxcp.x11.protocol.AtomValue;
+import com.github.moaxcp.x11.protocol.DisplayName;
+import com.github.moaxcp.x11.protocol.Utilities;
+import com.github.moaxcp.x11.protocol.XEvent;
 import com.github.moaxcp.x11.protocol.xproto.*;
 import com.github.moaxcp.x11.x11client.X11Client;
+
 import java.io.IOException;
 import java.util.Iterator;
 import java.util.LinkedHashMap;

examples/src/main/java/com/github/moaxcp/x11/x11client/experimental/DisplayHelloWorld.java → examples/src/main/java/com/github/moaxcp/x11/examples/experimental/DisplayHelloWorld.java

@@ -1,4 +1,4 @@
-package com.github.moaxcp.x11.x11client.experimental;
+package com.github.moaxcp.x11.examples.experimental;
 
 import com.github.moaxcp.x11.protocol.DisplayName;
 import com.github.moaxcp.x11.protocol.xproto.Rectangle;