org.firstinspires.ftc.onbotjava

Class OnBotJavaManager

java.lang.Object

org.firstinspires.ftc.onbotjava.OnBotJavaManager

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class OnBotJavaManager
extends java.lang.Object
implements java.io.Closeable

OnBotJavaManager is the main orchestrator of the OnBotJava build process.

The process is driven by reading and writing of files. In the FIRST directory, we now have a 'java' child. This class owns and manages that space. There are several subdirectories of 'java':

1. src: .java source code is placed here in package-appropriate subdirectories, in the usual Java style
2. jars: (optional) Any externally-compiled jar files can be placed in this directory. They will be installed in the system, much as the .java source files are after they have been compiled.
3. lib: Library files that source code is to be compiled against are placed here. Normally, this is automatically-managed: the system copies the necessary Android and FTC SDK libraries.
4. control: Whenever the contents of the 'buildRequest.txt' file in this directory is changed, a build is automatically kicked off it's not already running. Note that the contents of the file don't matter, only the act of changing it. This directory also contains a locking mechanism so as to allow clients to examine the state of a successful build without having to worry that a new build will be kicked off while they are doing so. See 'buildLock' below.
5. build: When a build runs, the binary artifacts for intermediate and final output state are managed in subdirectories thereof.
6. status: As the build progresses, several files are written. These files may be monitored for changes (see FileModifyObserver) as triggers to take actions to process the output of the build.
   1. buildStarted.txt: updated when the build starts
   2. buildSuccessful.txt: updated when the build has been determined to be successful
   3. buildComplete.txt: updated when the build finishes, whether or not it was successful
   4. buildLog.txt: contains unstructured output from the compiler and other build tools. Note that after successful builds, this will likely be empty.
   To this list it might be reasonable to add buildLog.xml that had a structured version of buildLog.txt, but that has not yet been implemented. Feedback is welcome.

The Annotated OpMode loading system is a client of this structure. It monitors for successful builds, and upon detection of same, (re)scans the output of the build and alters its sense of available OpModes accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OnBotJavaManager.BuildStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.io.File	assetRoot
static java.io.File	buildCompleteFile
static java.io.File	buildDir the root of all outputs generated by the build system.
static java.io.File	buildLockDir
static java.io.File	buildLogFile
static java.io.File	buildRequestFile
protected ThreadPool.Singleton<java.lang.Void>	buildSingleton
static java.io.File	buildStartedFile
protected static OnBotJavaManager.BuildStatus	buildStatus
static java.io.File	classesOutputDir
static java.io.File	controlDir
protected FileModifyObserver	controlObserver
static java.io.File	currentOnBotJavaDirFile
protected OnBotJavaDiagnosticsListener	diagnosticListener
static java.lang.String[]	ftcClassPathLibs
static java.io.File	jarDir
static java.io.File	jarsOutputDir
static java.io.File	javaRoot
static java.io.File	libDir the directory into which libraries used by the source live
static java.lang.String	onBotJavaJarName
static java.lang.String[]	platformClassPathLibs
static java.io.File	sourceOutputDir
static java.io.File	srcDir the directory into which user .java should be placed (in appropriate reverse-domain subdirs for .java, as usual)
protected static java.lang.Object	startStopLock
static java.io.File	statusDir
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
OnBotJavaManager()

Method Summary

Modifier and Type	Method and Description
protected void	build() The creation or updating of the build request file in the control directory will cause us to initiate the whole cascade of processing
protected void	clean()
void	close()
protected boolean	compileJavaFiles()
protected void	consolidateClassFilesToJar(java.io.File onBotJavaDirDirectory)
protected void	copyInputJarFiles(java.io.File onBotJavaDirDirectory)
protected void	dexifyJarFile(java.io.File jarFile)
protected void	dexifyJarFiles(java.io.File onBotJavaDirDirectory)
protected void	ensureBuildDirs()
protected static void	ensureDirectories()
protected static void	ensureDirs(java.io.File file)
protected static void	extractAssets()
protected static void	extractJavaLibraryAsset(java.lang.String name)
protected static void	fullClean()
static OnBotJavaManager.BuildStatus	getBuildStatus()
protected static java.io.File	getCurrentOutputJarDir()
static java.util.List<java.io.File>	getOutputJarFiles()
static java.util.List<java.io.File>	getOutputJarFiles(java.io.File onBotJavaDirDirectory)
static void	initialize()
protected void	posttrace(java.lang.String message)
protected void	pretrace(java.lang.String message)
protected void	testBusy(java.lang.String message, java.lang.String phase)
protected void	trace(java.lang.String message, java.lang.Runnable runnable)
protected <T> T	trace(java.lang.String message, Supplier<T> supplier)
protected <VALUE,EXCEPTION_T extends java.io.IOException> VALUE	trace(java.lang.String message, ThrowingCallable<VALUE,EXCEPTION_T> callable)
protected void	writeBuildStatusFile(java.io.File file, java.lang.String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

javaRoot

public static final java.io.File javaRoot

libDir

public static final java.io.File libDir

the directory into which libraries used by the source live

srcDir

public static final java.io.File srcDir

the directory into which user .java should be placed (in appropriate reverse-domain subdirs for .java, as usual)

jarDir

public static final java.io.File jarDir

controlDir

public static final java.io.File controlDir

buildRequestFile

public static final java.io.File buildRequestFile

buildLockDir

public static final java.io.File buildLockDir

statusDir

public static final java.io.File statusDir

buildLogFile

public static final java.io.File buildLogFile

buildStartedFile

public static final java.io.File buildStartedFile

buildCompleteFile

public static final java.io.File buildCompleteFile

currentOnBotJavaDirFile

public static final java.io.File currentOnBotJavaDirFile

buildDir

public static final java.io.File buildDir

the root of all outputs generated by the build system.

sourceOutputDir

public static final java.io.File sourceOutputDir

classesOutputDir

public static final java.io.File classesOutputDir

jarsOutputDir

public static final java.io.File jarsOutputDir

onBotJavaJarName

public static final java.lang.String onBotJavaJarName

See Also:

Constant Field Values

assetRoot

public static final java.io.File assetRoot

platformClassPathLibs

public static final java.lang.String[] platformClassPathLibs

ftcClassPathLibs

public static final java.lang.String[] ftcClassPathLibs

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

startStopLock

protected static final java.lang.Object startStopLock

buildSingleton

protected final ThreadPool.Singleton<java.lang.Void> buildSingleton

controlObserver

protected FileModifyObserver controlObserver

diagnosticListener

protected OnBotJavaDiagnosticsListener diagnosticListener

buildStatus

protected static volatile OnBotJavaManager.BuildStatus buildStatus

Constructor Detail

OnBotJavaManager

public OnBotJavaManager()

Method Detail

initialize

public static void initialize()

ensureDirectories

protected static void ensureDirectories()

ensureBuildDirs

protected void ensureBuildDirs()

ensureDirs

protected static void ensureDirs(java.io.File file)

extractAssets

protected static void extractAssets()

extractJavaLibraryAsset

protected static void extractJavaLibraryAsset(java.lang.String name)

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

build

protected void build()

The creation or updating of the build request file in the control directory will cause us to initiate the whole cascade of processing

writeBuildStatusFile

protected void writeBuildStatusFile(java.io.File file,
                                    java.lang.String message)

clean

protected void clean()

fullClean

protected static void fullClean()

compileJavaFiles

protected boolean compileJavaFiles()

consolidateClassFilesToJar

protected void consolidateClassFilesToJar(java.io.File onBotJavaDirDirectory)
                                   throws java.io.IOException

Throws:

java.io.IOException

copyInputJarFiles

protected void copyInputJarFiles(java.io.File onBotJavaDirDirectory)
                          throws java.io.IOException

Throws:

java.io.IOException

dexifyJarFiles

protected void dexifyJarFiles(java.io.File onBotJavaDirDirectory)
                       throws java.io.IOException

Throws:

java.io.IOException

getOutputJarFiles

public static java.util.List<java.io.File> getOutputJarFiles()

getOutputJarFiles

public static java.util.List<java.io.File> getOutputJarFiles(java.io.File onBotJavaDirDirectory)

getCurrentOutputJarDir

protected static java.io.File getCurrentOutputJarDir()

getBuildStatus

public static OnBotJavaManager.BuildStatus getBuildStatus()

dexifyJarFile

protected void dexifyJarFile(java.io.File jarFile)
                      throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

trace

protected <VALUE,EXCEPTION_T extends java.io.IOException> VALUE trace(java.lang.String message,
                                                                      ThrowingCallable<VALUE,EXCEPTION_T> callable)
                                                               throws java.io.IOException

Throws:

java.io.IOException

trace

protected void trace(java.lang.String message,
                     java.lang.Runnable runnable)

trace

protected <T> T trace(java.lang.String message,
                      Supplier<T> supplier)

pretrace

protected void pretrace(java.lang.String message)

posttrace

protected void posttrace(java.lang.String message)

testBusy

protected void testBusy(java.lang.String message,
                        java.lang.String phase)