Helper now Java Native Library

Cube Control/Frame.java

@@ -801,20 +801,6 @@ public class Frame extends JFrame implements ListSelectionListener {
         System.out.println("All LEDs off now...");
       }
 
-    if (s.equals("e") || s.equals("exec")) {
-          System.out.println(HelperUtility.runHelper(new String[0]));
-    }
-
-    if (s.startsWith("e ") || s.startsWith("exec ")) {
-      int pos = 0;
-      while (s.charAt(pos) != ' ') {
-        pos++;
-      }
-      String[] arr = new String[1];
-      arr[0] = s.substring(pos + 1);
-      System.out.println(HelperUtility.runHelper(arr));
-    }
-
 	if (s.equals("r") || s.equals("reset")) {
 		l.resetView();
 	}
@@ -824,7 +810,6 @@ public class Frame extends JFrame implements ListSelectionListener {
         System.out.println("\t'on'     / '1'\t:\tToggle all LEDs on");
         System.out.println("\t'off'    / '0'\t:\tToggle all LEDs off");
         System.out.println("\t'print'  / 'p'\t:\tPrint 3D Translation Matrix Data");
-		System.out.println("\t'exec'   / 'e'\t:\tExecute helper with given args");
 		System.out.println("\t'reset'  / 'r'\t:\tReset rotation of cube");
         System.out.println("\t'help'   / 'h'\t:\tShow this message");
         System.out.println("\t'quit'   / 'q'\t:\tExit Cube Control");

Cube Control/HelperUtility.java

@@ -21,27 +21,8 @@
  * along with LED-Cube.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import java.io.File;
-import java.io.Closeable;
-import java.io.FileNotFoundException;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStream;
-import java.io.BufferedReader;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.net.URL;
-import java.security.CodeSource;
-import java.security.ProtectionDomain;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipException;
-import java.util.zip.ZipFile;
-import java.lang.Process;
-
 /**
- * This helper class extracts the serialHelper from the JAR file, makes it executable and executes it with the given Command line arguments.
+ * Helper class which runs our native library.
  * @author Thomas Buck
  * @author Max Nuding
  * @author Felix Bäder
@@ -50,174 +31,27 @@ import java.lang.Process;
 
 public class HelperUtility {
 
-	/**
-	 * Run the serialHelper with the given arguments
-	 * @param args Command line arguments for serialHelper
-	 * @return Output of helper
-	 */
-	public static String runHelper(String[] args) {
-		String[] helperName = new String[args.length + 1];
-		boolean windows = false;
-		if ((System.getProperty("os.name").toLowerCase()).indexOf("win") >= 0) {
-			helperName[0] = "serialHelper.exe";
-			windows = true;
-		} else {
-			helperName[0] = "serialHelper";
-		}
-		for (int i = 0; i < args.length; i++) {
-			helperName[i + 1] = args[i];
-		}
-		String ret = "";
-		try {
-			File helper = new File(getFile(getJarURI(), helperName[0]));
-			helperName[0] = helper.getAbsolutePath();
-			if (!windows) {
-				Process execute = Runtime.getRuntime().exec("chmod a+x " + helper.getAbsolutePath());
-				execute.waitFor();
-				if (execute.exitValue() != 0) {
-					System.out.println("Could not set helper as executeable (" + execute.exitValue()+ ")");
-					return null;
-				}
-			}
-			Process p = Runtime.getRuntime().exec(helperName);
-			BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()), 256);
-			String line;
-			boolean fin;
-			
-			do {
-				fin = true;
-				try {
-					System.out.println("Returned " + p.waitFor());
-				} catch(InterruptedException e) {
-					// repeat
-					System.out.println("We got interrupted...");
-					fin = false;
-				}
-			} while (fin != true);
-
-			while ((line = br.readLine()) != null) {
-				ret = ret + line + "\n";
-			}
-
-			br.close();
-			if (ret.length() > 0) {
-				ret = ret.substring(0, ret.length() - 1);
-			}
-			return ret;
-		} catch(Exception e) {
-			e.printStackTrace();
-		}
-
-		return null;
+	static {
+		System.loadLibrary("Serial");
 	}
 
-	// From http://stackoverflow.com/questions/600146/run-exe-which-is-packaged-inside-jar
-	private static URI getJarURI()
-        throws URISyntaxException
-    {
-        final ProtectionDomain domain;
-        final CodeSource       source;
-        final URL              url;
-        final URI              uri;
-
-        domain = cubeWorker.class.getProtectionDomain();
-        source = domain.getCodeSource();
-        url    = source.getLocation();
-        uri    = url.toURI();
-
-        return (uri);
-    }
-
-    private static URI getFile(final URI    where,
-                               final String fileName)
-        throws ZipException,
-               IOException
-    {
-        final File location;
-        final URI  fileURI;
-
-        location = new File(where);
-
-        // not in a JAR, just return the path on disk
-        if(location.isDirectory())
-        {
-            fileURI = URI.create(where.toString() + fileName);
-        }
-        else
-        {
-            final ZipFile zipFile;
-
-            zipFile = new ZipFile(location);
-
-            try
-            {
-                fileURI = extract(zipFile, fileName);
-            }
-            finally
-            {
-                zipFile.close();
-            }
-        }
-
-        return (fileURI);
-    }
-
-    private static URI extract(final ZipFile zipFile,
-                               final String  fileName)
-        throws IOException
-    {
-        final File         tempFile;
-        final ZipEntry     entry;
-        final InputStream  zipStream;
-        OutputStream       fileStream;
-
-        tempFile = File.createTempFile(fileName, Long.toString(System.currentTimeMillis()));
-        tempFile.deleteOnExit();
-        entry    = zipFile.getEntry(fileName);
-
-        if(entry == null)
-        {
-            throw new FileNotFoundException("cannot find file: " + fileName + " in archive: " + zipFile.getName());
-        }
-
-        zipStream  = zipFile.getInputStream(entry);
-        fileStream = null;
-
-        try
-        {
-            final byte[] buf;
-            int          i;
-
-            fileStream = new FileOutputStream(tempFile);
-            buf        = new byte[1024];
-            i          = 0;
-
-            while((i = zipStream.read(buf)) != -1)
-            {
-                fileStream.write(buf, 0, i);
-            }
-        }
-        finally
-        {
-            close(zipStream);
-            close(fileStream);
-        }
+	/**
+	 * Get all the existing serial port names
+	 * @return List of port names. \n between entries
+	 */
+	public static native String getPorts();
 
-        return (tempFile.toURI());
-    }
+	/**
+	 * Read data from Cube
+	 * @param length Amount of data to read
+	 * @return Data read
+	 */
+	public static native short[] readData(int length);
 
-    private static void close(final Closeable stream)
-    {
-        if(stream != null)
-        {
-            try
-            {
-                stream.close();
-            }
-            catch(final IOException ex)
-            {
-                ex.printStackTrace();
-            }
-        }
-    }
+	/**
+	 * Write data to Cube
+	 * @param data Data to write
+	 * @param length Length of data
+	 */
+	public static native void writeData(short[] data, int length);
 }

Cube Control/cubeWorker.java

@@ -381,15 +381,7 @@ public class cubeWorker {
 	 */
     public String[] getSerialPorts() {
 		String[] ports = {"Select serial port..."};
-		String helperName;
-		if ((System.getProperty("os.name").toLowerCase()).indexOf("win") >= 0) {
-			helperName = "serialHelper.exe";
-		} else {
-			helperName = "serialHelper";
-		}
-		String[] arg = {"p"};
-		String portLines = HelperUtility.runHelper(arg);
-		// System.out.println("Output: " + portLines);
+		String portLines = HelperUtility.getPorts();
 		if (portLines == null) {
 			return ports;
 		}

Cube Control/helper/unixSerial.c

@@ -134,6 +134,7 @@ char** namesInDev(int *siz) {
 		tmp[3] = 'v';
 		tmp[4] = '/';
 		files[i] = strncat(tmp, files[i], strlen(files[i]));
+		free(tmp);
 	}
 
 	*siz = size;

Cube Control/makefile

@@ -1,20 +1,23 @@
 JAVAC = javac
 JAVADOC = javadoc
+JAVAH = javah
 DOCDIR = doc
 CC = gcc
-#TARGET = unix
-TARGET= cygwin
+TARGET = unix
+#TARGET= cygwin
 #TARGET = win
 
+HEADERPATH = /System/Library/Frameworks/JavaVM.framework/Headers
+
 # Java files to be compiled
 # Needs to be a complete list so they work as target
 JAVAFILES = HelperUtility.java AnimationUtility.java Animation.java AFrame.java cubeWorker.java layerEditFrame.java Led3D.java Frame.java
 
 ifeq ($(TARGET),unix)
-INJAR = *.class *.png serialHelper
-RM = rm
+INJAR = *.class *.png
+RM = rm -f
 else
-INJAR = *.class *.png serialHelper.exe
+INJAR = *.class *.png
 RM = del
 endif
 
@@ -26,7 +29,7 @@ RM = rm
 endif
 
 # Spit out jar file, documentation, delete intermediate files
-all: build clean
+all: build
 
 # Generate Documentation
 doc: doc/index.html
@@ -35,7 +38,7 @@ doc: doc/index.html
 java: Frame.class
 
 # Spit out jar file, dont remove anything after that
-build: Frame.class serialHelper
+build: Frame.class libSerial
 	jar -cmf manifest.txt "Cube Control.jar" $(INJAR)
 
 # Compile java files
@@ -47,18 +50,27 @@ doc/index.html: $(JAVAFILES)
 
 # Compile serial Helper
 ifeq ($(TARGET),unix)
-serialHelper: serialHelper.c helper/unixSerial.c
-	$(CC) -o serialHelper serialHelper.c
+libSerial: serialInterface.h serialHelper.c helper/unixSerial.c
+	$(CC) -x c -I$(HEADERPATH) -c serialHelper.c -o serialHelper.o
+	$(CC) -dynamiclib -o libSerial.jnilib serialHelper.o
 else
-serialHelper: serialHelper.c helper/winSerial.c
-	$(CC) -o serialHelper.exe -D winHelper serialHelper.c
+libSerial: serialInterface.h serialHelper.c helper/winSerial.c
+	$(CC) -x c -I$(HEADERPATH) -c serialHelper.c -o serialHelper.o -D winHelper
+	$(CC) -dynamiclib -o libSerial.dll serialHelper.o
 endif
 
+serialInterface.h:
+	$(JAVAC) HelperUtility.java
+	$(JAVAH) -o serialInterface.h HelperUtility
+
 # Delete intermediate files
 clean:
 	$(RM) *.class
+	$(RM) *.h
+	$(RM) *.o
+	$(RM) *.jar
 ifeq ($(TARGET),unix)
-	$(RM) serialHelper
+	$(RM) *.jnilib
 else
-	$(RM) serialHelper.exe
+	$(RM) *.dll
 endif

Cube Control/serialHelper.c

@@ -22,6 +22,8 @@
  */
 #include <stdlib.h>
 #include <stdio.h>
+#include <jni.h>
+#include "serialInterface.h"
 
 #ifdef winHelper
 #include "helper/winSerial.c"
@@ -29,200 +31,42 @@
 #include "helper/unixSerial.c"
 #endif
 
-char *fileData = NULL;
-
-void removeFromBeginning(size_t size, size_t remove);
-size_t readFile(char *path);
-size_t getFileSize(FILE *fp);
-void usage(char *name);
-int parseNumber(char *s);
-int power(int num, int pow);
-void printFileData(size_t size);
-void printSerialPorts(char ** ports);
-
-/*
-Return values:
-0: Success
-1: Usage error
-2: Serial Port Error
-3: Data File Error
-*/
-
-int main(int argc, char *argv[]) {
-	size_t length, written;
-
-		// printf("Debugging Worker... Ignore me!\n");
-
-		if (argc < 2) {
-			usage(argv[0]);
-			return 1;
+JNIEXPORT jstring JNICALL Java_HelperUtility_getPorts(JNIEnv *env, jclass class) {
+	char **ports = getSerialPorts();
+	char *string = NULL;
+	int length = 0, leng2 = 0, lengthabs = 0;;
+	while (ports[length] != NULL) {
+		while (ports[length][leng2] != '\0') {
+			leng2++;
 		}
-
-		if (argv[1][0] == 'p') {
-
-			if (argc != 2) {
-				usage(argv[0]);
-				return 1;
-			}
-			char** ports = getSerialPorts();
-			printSerialPorts(ports);
-			free(ports);
-			return 0;
-
-		} else if (argv[1][0] == 'w') {
-
-			if (argc != 4) {
-				usage(argv[0]);
-				return 1;
-			}
-			if (serialOpen(argv[2]) != 0) {
-				printf("Error: Could not open %s\n", argv[1]);
-				return 2;
-			}
-			// write file to com port
-			length = readFile(argv[3]);
-			if (length == 0) {
-				printf("Error while reading %s\n", argv[2]);
-				return 3;
-			}
-	
-			written = serialWrite(fileData, length);
-			while (written < length) {
-				removeFromBeginning(length, written);
-				length -= written;
-				written = serialWrite(fileData, length);
-			}
-
-		} else if (argv[1][0] == 'r') {
-
-			if (argc != 4) {
-				usage(argv[0]);
-				return 1;
-			}
-			if (serialOpen(argv[2]) != 0) {
-				printf("Error: Could not open %s\n", argv[1]);
-				return 2;
-			}
-			// Read from com port to file
-			if (argc < 5) {
-				printf("No size given. ");
-				usage(argv[0]);
-				return 1;
-			}
-			
-			length = parseNumber(argv[3]);
-			fileData = (char *)malloc(length * sizeof(char));
-			// fill fileData with serial Port data
-			written = 0;
-			while (written < length) {
-				written = serialRead(fileData + written, length - written);
-			}
-
-			printFileData(length);
-
-		} else {
-			printf("Unrecognized Option: %s\n", argv[1]);
-			usage(argv[0]);
-			return 1;
-		}
-
-		free(fileData);
-		fileData = NULL;
-		serialClose();
-		return 0;
-	// }
-}
-
-void removeFromBeginning(size_t size, size_t remove) {
-	size_t i;
-	char *tmp = (char *)malloc((size - remove) * sizeof(char));
-
-	for (i = 0; i < (size - remove); i++) {
-		tmp[i] = fileData[i + remove];
-	}
-	free(fileData);
-	fileData = tmp;
-}
-
-size_t readFile(char *path) {
-	size_t size, i;
-	FILE *fp;
-
-	fp = fopen(path, "r");
-	if (!fp) {
-		return 0;
-	}
-
-	size = getFileSize(fp);
-	fileData = (char *)malloc(size * sizeof(char));
-	for (i = 0; i < size; i++) {
-		fileData[i] = fgetc(fp);
+		lengthabs += leng2;
+		leng2 = 0;
+		length++;
 	}
-
-	fclose(fp);
-	return size;
-}
-
-size_t getFileSize(FILE *fp) {
-	size_t size = 0;
-	int c;
-
-	fseek(fp, 0, 0); // Set file pointer to beginning
 	
-	do { // Calculate size
-		c = fgetc(fp);
-		size++;
-	} while (c != EOF);
-	size--;
+	length += lengthabs;
+	string = (char *)malloc((length * sizeof(char)) + 1);
 	
-	fseek(fp, 0, 0);
-
-	return size;
-}
-
-void usage(char *name) {
-#ifdef winHelper
-	printf("Usage:\n%s r|w|p [COM1 [C:\\file\\to\\send.txt] [sizeToRead]]\n", name);
-#else
-	printf("Usage:\n%s r|w|p [/dev/SerialPort [/file/to/send] [sizeToRead]]\n", name);
-#endif
-}
-
-int parseNumber(char *s) {
-	int i, size = 0, result = 0;
-	while (*(s++) != '\0') {
-		size++;
-	}
-	for (i = 0; i < size; i++) {
-		result += (s[i] - '0') * power(10, (size - i));
+	length = 0;
+	lengthabs = 0;
+	while (ports[length] != NULL) {
+		leng2 = 0;
+		while (ports[length][leng2] != '\0') {
+			string[lengthabs++] = ports[length][leng2++];
+		}
+		string[lengthabs++] = '\n';
+		length++;
 	}
-	return result;
-}
+	string[lengthabs] = '\0';
 
-int power(int num, int pow) {
-	int result = 1;
-	while (pow > 0) {
-		result *= num;
-		pow--;
-	}
-	return result;
+	jstring ret = (*env)->NewStringUTF(env, string);
+	return ret;
 }
 
-void printFileData(size_t size) {
-	int i;
-	for (i = 0; i < size; i++) {
-		printf("%x", fileData[i]);
-		if (i % 8 == 0) {
-			printf("\n");
-		}
-	}
+JNIEXPORT jshortArray JNICALL Java_HelperUtility_readData(JNIEnv *env, jclass class, jint length) {
+	return NULL;
 }
 
-void printSerialPorts(char ** ports) {
-	int i = 0;
-	while (ports[i] != NULL) {
-		printf("%s\n", ports[i]);
-		i++;
-	}
+JNIEXPORT void JNICALL Java_HelperUtility_writeData(JNIEnv *env, jclass class, jshortArray data, jint length) {
+	return;
 }
-