diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml new file mode 100644 index 0000000..a524226 --- /dev/null +++ b/.github/workflows/check.yml @@ -0,0 +1,25 @@ +name: Check + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + java: [ '11', '17', '21' ] + name: Java ${{ matrix.Java }} Check + + steps: + - uses: actions/checkout@v1 + - name: Setup java + uses: actions/setup-java@v2 + with: + distribution: 'adopt' + java-version: ${{ matrix.java }} + - name: Test + env: + STRUMENTA_PACKAGES_USER: ${{ secrets.STRUMENTA_PACKAGES_USER }} + STRUMENTA_PACKAGES_TOKEN: ${{ secrets.STRUMENTA_PACKAGES_TOKEN }} + run: ./gradlew check --stacktrace \ No newline at end of file diff --git a/.gitignore b/.gitignore index 485dee6..0580915 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ .idea +build +.gradle diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..82d87c4 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,123 @@ +plugins { + `java-library` + alias(libs.plugins.vanniktech.publish) + signing + id("antlr") + id("com.diffplug.spotless") version "5.1.0" + id("net.researchgate.release") version "3.0.2" +} + +group = "com.strumenta.antlr4-c3" +description = "A code completion core implementation for ANTLR4 based parsers" + +java { + sourceCompatibility = JavaVersion.VERSION_11 + targetCompatibility = JavaVersion.VERSION_11 + withSourcesJar() +} + +repositories { + mavenCentral() +} + +val junitVersion = "5.14.0" +val antlrVersion = "4.13.2" + +dependencies { + implementation("org.antlr:antlr4-runtime:$antlrVersion") + antlr("org.antlr:antlr4:$antlrVersion") + testImplementation(platform("org.junit:junit-bom:$junitVersion")) + testImplementation("org.junit.jupiter:junit-jupiter") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +tasks.test { + useJUnitPlatform() +} + +sourceSets { + named("test") { + java.srcDir("$buildDir/generated-test-sources/antlr4") + } +} + +tasks.named("generateTestGrammarSource") { + arguments = arguments + listOf("-visitor", "-listener", "-package", "com.strumenta.antlr4c3") + outputDirectory = file("$buildDir/generated-test-sources/antlr4") +} +tasks.named("compileTestJava").configure { + dependsOn(tasks.named("generateTestGrammarSource")) +} + +mavenPublishing { + publishToMavenCentral() + signAllPublications() + + pom { + name.set("antlr4-c3") + description.set(project.description) + url.set("https://github.com/Strumenta/antlr4-c3-java") + + licenses { + license { + name.set("MIT License") + url.set("https://opensource.org/licenses/MIT") + distribution.set("repo") + } + } + + scm { + connection.set("scm:git:strumenta/antlr4-c3-java.git") + developerConnection.set("scm:git:git@github.com:strumenta/antlr4-c3-java.git") + url.set("https://github.com/strumenta/antlr4-c3-java.git") + tag.set("HEAD") + } + + developers { + developer { + id.set("nicks") + name.set("Nick Stephen") + email.set("nicks _at_ vmware.com") + organization.set("VMware") + timezone.set("Europe/Paris") + } + developer { + id.set("tiagobstr") + name.set("Tiago Baptista") + email.set("tiago _at_ strumenta.com") + organization.set("Strumenta") + timezone.set("Europe/Lisbon") + } + developer { + id.set("ftomassetti") + name.set("Federico Tomassetti") + email.set("federico _at_ strumenta.com") + organization.set("Strumenta") + timezone.set("Europe/Rome") + } + } + } +} + +signing { + val pub = publishing.publications.findByName("mavenJava") + if (pub != null && (findProperty("signing.keyId") != null || System.getenv("SIGNING_KEY_ID") != null)) { + sign(pub) + } +} + +release { + buildTasks = listOf("publish") + versionPropertyFile = "./gradle.properties" + git { + requireBranch.set("main") + pushToRemote.set("origin") + } +} + +tasks.named("sourcesJar").configure { + dependsOn(tasks.named("generateGrammarSource")) +} +//tasks.named("generateMetadataFileForMavenPublication").configure { +// dependsOn(tasks.named("plainJavadocJar")) +//} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..c3aefdf --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +version=1.2.0-SNAPSHOT \ No newline at end of file diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..d7238a9 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,2 @@ +[plugins] +vanniktech-publish = { id = "com.vanniktech.maven.publish", version = "0.34.0" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..1b33c55 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ca025c8 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..23d15a9 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH="\\\"\\\"" + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..db3a6ac --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/pom.xml b/pom.xml deleted file mode 100644 index a409aa7..0000000 --- a/pom.xml +++ /dev/null @@ -1,209 +0,0 @@ - - 4.0.0 - com.vmware.antlr4-c3 - antlr4-c3 - jar - 1.2-SNAPSHOT - antlr4-c3 - - A code completion core implementation for ANTLR4 based parsers - - https://github.com/mike-lischke/antlr4-c3 - - - - maven-central - https://oss.sonatype.org/content/repositories/snapshots - - - - - - MIT License - https://opensource.org/licenses/MIT - repo - - - - - - scm:git:mike-lischke/antlr4-c3.git - - https://github.com/mike-lischke/antlr4-c3.git - scm:git:git@github.com:mike-lischke/antlr4-c3.git - HEAD - - - - - nicks - Nick Stephen - nicks _at_ vmware.com - VMware - Europe/Paris - - - - - - ossrh - https://oss.sonatype.org/content/repositories/snapshots - - - - - 5.12.1 - 4.7 - - UTF-8 - UTF-8 - - - - - - org.junit.jupiter - junit-jupiter-api - ${junit.version} - test - - - - org.antlr - antlr4-runtime - ${antlr4.version} - - - - - - - - org.apache.maven.plugins - maven-project-info-reports-plugin - 2.7 - - - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.7 - true - - ossrh - https://oss.sonatype.org/ - true - - - - org.antlr - antlr4-maven-plugin - ${antlr4.version} - - - antlr-test - generate-test-sources - - antlr4 - - - true - true - true - ${basedir}/src/test/antlr4 - ${project.build.directory}/generated-test-sources/antlr4 - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.1 - - 1.8 - 1.8 - - -Xlint:all,-options,-path - - javac - true - - - - - - - - release - - - - org.apache.maven.plugins - maven-source-plugin - 3.0.1 - - - attach-sources - - jar-no-fork - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - 2.9.1 - - - attach-javadocs - - jar - - - - - - org.apache.maven.plugins - maven-gpg-plugin - 1.5 - - - sign-artifacts - verify - - sign - - - - - - - - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - 3.0.0-M1 - - - org.owasp - dependency-check-maven - 2.1.1 - - 8 - - - - - aggregate - - - - - - - diff --git a/src/main/java/com/vmware/antlr4c3/CodeCompletionCore.java b/src/main/java/com/strumenta/antlr4c3/CodeCompletionCore.java similarity index 99% rename from src/main/java/com/vmware/antlr4c3/CodeCompletionCore.java rename to src/main/java/com/strumenta/antlr4c3/CodeCompletionCore.java index 950c065..6c4e4bb 100644 --- a/src/main/java/com/vmware/antlr4c3/CodeCompletionCore.java +++ b/src/main/java/com/strumenta/antlr4c3/CodeCompletionCore.java @@ -5,7 +5,7 @@ * * See LICENSE file for more info. */ -package com.vmware.antlr4c3; +package com.strumenta.antlr4c3; import org.antlr.v4.runtime.*; import org.antlr.v4.runtime.atn.*; diff --git a/src/test/antlr4/com/vmware/antlr4c3/Expr.g4 b/src/test/antlr/com/strumenta/antlr4c3/Expr.g4 similarity index 100% rename from src/test/antlr4/com/vmware/antlr4c3/Expr.g4 rename to src/test/antlr/com/strumenta/antlr4c3/Expr.g4 diff --git a/src/test/antlr4/com/vmware/antlr4c3/Whitebox.g4 b/src/test/antlr/com/strumenta/antlr4c3/Whitebox.g4 similarity index 100% rename from src/test/antlr4/com/vmware/antlr4c3/Whitebox.g4 rename to src/test/antlr/com/strumenta/antlr4c3/Whitebox.g4 diff --git a/src/test/java/com/vmware/antlr4c3/CountingErrorListener.java b/src/test/java/com/strumenta/antlr4c3/CountingErrorListener.java similarity index 94% rename from src/test/java/com/vmware/antlr4c3/CountingErrorListener.java rename to src/test/java/com/strumenta/antlr4c3/CountingErrorListener.java index b7c9cc5..510f471 100644 --- a/src/test/java/com/vmware/antlr4c3/CountingErrorListener.java +++ b/src/test/java/com/strumenta/antlr4c3/CountingErrorListener.java @@ -1,4 +1,4 @@ -package com.vmware.antlr4c3; +package com.strumenta.antlr4c3; import org.antlr.v4.runtime.BaseErrorListener; import org.antlr.v4.runtime.RecognitionException; diff --git a/src/test/java/com/vmware/antlr4c3/ExprTest.java b/src/test/java/com/strumenta/antlr4c3/ExprTest.java similarity index 99% rename from src/test/java/com/vmware/antlr4c3/ExprTest.java rename to src/test/java/com/strumenta/antlr4c3/ExprTest.java index ff85239..28d08b3 100644 --- a/src/test/java/com/vmware/antlr4c3/ExprTest.java +++ b/src/test/java/com/strumenta/antlr4c3/ExprTest.java @@ -5,7 +5,7 @@ * * See LICENSE file for more info. */ -package com.vmware.antlr4c3; +package com.strumenta.antlr4c3; import java.util.Arrays; import java.util.HashSet; diff --git a/src/test/java/com/vmware/antlr4c3/WhiteboxTest.java b/src/test/java/com/strumenta/antlr4c3/WhiteboxTest.java similarity index 99% rename from src/test/java/com/vmware/antlr4c3/WhiteboxTest.java rename to src/test/java/com/strumenta/antlr4c3/WhiteboxTest.java index b1ff1a8..87a2353 100644 --- a/src/test/java/com/vmware/antlr4c3/WhiteboxTest.java +++ b/src/test/java/com/strumenta/antlr4c3/WhiteboxTest.java @@ -5,7 +5,7 @@ * * See LICENSE file for more info. */ -package com.vmware.antlr4c3; +package com.strumenta.antlr4c3; import java.util.List; import java.util.Set;