(imp) checkstyle

.github/workflows/ci.yaml

@@ -85,6 +85,9 @@ jobs:
           key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
           restore-keys: gradle-${{ runner.os }}
 
+      - name: Checkstyle
+        run: ./gradlew checkstyleMain checkstyleTest
+
       - name: Install PCRE
         run: sudo apt-get install -y libpcre2-8-0
 

README.md

@@ -180,7 +180,8 @@ the JNA.
 
 ### `ffm`
 
-The `ffm` backend uses the [Foreign Functions and Memory API](https://docs.oracle.com/en/java/javase/21/core/foreign-function-and-memory-api.html)
+The `ffm` backend uses
+the [Foreign Functions and Memory API](https://docs.oracle.com/en/java/javase/21/core/foreign-function-and-memory-api.html)
 to invoke the `pcre2` shared library. For this backend to work, the `pcre2` shared library must be installed on the
 system and be visible via `java.library.path`.
 

api/build.gradle.kts

@@ -14,6 +14,7 @@
  */
 plugins {
     `java-library`
+    checkstyle
     `maven-publish`
     signing
     jacoco

config/checkstyle/checkstyle.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.sourceforge.io/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="120"/>
+        <property name="ignorePattern"
+                  value="^package.*|^import.*|href\s*=\s*&quot;[^&quot;]*&quot;|http://|https://|ftp://"/>
+    </module>
+</module>

ffm/build.gradle.kts

@@ -14,6 +14,7 @@
  */
 plugins {
     `java-library`
+    checkstyle
     `maven-publish`
     signing
     jacoco

jna/build.gradle.kts

@@ -14,6 +14,7 @@
  */
 plugins {
     `java-library`
+    checkstyle
     `maven-publish`
     signing
     jacoco

jna/src/main/java/org/pcre4j/jna/Pcre2.java

@@ -47,8 +47,8 @@ public Pcre2() {
     /**
      * Constructs a new PCRE2 API using the specified library name and function suffix.
      *
-     * @param libraryName the library name
-     *                    (e.g. "pcre2-8" for "pcre2-8.dll" on Windows, "libpcre2-8.so" on Linux, "libpcre2-8.dylib" on macOS)
+     * @param libraryName the library name (e.g. "pcre2-8" for "pcre2-8.dll" on Windows, "libpcre2-8.so" on Linux,
+     *                    "libpcre2-8.dylib" on macOS)
      * @param suffix      the function suffix (e.g. "_8" as in "pcre2_compile_8")
      */
     public Pcre2(String libraryName, String suffix) {
@@ -228,7 +228,14 @@ private interface Library extends com.sun.jna.Library {
 
         void pcre2_compile_context_free(Pointer ccontext);
 
-        Pointer pcre2_compile(String pattern, long patternLength, int options, IntByReference errorcode, LongByReference erroroffset, Pointer ccontext);
+        Pointer pcre2_compile(
+                String pattern,
+                long patternLength,
+                int options,
+                IntByReference errorcode,
+                LongByReference erroroffset,
+                Pointer ccontext
+        );
 
         void pcre2_code_free(Pointer code);
 
@@ -248,7 +255,15 @@ private interface Library extends com.sun.jna.Library {
 
         void pcre2_match_context_free(Pointer mcontext);
 
-        int pcre2_match(Pointer code, String subject, long length, long startOffset, int options, Pointer matchData, Pointer mcontext);
+        int pcre2_match(
+                Pointer code,
+                String subject,
+                long length,
+                long startOffset,
+                int options,
+                Pointer matchData,
+                Pointer mcontext
+        );
 
         int pcre2_get_ovector_count(Pointer matchData);
 

lib/build.gradle.kts

@@ -14,6 +14,7 @@
  */
 plugins {
     `java-library`
+    checkstyle
     `maven-publish`
     signing
     jacoco

lib/src/main/java/org/pcre4j/Pcre2CompileError.java

@@ -62,6 +62,28 @@ public Pcre2CompileError(String pattern, long offset, String message, Throwable
         this.message = message;
     }
 
+    /**
+     * Get the region around the error in the pattern.
+     *
+     * @param pattern the pattern
+     * @param offset  the offset of the error in the pattern
+     * @return the region around the error
+     */
+    private static String getPatternRegion(String pattern, long offset) {
+        final var since = Math.max(0, offset - PATTERN_REGION_SIZE);
+        final var until = Math.min(pattern.length(), offset + PATTERN_REGION_SIZE);
+
+        var region = pattern.substring((int) since, (int) until);
+        if (since > 0) {
+            region = "…" + region;
+        }
+        if (until < pattern.length()) {
+            region = region + "…";
+        }
+
+        return region;
+    }
+
     /**
      * Get the pattern that caused the error.
      *
@@ -89,26 +111,4 @@ public String message() {
         return message;
     }
 
-    /**
-     * Get the region around the error in the pattern.
-     *
-     * @param pattern the pattern
-     * @param offset  the offset of the error in the pattern
-     * @return the region around the error
-     */
-    private static String getPatternRegion(String pattern, long offset) {
-        final var since = Math.max(0, offset - PATTERN_REGION_SIZE);
-        final var until = Math.min(pattern.length(), offset + PATTERN_REGION_SIZE);
-
-        var region = pattern.substring((int) since, (int) until);
-        if (since > 0) {
-            region = "…" + region;
-        }
-        if (until < pattern.length()) {
-            region = region + "…";
-        }
-
-        return region;
-    }
-
 }

regex/build.gradle.kts

@@ -14,6 +14,7 @@
  */
 plugins {
     `java-library`
+    checkstyle
     `maven-publish`
     signing
     jacoco

regex/src/main/java/org/pcre4j/regex/Matcher.java

@@ -16,14 +16,12 @@
 
 import org.pcre4j.Pcre2MatchData;
 import org.pcre4j.Pcre2MatchOption;
-import org.pcre4j.Pcre4j;
 import org.pcre4j.Pcre4jUtils;
 import org.pcre4j.api.IPcre2;
 
 import java.util.Arrays;
 import java.util.EnumSet;
 import java.util.Map;
-import java.util.regex.MatchResult;
 
 /**
  * Performs match operations on a character sequence by interpreting a {@link Pattern} using the PCRE library yet aims

regex/src/main/java/org/pcre4j/regex/Pattern.java

@@ -216,8 +216,8 @@ public String[] splitWithDelimiters(CharSequence input, int limit) {
      * Splits the given input around matches of this pattern and returns either just the strings or both the strings
      * and the matching delimiters.
      *
-     * @param input the input to split
-     * @param limit the maximum number of items to return
+     * @param input             the input to split
+     * @param limit             the maximum number of items to return
      * @param includeDelimiters whether to include the matching delimiters in the result
      * @return the array of strings and optionally matching delimiters computed by splitting the input around matches
      * of this pattern

test/build.gradle.kts

@@ -14,6 +14,7 @@
  */
 plugins {
     `java-library`
+    checkstyle
     jacoco
 }