diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..f02009334887b78b249a7e9a6f26c415e0ced978 --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,39 @@ +FROM openjdk:17-jdk-slim-bullseye + +# Install some basic development utilities +RUN apt-get update && apt-get install -y \ + curl \ + git \ + python3 \ + zip \ + && rm -rf /var/lib/apt/lists/* \ + && curl -fsSL https://deb.nodesource.com/setup_17.x | bash \ + && apt-get install -y nodejs \ + && npm install -g yarn \ + && rm -rf /var/lib/apt/lists/* + +# User the Java-based launcher as Alpine Linux and Graal native compiled images of CS don't like +# Alpine Linux (due to musl instead of gcc) +RUN bash -c 'curl -fLo /usr/bin/cs https://git.io/coursier-cli' && \ + chmod u+x /usr/bin/cs + +# Put Coursier-installed artifacts on the path +ENV PATH="$PATH:/root/.local/share/coursier/bin" + +# Get sbt +RUN bash -c 'cs install sbt' + +# Get http server +RUN bash -c 'npm install -g http-server' + +# Precache sbt version as part of the image. +ARG SBT_VERSION=1.7.0 +ARG SCALA_VERSION=3.1.3 +ARG SCALAJS_VERSION=1.10.1 +RUN mkdir -p /sbtprecacheproj/project && \ + cd /sbtprecacheproj && \ + echo sbt.version=${SBT_VERSION} > project/build.properties && \ + echo 'addSbtPlugin("org.scala-js" % "sbt-scalajs" % "'${SCALAJS_VERSION}'")' > project/plugins.sbt && \ + echo '@main def hello = println("hello")' > main.scala && \ + echo 'enablePlugins(ScalaJSPlugin); scalaVersion := "'${SCALA_VERSION}'"' > build.sbt && \ + sbt fastLinkJS && cd / && rm -r -f /tmp/sbt-precompile diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000000000000000000000000000000000000..9e15f079f1461dedcab45aa85618d29aa655d408 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,9 @@ +{ + "name": "Doctacular codespace config", + "build": { + "dockerfile": "Dockerfile" + }, + "extensions": [ + "vscjava.vscode-java-pack" + ] + } \ No newline at end of file diff --git a/.gitignore b/.gitignore index 21f59736ad015cfd0077ec30b7865b54748a5eb2..ede30d4a0c52fdd8c15f30cc7b15d08b6e0adf3e 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,6 @@ .gradle/ .idea/ build/ + +.vscode +bin/ diff --git a/README.md b/README.md index 3fde8647f795a9612818c45a018fba9aa6f39728..2830356903bfbab8c6075d0ba8fc0f2ef3715a9f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ ## A Git, GitLab, and JUnit exercise This assignment is intended to give you a relatively small exercise to give you a little familiarisation working with Git, Gradle, -JUnit, and JavaFX on a very small codebase - before you and your group do something much more exciting on the much larger -class-wide project. +JUnit, and some more recent Java language features on a very small codebase - +before you and your group do something much more exciting on the much larger class-wide project. -The example code you have been given is a simple JavaFX "dots and boxes" game. It has a couple of known bugs in it +The example code you have been given is a simple Java "dots and boxes" game. It has a couple of known bugs in it (already commented for you - the task is not really in finding the bugs). Please note: your task **is not simply to fix the bugs**. Your task is a series of steps that show you can work with git, gitlab, gradle, and junit. diff --git a/build.gradle b/build.gradle index 5705373c7f0724928eb4cbaed9cd028179e1239a..a64642b1797414bb041f02d82b739718fddbaa6f 100644 --- a/build.gradle +++ b/build.gradle @@ -7,12 +7,6 @@ buildscript { plugins { id 'application' - id 'org.openjfx.javafxplugin' version '0.0.10' -} - -javafx { - version = "15.0.1" - modules = [ 'javafx.controls' ] } group 'org.example' @@ -26,8 +20,8 @@ repositories { dependencies { // Log4J does logging. We'll meet it properly in a later week... - implementation 'org.apache.logging.log4j:log4j-api:2.12.0' - implementation 'org.apache.logging.log4j:log4j-core:2.12.0' + implementation 'org.apache.logging.log4j:log4j-api:2.18.0' + implementation 'org.apache.logging.log4j:log4j-core:2.18.0' testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0' @@ -39,4 +33,14 @@ test { application { mainClass = 'dotsandboxes.Main' +} + +task fatJar(type: Jar) { + manifest { + attributes 'Main-Class': 'dotsandboxes.Main' + } + baseName = 'executable-jar' + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + from { configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } } + with jar } \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c023ec8b20f512888fe07c5bd3ff77bb8f..7454180f2ae8848c63b8b4dea2cb829da983f2fa 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 068a225d0a542f0224482fdde421b956b3ed2e2d..84d1f85fd658134f7e982ae908fd537188f20bfe 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://turing.une.edu.au/~cosc220/distributions/gradle-7.1.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 4f906e0c811fc9e230eb44819f509cd0627f2600..1b6c787337ffb79f0e3cf8b1e9f00f680a959de1 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# 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. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# 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/master/subprojects/plugins/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 -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +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 -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # 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"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +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 - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || 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 @@ -106,80 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -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" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi +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 - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + 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 - i=`expr $i + 1` + # 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 - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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. +# -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +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 index 107acd32c4e687021ef32db511e8a206129b88ec..ac1b06f93825db68fb0c0b5150917f340eaa5d02 100755 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,89 +1,89 @@ -@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 - -@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=. -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%" == "0" goto execute - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="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! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega +@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 + +@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=. +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%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/src/main/java/dotsandboxes/DotsAndBoxesGrid.java b/src/main/java/dotsandboxes/DotsAndBoxesGrid.java index 4f774b198f230ca82e5cc94d51967846aa05d5f5..a9e7c5b6639e8a2a8728809d9b17c8d155baf9b6 100644 --- a/src/main/java/dotsandboxes/DotsAndBoxesGrid.java +++ b/src/main/java/dotsandboxes/DotsAndBoxesGrid.java @@ -3,7 +3,6 @@ package dotsandboxes; import java.util.ArrayList; import java.util.Arrays; -import java.util.Observer; import java.util.function.Consumer; /** diff --git a/src/main/java/dotsandboxes/DotsAndBoxesUI.java b/src/main/java/dotsandboxes/DotsAndBoxesUI.java index 66010e3938d422d2418c50f1962ed1c3d6f33050..eee385a1ba037b417b4a186d6a99ac7bb3006481 100644 --- a/src/main/java/dotsandboxes/DotsAndBoxesUI.java +++ b/src/main/java/dotsandboxes/DotsAndBoxesUI.java @@ -1,134 +1,194 @@ package dotsandboxes; -import javafx.scene.control.Label; -import javafx.scene.layout.AnchorPane; -import javafx.scene.paint.Color; -import javafx.scene.shape.Circle; -import javafx.scene.shape.Line; -import javafx.scene.shape.Rectangle; +import java.awt.*; +import java.awt.event.*; +import javax.swing.*; +import javax.swing.event.MouseInputAdapter; +import java.util.ArrayList; public class DotsAndBoxesUI { - final int lineLength = 32; - final int margin = 10; - final int gap = 0; - final int dotDiameter = 6; + static final int lineLength = 32; + static final int margin = 10; + static final int gap = 0; + static final int dotDiameter = 6; - final DotsAndBoxesGrid grid; - final AnchorPane anchorPane; - final Label label; + // The coordinate of the top or left of a the painting area for this row/col + private static int corner(int col) { + return margin + col * (gap + lineLength + gap + dotDiameter); + } /** Colours for the different players. Only goes up to 5. */ - final Color[] playerColours = { Color.WHITE, Color.RED, Color.BLUE, Color.GREEN, Color.PURPLE, Color.ORANGE }; + static final Color[] playerColours = { Color.WHITE, Color.RED, Color.BLUE, Color.GREEN, Color.PINK, Color.ORANGE }; + + final DotsAndBoxesGrid grid; + final JPanel anchorPane; + final Canvas canvas; + final JLabel label; private void updateLabel() { - label.setTextFill(playerColours[grid.getPlayer()]); + label.setForeground(playerColours[grid.getPlayer()]); label.setText(String.format("Player %d's turn", grid.getPlayer())); } public DotsAndBoxesUI(final DotsAndBoxesGrid grid) { this.grid = grid; - anchorPane = new AnchorPane(); + anchorPane = new JPanel(new BorderLayout()); - label = new Label(""); + label = new JLabel(""); updateLabel(); - grid.addConsumer((g) -> updateLabel()); - // Size the anchorPane to just contain the elements - int width = margin + dotDiameter + gap + (grid.width - 1) * (gap + lineLength + gap + dotDiameter) + gap + margin; - int height = margin + dotDiameter + gap + (grid.height - 1) * (gap + lineLength + gap + dotDiameter) + gap + margin; - anchorPane.setPrefSize(width, height); + canvas = new DABCanvas(); + + anchorPane.add(canvas, BorderLayout.CENTER); + anchorPane.add(label, BorderLayout.NORTH); + grid.addConsumer((g) -> { + updateLabel(); + canvas.repaint(); + }); + } + + /** A component that paints and handles clicks on the game */ + class DABCanvas extends Canvas { - // Lay out the boxes - for (int row = 0; row < grid.height - 1; row++) { - for (int col = 0; col < grid.width - 1; col++) { - final int x = col; - final int y = row; - Rectangle box = new Rectangle(gap, gap, lineLength, lineLength); - box.setFill(Color.WHITE); + final ArrayList<Horizontal> horizontals = new ArrayList<>(); + final ArrayList<Vertical> verticals = new ArrayList<>(); + final ArrayList<Box> boxes = new ArrayList<>(); - grid.addConsumer((g) -> { - box.setFill(playerColours[g.getBoxOwner(x, y)]); - }); + /** Represents a horizontal line. */ + record Horizontal(int col, int row) { + Rectangle rect() { + int x = corner(col) + dotDiameter + gap; + int y = corner(row); + return new Rectangle(x, y, lineLength, dotDiameter); + } + + /** Whether or not this line contains this point */ + boolean contains(int x, int y) { + return rect().contains(x, y); + } - AnchorPane.setLeftAnchor(box, gap + dotDiameter + col * (gap + lineLength + gap + dotDiameter) + dotDiameter/2.0); - AnchorPane.setTopAnchor(box, gap + dotDiameter + row * (gap + lineLength + gap + dotDiameter) + dotDiameter/2.0); - anchorPane.getChildren().add(box); + /** Paints this element, based on the passed in grid */ + public void draw(DotsAndBoxesGrid grid, Graphics2D g2d) { + g2d.setColor(grid.getHorizontal(col, row) ? Color.DARK_GRAY : Color.LIGHT_GRAY); + g2d.fill(this.rect()); } } - // Lay out the horizontals - for (int row = 0; row < grid.height; row++) { - for (int col = 0; col < grid.width - 1; col++) { - Line line = new Line(0, dotDiameter/2.0, lineLength, dotDiameter/2.0); - line.setStrokeWidth(dotDiameter); - line.setStroke(Color.DARKGREY); - - final int x = col; - final int y = row; - grid.addConsumer((g) -> { - if (g.getHorizontal(x, y)) { - line.setStroke(Color.BLACK); - } else { - line.setStroke(Color.LIGHTGRAY); - } - }); - - line.setOnMouseClicked((evt) -> {try { - grid.drawHorizontal(x, y, grid.getPlayer()); - } catch (IllegalStateException ex) { - // do nothing - // This is a little artificial, as normally we'd implement this with a check that the line isn't - // already "drawn" and then not calling the function. But for the exercise, we wanted students - // to write a test that would ensure an exception is thrown, so we're relying on an exception - // being thrown! - }}); - - AnchorPane.setLeftAnchor(line, 0.0 + gap + dotDiameter + col * (gap + lineLength + gap + dotDiameter)); - AnchorPane.setTopAnchor(line, -dotDiameter/2.0 + gap + dotDiameter + row * (gap + lineLength + gap + dotDiameter)); - anchorPane.getChildren().add(line); + /** Represents a horizontal line. */ + record Vertical(int col, int row) { + Rectangle rect() { + int x = corner(col); + int y = corner(row) + dotDiameter + gap; + return new Rectangle(x, y, dotDiameter, lineLength); + } + + /** Whether or not this line contains this point */ + boolean contains(int x, int y) { + return rect().contains(x, y); + } + + /** Paints this element, based on the passed in grid */ + public void draw(DotsAndBoxesGrid grid, Graphics2D g2d) { + g2d.setColor(grid.getVertical(col, row) ? Color.DARK_GRAY : Color.LIGHT_GRAY); + g2d.fill(this.rect()); } } - // Lay out the verticals - for (int row = 0; row < grid.height - 1; row++) { - for (int col = 0; col < grid.width; col++) { - Line line = new Line(-dotDiameter/2.0, 0, -dotDiameter/2.0, lineLength); - line.setStrokeWidth(dotDiameter); - line.setStroke(Color.DARKGREY); - - final int x = col; - final int y = row; - grid.addConsumer((g) -> { - if (g.getVertical(x, y)) { - line.setStroke(Color.BLACK); - } else { - line.setStroke(Color.LIGHTGRAY); - } - }); + /** represents a box */ + record Box(int col, int row) { + Rectangle rect() { + int x = corner(col) + dotDiameter + gap; + int y = corner(row) + dotDiameter + gap; + return new Rectangle(x, y, lineLength, lineLength); + } - line.setOnMouseClicked((evt) -> {try { - grid.drawVertical(x, y, grid.getPlayer()); - } catch (IllegalStateException ex) { - // do nothing - }}); + /** Whether or not this line contains this point */ + boolean contains(int x, int y) { + return rect().contains(x, y); + } - AnchorPane.setTopAnchor(line, 0.0 + gap + dotDiameter + row * (gap + lineLength + gap + dotDiameter)); - AnchorPane.setLeftAnchor(line, -dotDiameter/2.0 + gap + dotDiameter + col * (gap + lineLength + gap + dotDiameter)); - anchorPane.getChildren().add(line); + /** Paints this element, based on the passed in grid */ + public void draw(DotsAndBoxesGrid grid, Graphics2D g2d) { + g2d.setColor(playerColours[grid.getBoxOwner(col, row)]); + g2d.fill(this.rect()); } } - // Lay out the dots - for (int row = 0; row < grid.height; row++) { - for (int col = 0; col < grid.width; col++) { - Circle dot = new Circle(dotDiameter / 2.0); - dot.setFill(Color.YELLOW); - AnchorPane.setLeftAnchor(dot, gap + col * (gap + lineLength + gap + dotDiameter) + dotDiameter/2.0); - AnchorPane.setTopAnchor(dot, gap + row * (gap + lineLength + gap + dotDiameter) + dotDiameter/2.0); - anchorPane.getChildren().add(dot); + public DABCanvas() { + // Size the canvas to just contain the elements + int width = corner(grid.width) + margin; + int height = corner(grid.height) + margin; + this.setPreferredSize(new Dimension(width, height)); + + // Create records for the boxes + for (int row = 0; row < grid.height - 1; row++) { + for (int col = 0; col < grid.width - 1; col++) { + boxes.add(new Box(col, row)); + } + } + + // Create records for horizontals + for (int row = 0; row < grid.height; row++) { + for (int col = 0; col < grid.width - 1; col++) { + horizontals.add(new Horizontal(col, row)); + } + } + + // Create records for verticals + for (int row = 0; row < grid.height - 1; row++) { + for (int col = 0; col < grid.width; col++) { + verticals.add(new Vertical(col, row)); + } + } + + addMouseListener(new MouseInputAdapter() { + @Override public void mousePressed(MouseEvent e) { + for (Horizontal h : horizontals) { + if (h.contains(e.getX(), e.getY())) { + grid.drawHorizontal(h.col(), h.row(), grid.getPlayer()); + } + } + + for (Vertical v : verticals) { + if (v.contains(e.getX(), e.getY())) { + grid.drawVertical(v.col(), v.row(), grid.getPlayer()); + } + } + } + }); + + } + + @Override public void paint(Graphics g) { + Graphics2D g2d = (Graphics2D)g; + g.clearRect(0, 0, this.getWidth(), this.getHeight()); + g2d.setColor(Color.WHITE); + g.fillRect(0, 0, this.getWidth(), this.getHeight()); + + // Paint the boxes + for (Box b : boxes) { + b.draw(grid, g2d); + } + + // Paint the horizontals + for (Horizontal h : horizontals) { + h.draw(grid, g2d); + } + + // Paint the boxes + for (Vertical v : verticals) { + v.draw(grid, g2d); + } + + // Draw the dots + for (int row = 0; row < grid.height; row++) { + for (int col = 0; col < grid.width; col++) { + g2d.setColor(Color.BLACK); + g2d.fillOval(corner(col), corner(row), dotDiameter, dotDiameter); + } } } @@ -136,4 +196,5 @@ public class DotsAndBoxesUI { + } diff --git a/src/main/java/dotsandboxes/Main.java b/src/main/java/dotsandboxes/Main.java index cd003d1a27d26053a78244c6f69da68b883fd9be..98cd350a3380aaa35d947384f8c45e71a937fd72 100644 --- a/src/main/java/dotsandboxes/Main.java +++ b/src/main/java/dotsandboxes/Main.java @@ -1,40 +1,32 @@ package dotsandboxes; -import javafx.application.Application; -import javafx.scene.Scene; -import javafx.scene.control.Label; -import javafx.scene.layout.BorderPane; -import javafx.stage.Stage; +import javax.swing.*; +import java.awt.*; /** Our main class that launches the app. */ -public class Main extends Application { +public class Main { + + public static void main(String... args) throws Exception { - DotsAndBoxesGrid grid = new DotsAndBoxesGrid(15, 8, 2); - - @Override - public void start(Stage primaryStage) throws Exception { - primaryStage.setTitle("Dots and Boxes"); + JFrame mainWindow = new JFrame("Dots and Boxes"); + DotsAndBoxesGrid grid = new DotsAndBoxesGrid(15, 8, 2); // FIXME: Update this label to show your name and student number - Label label = new Label("Name: (Your name and student number goes here)"); + JLabel label = new JLabel("Name: (Your name and student number goes here)"); - BorderPane borderPane = new BorderPane(); - borderPane.setBottom(label); - Scene scene = new Scene(borderPane, 600, 400); + JPanel borderPane = new JPanel(new BorderLayout()); + borderPane.add(label, BorderLayout.SOUTH); DotsAndBoxesUI dbUi = new DotsAndBoxesUI(grid); - borderPane.setCenter(dbUi.anchorPane); - borderPane.setTop(dbUi.label); - - primaryStage.setScene(scene); + borderPane.add(dbUi.anchorPane, BorderLayout.CENTER); + borderPane.add(dbUi.label, BorderLayout.NORTH); + mainWindow.add(borderPane); - primaryStage.show(); + mainWindow.pack(); + mainWindow.setVisible(true); // This sets what to do when we close the main window. - // Notice that we are using a "lambda function" (i.e., an anonymously defined function defined within the - // call to setOnCloseRequest). These are very useful in GUI code and we'll probably see a lot of them in the - // project. - primaryStage.setOnCloseRequest((evt) -> System.exit(0)); + mainWindow.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); } } diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java deleted file mode 100644 index eb9361f159b402160086de3fe6b01b1272ab53b0..0000000000000000000000000000000000000000 --- a/src/main/java/module-info.java +++ /dev/null @@ -1,19 +0,0 @@ -/** - * This is a module file. - * - * Modules were introduced in Java 9, allowing modules to express dependencies on other modules and to publish their - * public packages. - * - * Using modules makes things easier when working with JavaFX, because JavaFX is itself published as a module. - * - * Please note: "module" in Java is not quite the same as "dependency" in Gradle. They are similar concepts, but - * "modules" is part of the Java language (but doesn't express how to find them on the internet) whereas - * "dependencies" is part of the Gradle build system and expresses how to find them on the internet (but does not - * specify the module imports to the Java compiler). We need both. - */ -module dotsAndBoxes { - requires javafx.graphics; - requires javafx.controls; - requires org.apache.logging.log4j; - exports dotsandboxes; -} \ No newline at end of file