Add Java subproject allowing tasks to be programmed in Java with Python wrappers

.gitignore

@@ -158,3 +158,51 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+
+# Maven Projects ----------------------------------------------------------------------------------
+# https://github.com/github/gitignore/blob/main/Maven.gitignore
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+# Eclipse m2e generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Java Projects -----------------------------------------------------------------------------------
+# https://github.com/github/gitignore/blob/main/Java.gitignore
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*

README.md

@@ -1,9 +1,10 @@
 # C4 Sign
 funny sign go brrrrrrrr
 
-![An image of the C4 Sign, displaying the C4 Logo](./docs/images/demo.jpg)
+![An image of the C4 Sign, displaying the C4 Logo](./docs/images/demo.png)
 
 The C4 Sign is an LED sign that students can write programs for to display at our events on campus!
+Programs can be written in either Java or Python.
 It features a 32x32 color LED display for graphics and a 16x2 character LCD screen for text.
 
 If you are interested in writing a display program for it, please make a fork of this repository.
@@ -12,33 +13,23 @@ Get in touch with us if you have any questions or want advice for how to write y
 The LED Sign channel of our discord server is a great place to get advice both from club executives and from other students.
 Feel free to make whatever you like for the sign, this is a chance to use your programming skills to channel your creativity and self-expression!
 
-# Installation and Setup
+## Tutorial
 
 Check [the tutorial](./docs/tutorial.md) to learn how you can begin writing your own sign programs.
 
-# Program Examples
-You can see simulated outputs of the display programs [here](./docs/screen_tasks.md).
-If you want to see how each task works, the programs can be found in `/c4_sign/screen_tasks`.
+## Program Examples
+You can watch each display program [here](./docs/screen_tasks.md).
+If you want to see how each task works, the programs can be found in `/c4_sign/screen_tasks` and `/c4_sign/java_c4sign/src/main/java/com/cornellcollegecomputingclub/c4sign_tasks`.
 
 ## Documentation
 Our documentation is currently incomplete, but much of the screen's workings can be found in the `/docs/` directory.
 See the [documentation home page](./docs/index.md).
 
 ## Simulator
 
-The simulator is a simple program that simulates the sign. It's not perfect, but it's good enough for testing.
+The simulator is a simple program that simulates the sign.
 It allows you to write programs for the sign without physical access!
 
-```bash
-python3 -m pip install -e '.[simulator]'
-python3 -m c4_sign --simulator
-```
-
-You can test the simulator at any time you like by running with the following command:
-```bash
-python3 -m c4_sign --simulator
-```
-This will open a new browser window where you can interact with the sign simulator. Currently, it looks like this:
 ![The simulator displaying the "pong" task](./docs/images/simulator.png)
 
 It shows you a visualization of the 32 by 32 pixel matrix, and the attached 16x2 character LCD screen.
@@ -47,16 +38,7 @@ You can use the dropdown menu at the bottom to choose a task to run, then press
 You can use the simulator to test out your program without needing to be near the sign all the time!
 Whenever you make changes to your program, visualizing them is as simple as running the above command and selecting it in the simulator
 
-## Real Sign
-
-[To be written]
-
-```bash
-python3 -m pip install -e '.[physical]'
-python3 -m c4_sign
-```
-
-# Wishlist
+## Wishlist
 The following is a list of programs that could be neat to have on our sign!
 If you are unsure what to make, you can use the list below as inspiration.
 
@@ -71,6 +53,35 @@ If you are unsure what to make, you can use the list below as inspiration.
 
 If you want to make something, but are struggling with ideas, feel free to reach out to us or ask in our Discord.
 
+# Installation
+
+In order to make a program that runs on the sign, you will have to locally install the sign software and simulator so that you can test your program.
+
+Here's how you can install the C4 Sign software:
+
+1. Make sure you have Python and Git installed. Python 3.9 or above should be good. *If you want to write your program with Java, which is recommended for graphics-intense tasks, make sure to also install Maven.*
+2. Sign into Github and make a fork of this repository.
+3. Navigate to the folder where you would like to download the software, and clone your fork of our git repository!
+`git clone https://github.com/{Your username here}/c4-sign`
+4. Enter the `c4-sign` repository by typing `cd c4-sign`.
+5. **Optional:** If you want to, you can create a virtual environment for this project. If you don't know what a virtual environment is, you can skip this step. If you want to make one, run `python3 -m venv ./venv` and then activate the virtual environment in whichever way you typically do that with your operating system.
+6. Run `python3 -m pip install -e '.[simulator]'`. This will install the simulator software on your computer.
+
+Congrats! You can now run the simulator in **python-only** mode. To do so, run:
+`python3 -m c4_sign --simulator --disable-java` and a new web browser window will appear with the simulator! It may take a while for that to happen as it will download certain resources first.
+
+If you want to work with Java, there are a few more steps.  
+
+7. Run `python3 tools/setup_java_project.py`. This will make sure the necessary Java and Python dependencies are available.  
+8. Run `python3 tools/compile_java_project.py`. This will compile the Java project correctly for the sign software to use it. **You must run this command every time you want to test changes to a Java file.**
+
+Nice! Now you can run the simulator in **python and java mode**. To do so, run:
+`python3 -m c4_sign --simulator`. The Java and the Python tasks should now be available!
+
+Problems?
+
+Please email us or ask for help in the `#led-sign` channel of our discord server!
+
 ## Updates
 
 Updates happen either:

bin/start_sign.sh

@@ -20,6 +20,8 @@ git pull
 # sudo python3 -m pip install -e .
 # this takes a while to run. TODO: FIX.
 
+/home/c4/c4-sign/venv/bin/python3 tools/compile_java_project.py
+
 sudo /home/c4/c4-sign/venv/bin/python3 -m c4_sign
 
 exit 0

c4_sign/ScreenManager.py

@@ -1,21 +1,30 @@
 import importlib
 from datetime import timedelta
 import random
+import subprocess
+import os
+import sys
 from typing import Union
+from pathlib import Path
+from time import sleep
 
 from loguru import logger
 
-from c4_sign.base_task import OptimScreenTask, ScreenTask
+from py4j.java_gateway import JavaGateway
+from py4j.protocol import Py4JError
+
+from c4_sign.base_task import OptimScreenTask, ScreenTask, JavaTask
 from c4_sign.lib.canvas import Canvas
 from c4_sign.loading_manager import LoadingManager
 
 
 class ScreenManager:
-    def __init__(self, make_histograms):
+    def __init__(self, make_histograms, enable_java):
         self.tasks = []
         self.current_task = None
         self.index = 0
         self.make_histograms = make_histograms
+        self.java_enabled = enable_java
 
     @property
     def current_tasks(self) -> list[ScreenTask]:
@@ -31,7 +40,7 @@ def update_tasks(self, loading_manager: Union[None, LoadingManager] = None):
                 if (
                     isinstance(obj, type)
                     and issubclass(obj, ScreenTask)
-                    and obj not in (ScreenTask, OptimScreenTask)
+                    and obj not in (ScreenTask, OptimScreenTask, JavaTask)
                     and obj.ignore is False
                 ):
                     logger.debug("Adding screen task: {}", obj.__name__)
@@ -45,6 +54,43 @@ def update_tasks(self, loading_manager: Union[None, LoadingManager] = None):
                         instance.set_make_histogram(self.make_histograms)
                         self.tasks.append(instance)
                     logger.debug("Screen Task {} added!", obj.__name__)
+
+
+        if self.java_enabled:
+            # start java server!
+
+            script_path = os.path.abspath(os.path.dirname(__file__))
+
+            classpath_delimiter = ";" if os.name == "nt" else ":"
+
+            # TODO: Think about extracting this somewhere that makes more sense.
+            c4_jar = str(Path(script_path) / "java_c4sign" / "target" / "java_c4sign-1.0-SNAPSHOT.jar")
+            lang3_jar = str(Path.home() / ".m2" / "repository" / "org" / "apache" / "commons" / "commons-lang3" / "3.17.0" / "commons-lang3-3.17.0.jar")
+            math3_jar = str(Path.home() / ".m2" / "repository" / "org" / "apache" / "commons" / "commons-math3" / "3.6.1" / "commons-math3-3.6.1.jar")
+
+            gateway = JavaGateway.launch_gateway(classpath=classpath_delimiter.join([c4_jar, lang3_jar, math3_jar]), die_on_exit=True)
+
+            java_task_controller = gateway.jvm.com.cornellcollegecomputingclub.java_c4sign.JavaTaskController()
+
+            tasks = java_task_controller.getActiveTasks()
+
+            logger.info("Connection to Py4J Gateway Server established!")
+
+            logger.debug("Java tasks discovered!")
+            for task in tasks:
+                if loading_manager:
+                    with loading_manager(task.getTitle()):
+                        instance = JavaTask(task)
+                        instance.set_make_histogram(self.make_histograms)
+                        self.tasks.append(instance)
+                else:
+                    instance = JavaTask(task)
+                    instance.set_make_histogram(self.make_histograms)
+                    self.tasks.append(instance)
+                logger.debug("Screen Task {} added!", task.getTitle())
+        else:
+            logger.warning("Java tasks are disabled! This is fine on the simulator, but make sure they're enabled in the physical display!")
+
         # now, shuffle the tasks with an arbitrary seed (so that it's the same between simulator and real)
         rand = random.Random(0xd883ff)
         rand.shuffle(self.tasks)
@@ -54,14 +100,14 @@ def override_current_task(self, task: Union[str, ScreenTask]):
         # if task is a string, find the task by name
         if isinstance(task, str):
             for t in self.tasks:
-                if t.__class__.__name__ == task:
+                if t.canonical_name == task:
                     task = t
                     break
             else:
                 # task not found!
                 logger.warning(f"Task {task} not found!")
                 return
-        logger.info("Overriding current task with {}", task.__class__.__name__)
+        logger.info("Overriding current task with {}", task.canonical_name)
         if self.current_task:
             self.current_task.teardown(True)
         self.current_task = task
@@ -75,7 +121,7 @@ def draw(self, canvas: Canvas, delta_time: timedelta):
                 logger.debug("Looping back to the start!")
                 self.index = 0
             self.current_task = self.current_tasks[self.index]
-            logger.debug("Trying to start task: {}", self.current_task.__class__.__name__)
+            logger.debug("Trying to start task: {}", self.current_task.canonical_name)
             if not self.current_task.prepare():
                 # uh... we don't want to do anything!
                 # so let's just skip this task!
@@ -85,9 +131,9 @@ def draw(self, canvas: Canvas, delta_time: timedelta):
                 if self.index >= len(self.current_tasks):
                     self.index = 0
                 return self.draw(canvas, delta_time)
-            logger.debug("Task {} ready!", self.current_task.__class__.__name__)
+            logger.debug("Task {} ready!", self.current_task.canonical_name)
         if self.current_task.draw(canvas, delta_time):
-            logger.debug("Task {} finished!", self.current_task.__class__.__name__)
+            logger.debug("Task {} finished!", self.current_task.canonical_name)
             self.current_task = None
             self.index += 1
             return True