From: Ben Soares Date: Tue, 14 Jan 2020 20:11:29 +0000 (+0000) Subject: JAL-3438 Eclipse code style formatting using spotless plugin using util/eclipse/Jalvi... X-Git-Url: http://source.jalview.org/gitweb/?p=jalview.git;a=commitdiff_plain;h=refs%2Fheads%2Fimprovement%2FJAL-3438_eclipse_java_code_formatting_as_a_gradle_task JAL-3438 Eclipse code style formatting using spotless plugin using util/eclipse/JalviewCodeStyle.xml --- diff --git a/build.gradle b/build.gradle index e3c4675..e1d670a 100644 --- a/build.gradle +++ b/build.gradle @@ -1,15 +1,14 @@ import org.apache.tools.ant.filters.ReplaceTokens -//import org.apache.tools.ant.filters.ReplaceRegexp import org.gradle.internal.os.OperatingSystem -import org.gradle.plugins.ide.eclipse.model.* - +import org.gradle.plugins.ide.eclipse.model.Output +import org.gradle.plugins.ide.eclipse.model.Library +import java.security.MessageDigest import groovy.transform.ExternalizeMethods buildscript { dependencies { classpath 'org.openclover:clover:4.3.1' - classpath 'org.apache.commons:commons-compress:1.18' } } @@ -19,7 +18,8 @@ plugins { id 'eclipse' id 'com.github.johnrengelman.shadow' version '4.0.3' id 'com.install4j.gradle' version '7.0.9' - id 'com.diffplug.gradle.spotless' version '3.24.2' + id 'com.diffplug.gradle.spotless' version '3.27.1' + id 'com.dorongold.task-tree' version '1.4' // only needed to display task dependency tree with gradle task1 [task2 ...] taskTree } repositories { @@ -31,118 +31,196 @@ repositories { } } -mainClassName = launcherClass -def cloverInstrDir = file("$buildDir/$cloverSourcesInstrDir") -def classes = "$jalviewDir/$classesDir" - -if (clover.equals("true")) { - use_clover = true - classes = "$buildDir/$cloverClassesDir" -} else { - use_clover = false - classes = "$jalviewDir/$classesDir" +dependencies { + compile 'org.apache.commons:commons-compress:1.18' } -// configure classpath/args for j8/j11 compilation -def jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath() -def libDir -def libDistDir -def compile_source_compatibility -def compile_target_compatibility +// in ext the values are cast to Object. Ensure string values are cast as String (and not GStringImpl) for later use +def string(Object o) { + return o.toString() +} + ext { - getdownWebsiteDir = jalviewDir + '/' + getdown_website_dir + '/' + JAVA_VERSION - getdownDir = "" + jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath() + jalviewDirRelativePath = jalviewDir + + // local build environment properties + def localProps = "${jalviewDirAbsolutePath}/local.properties" + if (file(localProps).exists()) { + try { + def p = new Properties() + def localPropsFIS = new FileInputStream(localProps) + p.load(localPropsFIS) + localPropsFIS.close() + p.each { + key, val -> + def over = getProperty(key) != null + setProperty(key, val) + if (over) { + println("Overriding property '${key}' with local.properties value '${val}'") + } + } + } catch (Exception e) { + System.out.println("Exception reading local.properties") + } + } + + // this property set when running Eclipse headlessly + j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild") + // this property set by Eclipse + eclipseApplicationProperty = string("eclipse.application") + // CHECK IF RUNNING FROM WITHIN ECLIPSE + def eclipseApplicationPropertyVal = System.properties[eclipseApplicationProperty] + IN_ECLIPSE = eclipseApplicationPropertyVal != null && eclipseApplicationPropertyVal.startsWith("org.eclipse.ui.") + // BUT WITHOUT THE HEADLESS BUILD PROPERTY SET + if (System.properties[j2sHeadlessBuildProperty].equals("true")) { + println("Setting IN_ECLIPSE to ${IN_ECLIPSE} as System.properties['${j2sHeadlessBuildProperty}'] == '${System.properties[j2sHeadlessBuildProperty]}'") + IN_ECLIPSE = false + } + if (IN_ECLIPSE) { + println("WITHIN ECLIPSE IDE") + } else { + println("HEADLESS BUILD") + } + + J2S_ENABLED = (project.hasProperty('j2s.compiler.status') && project['j2s.compiler.status'] != null && project['j2s.compiler.status'] == "enable") + if (J2S_ENABLED) { + println("J2S ENABLED") + } + + /* *-/ + System.properties.sort { it.key }.each { + key, val -> println("SYSTEM PROPERTY ${key}='${val}'") + } + /-* *-/ + if (false && IN_ECLIPSE) { + jalviewDir = jalviewDirAbsolutePath + } + */ + + // essentials + bareSourceDir = string(source_dir) + sourceDir = string("${jalviewDir}/${bareSourceDir}") + resourceDir = string("${jalviewDir}/${resource_dir}") + bareTestSourceDir = string(test_source_dir) + testSourceDir = string("${jalviewDir}/${bareTestSourceDir}") + + // clover + cloverInstrDir = file("${buildDir}/${cloverSourcesInstrDir}") + classesDir = string("${jalviewDir}/${classes_dir}") + if (clover.equals("true")) { + use_clover = true + classesDir = string("${buildDir}/${cloverClassesDir}") + } else { + use_clover = false + classesDir = string("${jalviewDir}/${classes_dir}") + } + + classes = classesDir + + getdownWebsiteDir = string("${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}") + getdownDir = string("") reportRsyncCmd = false buildDist = true - buildProperties = buildPropertiesFile - getdownLauncher = jalviewDir + '/' + getdown_lib_dir + '/' + getdown_launcher + buildProperties = string("${resourceDir}/${build_properties_file}") + getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}") switch (CHANNEL) { case "BUILD": // TODO: get bamboo build artifact URL for getdown artifacts getdown_channel_base = bamboo_channelbase - getdown_channel_name = bamboo_planKey + '/'+JAVA_VERSION - getdown_app_base = bamboo_channelbase + '/'+ bamboo_planKey + bamboo_getdown_channel_suffix + '/'+JAVA_VERSION + getdown_channel_name = string("${bamboo_planKey}/${JAVA_VERSION}") + getdown_app_base = string("${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}") getdown_app_dir = getdown_app_dir_alt - buildProperties = jalviewDir + "/" + classesDir +"/" + buildPropertiesFile + buildProperties = string("${resourceDir}/${build_properties_file}") break case "RELEASE": getdown_channel_name = CHANNEL.toLowerCase() - getdownDir = getdown_channel_name + "/" + JAVA_VERSION - getdown_app_base = getdown_channel_base + "/" + getdownDir + getdownDir = string("${getdown_channel_name}/${JAVA_VERSION}") + getdown_app_base = string("${getdown_channel_base}/${getdownDir}") getdown_app_dir = getdown_app_dir_release - buildProperties = jalviewDir + "/" + classesDir +"/" + buildPropertiesFile + buildProperties = string("${resourceDir}/${build_properties_file}") reportRsyncCommand = true + // Don't ignore transpile errors for release build + if (jalviewjs_ignore_transpile_errors.equals("true")) { + jalviewjs_ignore_transpile_errors = "false" + println("Setting jalviewjs_ignore_transpile_errors to 'false'") + } break case "ARCHIVE": - getdown_channel_name = CHANNEL.toLowerCase()+"/"+JALVIEW_VERSION - getdownDir = getdown_channel_name + "/" + JAVA_VERSION - getdown_app_base = getdown_channel_base + "/" + getdownDir + getdown_channel_name = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}" + getdownDir = string("${getdown_channel_name}/${JAVA_VERSION}") + getdown_app_base = string("${getdown_channel_base}/${getdownDir}") getdown_app_dir = getdown_app_dir_alt - if (!file(ARCHIVEDIR+"/"+packageDir).exists()) { + if (!file("${ARCHIVEDIR}/${packageDir}").exists()) { print "Must provide an ARCHIVEDIR value to produce an archive distribution" exit } else { - packageDir = ARCHIVEDIR + "/" + packageDir - buildProperties = ARCHIVEDIR +"/" + classesDir + "/" + buildPropertiesFile + packageDir = string("${ARCHIVEDIR}/${packageDir}") + buildProperties = string("${ARCHIVEDIR}/${resource_dir}/${build_properties_file}") buildDist = false } reportRsyncCommand = true break case "ARCHIVELOCAL": - getdown_channel_name = "archive" + "/" + JALVIEW_VERSION - getdownDir = getdown_channel_name + "/" + JAVA_VERSION + getdown_channel_name = string("archive/${JALVIEW_VERSION}") + getdownDir = string("${getdown_channel_name}/${JAVA_VERSION}") getdown_app_base = file(getdownWebsiteDir).toURI().toString() getdown_app_dir = getdown_app_dir_alt - if (!file(ARCHIVEDIR+"/"+packageDir).exists()) { + if (!file("${ARCHIVEDIR}/${packageDir}").exists()) { print "Must provide an ARCHIVEDIR value to produce an archive distribution" exit } else { - packageDir = ARCHIVEDIR + "/" + packageDir - buildProperties = ARCHIVEDIR +"/" + classesDir + "/" + buildPropertiesFile + packageDir = string("${ARCHIVEDIR}/${packageDir}") + buildProperties = string("${ARCHIVEDIR}/${resource_dir}/${build_properties_file}") buildDist = false } reportRsyncCommand = true - getdownLauncher = jalviewDir + '/' + getdown_lib_dir + '/' + getdown_launcher_local + getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}") break case "DEVELOP": getdown_channel_name = CHANNEL.toLowerCase() - getdownDir = getdown_channel_name + "/" + JAVA_VERSION - getdown_app_base = getdown_channel_base + "/" + getdownDir + getdownDir = string("${getdown_channel_name}/${JAVA_VERSION}") + getdown_app_base = string("${getdown_channel_base}/${getdownDir}") getdown_app_dir = getdown_app_dir_alt - buildProperties = jalviewDir + "/" + classesDir +"/" + buildPropertiesFile + buildProperties = string("${resourceDir}/${build_properties_file}") reportRsyncCommand = true break case "TEST-RELEASE": getdown_channel_name = CHANNEL.toLowerCase() - getdownDir = getdown_channel_name + "/" + JAVA_VERSION - getdown_app_base = getdown_channel_base + "/" + getdownDir + getdownDir = string("${getdown_channel_name}/${JAVA_VERSION}") + getdown_app_base = string("${getdown_channel_base}/${getdownDir}") getdown_app_dir = getdown_app_dir_alt - buildProperties = jalviewDir + "/" + classesDir +"/" + buildPropertiesFile + buildProperties = string("${resourceDir}/${build_properties_file}") reportRsyncCommand = true + // Don't ignore transpile errors for release build + if (jalviewjs_ignore_transpile_errors.equals("true")) { + jalviewjs_ignore_transpile_errors = "false" + println("Setting jalviewjs_ignore_transpile_errors to 'false'") + } break case ~/^SCRATCH(|-[-\w]*)$/: getdown_channel_name = CHANNEL - getdownDir = getdown_channel_name + "/" + JAVA_VERSION - getdown_app_base = getdown_channel_base + "/" + getdownDir + getdownDir = string("${getdown_channel_name}/${JAVA_VERSION}") + getdown_app_base = string("${getdown_channel_base}/${getdownDir}") getdown_app_dir = getdown_app_dir_alt - buildProperties = jalviewDir + "/" + classesDir +"/" + buildPropertiesFile + buildProperties = string("${resourceDir}/${build_properties_file}") reportRsyncCommand = true break case "LOCAL": getdown_app_base = file(getdownWebsiteDir).toURI().toString() getdown_app_dir = getdown_app_dir_alt - buildProperties = jalviewDir + "/" + classesDir +"/" + buildPropertiesFile - getdownLauncher = jalviewDir + '/' + getdown_lib_dir + '/' + getdown_launcher_local + buildProperties = string("${resourceDir}/${build_properties_file}") + getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}") break default: // something wrong specified @@ -152,96 +230,136 @@ ext { } - println("Using a "+CHANNEL+" profile. appbase="+getdown_app_base) - getdownAppDir = getdownWebsiteDir + '/' + getdown_app_dir - //getdownJ11libDir = getdownWebsiteDir + '/' + getdown_j11lib_dir - getdownResourceDir = getdownWebsiteDir + '/' + getdown_resource_dir - getdownInstallDir = getdownWebsiteDir + '/' + getdown_install_dir - getdownFilesDir = jalviewDir + '/' + getdown_files_dir + '/' + JAVA_VERSION + '/' - getdownFilesInstallDir = getdownFilesDir+"/"+getdown_install_dir + getdownAppDir = string("${getdownWebsiteDir}/${getdown_app_dir}") + //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}" + getdownResourceDir = string("${getdownWebsiteDir}/${getdown_resource_dir}") + getdownInstallDir = string("${getdownWebsiteDir}/${getdown_install_dir}") + getdownFilesDir = string("${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/") + getdownFilesInstallDir = string("${getdownFilesDir}/${getdown_install_dir}") /* compile without modules -- using classpath libraries - modules_compileClasspath = fileTree(dir: "$jalviewDir/$j11modDir", include: ["*.jar"]) + modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"]) modules_runtimeClasspath = modules_compileClasspath */ - gitHash = "" - gitBranch = "" -} - -def JAVA_INTEGER_VERSION -def additional_compiler_args = [] -// these are getdown.txt properties defined dependent on the JAVA_VERSION -def getdown_alt_java_min_version -def getdown_alt_java_max_version -// this property is assigned below and expanded to multiple lines in the getdown task -def getdown_alt_multi_java_location -// this property is for the Java library used in eclipse -def eclipse_java_runtime_name -if (JAVA_VERSION.equals("1.8")) { - JAVA_INTEGER_VERSION = "8" - //libDir = j8libDir - libDir = j11libDir - libDistDir = j8libDir - compile_source_compatibility = 1.8 - compile_target_compatibility = 1.8 - getdown_alt_java_min_version = getdown_alt_java8_min_version - getdown_alt_java_max_version = getdown_alt_java8_max_version - getdown_alt_multi_java_location = getdown_alt_java8_txt_multi_java_location - eclipse_java_runtime_name = "JavaSE-1.8" -} else if (JAVA_VERSION.equals("11")) { - JAVA_INTEGER_VERSION = "11" - libDir = j11libDir - libDistDir = j11libDir - compile_source_compatibility = 11 - compile_target_compatibility = 11 - getdown_alt_java_min_version = getdown_alt_java11_min_version - getdown_alt_java_max_version = getdown_alt_java11_max_version - getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location - eclipse_java_runtime_name = "JavaSE-11" - /* compile without modules -- using classpath libraries - additional_compiler_args += [ - '--module-path', ext.modules_compileClasspath.asPath, - '--add-modules', j11modules - ] - */ -} else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) { - JAVA_INTEGER_VERSION = JAVA_VERSION - libDir = j11libDir - libDistDir = j11libDir - compile_source_compatibility = JAVA_VERSION - compile_target_compatibility = JAVA_VERSION - getdown_alt_java_min_version = getdown_alt_java11_min_version - getdown_alt_java_max_version = getdown_alt_java11_max_version - getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location - eclipse_java_runtime_name = "JavaSE-11" - /* compile without modules -- using classpath libraries - additional_compiler_args += [ - '--module-path', ext.modules_compileClasspath.asPath, - '--add-modules', j11modules - ] - */ -} else { - throw new GradleException("JAVA_VERSION=$JAVA_VERSION not currently supported by Jalview") + gitHash = string("") + gitBranch = string("") + + println("Using a ${CHANNEL} profile.") + + additional_compiler_args = [] + // configure classpath/args for j8/j11 compilation + if (JAVA_VERSION.equals("1.8")) { + JAVA_INTEGER_VERSION = string("8") + //libDir = j8libDir + libDir = j11libDir + libDistDir = j8libDir + compile_source_compatibility = 1.8 + compile_target_compatibility = 1.8 + // these are getdown.txt properties defined dependent on the JAVA_VERSION + getdown_alt_java_min_version = getdown_alt_java8_min_version + getdown_alt_java_max_version = getdown_alt_java8_max_version + // this property is assigned below and expanded to multiple lines in the getdown task + getdown_alt_multi_java_location = getdown_alt_java8_txt_multi_java_location + // this property is for the Java library used in eclipse + eclipse_java_runtime_name = string("JavaSE-1.8") + } else if (JAVA_VERSION.equals("11")) { + JAVA_INTEGER_VERSION = string("11") + libDir = j11libDir + libDistDir = j11libDir + compile_source_compatibility = 11 + compile_target_compatibility = 11 + getdown_alt_java_min_version = getdown_alt_java11_min_version + getdown_alt_java_max_version = getdown_alt_java11_max_version + getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location + eclipse_java_runtime_name = string("JavaSE-11") + /* compile without modules -- using classpath libraries + additional_compiler_args += [ + '--module-path', modules_compileClasspath.asPath, + '--add-modules', j11modules + ] + */ + } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) { + JAVA_INTEGER_VERSION = JAVA_VERSION + libDir = j11libDir + libDistDir = j11libDir + compile_source_compatibility = JAVA_VERSION + compile_target_compatibility = JAVA_VERSION + getdown_alt_java_min_version = getdown_alt_java11_min_version + getdown_alt_java_max_version = getdown_alt_java11_max_version + getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location + eclipse_java_runtime_name = string("JavaSE-11") + /* compile without modules -- using classpath libraries + additional_compiler_args += [ + '--module-path', modules_compileClasspath.asPath, + '--add-modules', j11modules + ] + */ + } else { + throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview") + } + + + // for install4j + macosJavaVMDir = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/getdown/macos-jre${JAVA_VERSION}/jre") + macosJavaVMTgz = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/install4j/tgz/macos-jre${JAVA_VERSION}.tar.gz") + windowsJavaVMDir = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/getdown/windows-jre${JAVA_VERSION}/jre") + windowsJavaVMTgz = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/install4j/tgz/windows-jre${JAVA_VERSION}.tar.gz") + install4jDir = string("${jalviewDir}/${install4jResourceDir}") + install4jConfFileName = string("jalview-installers-java${JAVA_VERSION}.install4j") + install4jConfFile = string("${install4jDir}/${install4jConfFileName}") + + + buildingHTML = string("${jalviewDir}/${docDir}/building.html") + helpFile = string("${classesDir}/${help_dir}/help.jhm") + helpParentDir = string("${jalviewDir}/${help_parent_dir}") + helpDir = string("${help_dir}") + helpSourceDir = string("${helpParentDir}/${helpDir}") + + + relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath()) + jalviewjsBuildDir = string("${relativeBuildDir}/jalviewjs") + jalviewjsSiteDir = string("${jalviewjsBuildDir}/${jalviewjs_site_dir}") + if (IN_ECLIPSE) { + jalviewjsTransferSiteJsDir = string(jalviewjsSiteDir) + } else { + jalviewjsTransferSiteJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_js") + } + jalviewjsTransferSiteLibDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_lib") + jalviewjsTransferSiteSwingJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_swingjs") + jalviewjsTransferSiteCoreDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_core") + jalviewjsJalviewCoreHtmlFile = string("") + jalviewjsJalviewCoreName = string(jalviewjs_core_name) + jalviewjsCoreClasslists = [] + jalviewjsJalviewTemplateName = string(jalviewjs_name) + jalviewjsJ2sSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_settings}") + jalviewjsJ2sProps = null + + eclipseWorkspace = null + eclipseBinary = string("") + eclipseVersion = string("") + eclipseDebug = false + // ENDEXT } -sourceSets { +sourceSets { main { java { - srcDirs "$jalviewDir/$sourceDir" - outputDir = file("$classes") + srcDirs sourceDir + outputDir = file(classesDir) } resources { - srcDirs "$jalviewDir/$resourceDir" + srcDirs resourceDir } - jar.destinationDir = file("$jalviewDir/$packageDir") + jar.destinationDir = file("${jalviewDir}/${packageDir}") compileClasspath = files(sourceSets.main.java.outputDir) - compileClasspath += fileTree(dir: "$jalviewDir/$libDir", include: ["*.jar"]) + compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"]) runtimeClasspath = compileClasspath } + clover { java { srcDirs = [ cloverInstrDir ] @@ -254,16 +372,16 @@ sourceSets { compileClasspath = configurations.cloverRuntime + files( sourceSets.clover.java.outputDir ) compileClasspath += files(sourceSets.main.java.outputDir) compileClasspath += sourceSets.main.compileClasspath - compileClasspath += fileTree(dir: "$jalviewDir/$utilsDir", include: ["**/*.jar"]) - compileClasspath += fileTree(dir: "$jalviewDir/$libDir", include: ["*.jar"]) + compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["**/*.jar"]) + compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"]) runtimeClasspath = compileClasspath } test { java { - srcDirs "$jalviewDir/$testSourceDir" - outputDir = file("$jalviewDir/$testOutputDir") + srcDirs testSourceDir + outputDir = file("${jalviewDir}/${testOutputDir}") } resources { @@ -278,13 +396,15 @@ sourceSets { compileClasspath += files(sourceSets.main.java.outputDir) } - compileClasspath += fileTree(dir: "$jalviewDir/$utilsDir", include: ["**/*.jar"]) - compileClasspath += fileTree(dir: "$jalviewDir/$libDir", include: ["*.jar"]) + compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"]) + compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testnglibs", include: ["**/*.jar"]) + compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testlibs", include: ["**/*.jar"]) runtimeClasspath = compileClasspath } } + // clover bits dependencies { if (use_clover) { @@ -293,6 +413,7 @@ dependencies { } } + configurations { cloverRuntime cloverRuntime.extendsFrom cloverCompile @@ -300,7 +421,7 @@ configurations { eclipse { project { - name = "Jalview with gradle build" + name = eclipse_project_name natures 'org.eclipse.jdt.core.javanature', 'org.eclipse.jdt.groovy.core.groovyNature', @@ -313,117 +434,92 @@ eclipse { classpath { //defaultOutputDir = sourceSets.main.java.outputDir def removeThese = [] - configurations.each{ if (it.isCanBeResolved()) { - removeThese += it + configurations.each{ + if (it.isCanBeResolved()) { + removeThese += it + } } - } - minusConfigurations += removeThese - plusConfigurations = [ ] - file { + minusConfigurations += removeThese + plusConfigurations = [ ] + file { - whenMerged { cp -> - def removeTheseToo = [] - HashMap addedSrcPath = new HashMap<>(); - cp.entries.each { entry -> - if (entry.kind == 'src') { - if (addedSrcPath.getAt(entry.path) || !(entry.path == "src" || entry.path == "test")) { - removeTheseToo += entry - } else { - addedSrcPath.putAt(entry.path, true) + whenMerged { cp -> + def removeTheseToo = [] + HashMap alreadyAddedSrcPath = new HashMap<>(); + cp.entries.each { entry -> + // This conditional removes all src classpathentries that a) have already been added or b) aren't "src" or "test". + // e.g. this removes the resources dir being copied into bin/main, bin/test AND bin/clover + // we add the resources and help/help dirs in as libs afterwards (see below) + if (entry.kind == 'src') { + if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == bareSourceDir || entry.path == bareTestSourceDir)) { + removeTheseToo += entry + } else { + alreadyAddedSrcPath.putAt(entry.path, true) + } } - } - } - cp.entries.removeAll(removeTheseToo) - - print ("CP="+cp.inspect()) - - cp.entries += new Output("bin/main") - cp.entries += new Library(fileReference(helpParentDir)) - cp.entries += new Library(fileReference(resourceDir)) - HashMap addedLibPath = new HashMap<>(); - - // changing from sourcesets.main.classpath to specific Java version lib - //sourceSets.main.compileClasspath.each{ - fileTree("$jalviewDir/$libDistDir").include("**/*.jar").include("*.jar").each { - //don't want to add outputDir as eclipse is using its own output dir in bin/main - if (it.isDirectory() || ! it.exists()) { - // don't add dirs to classpath - return - } - def itPath = it.toString() - if (itPath.startsWith(jalviewDirAbsolutePath+"/")) { - itPath = itPath.substring(jalviewDirAbsolutePath.length()+1) - } - if (addedLibPath.get(itPath)) { - //println("Not adding duplicate entry "+itPath) - } else { - //println("Adding entry "+itPath) - cp.entries += new Library(fileReference(itPath)) - addedLibPath.put(itPath, true) } - } + cp.entries.removeAll(removeTheseToo) - // changing from sourcesets.main.classpath to specific Java version lib - //sourceSets.test.compileClasspath.each{ - fileTree(dir: "$jalviewDir/$utilsDir", include: ["**/*.jar"]).each { - //if ((it.isDirectory() || ! it.exists()) && ! (it.equals(sourceSets.main.java.outputDir))) { - //no longer want to add outputDir as eclipse is using its own output dir in bin/main - if (it.isDirectory() || ! it.exists()) { - // don't add dirs to classpath - return false // groovy "break" in .each loop - } - def itPath = it.toString() - if (itPath.startsWith(jalviewDirAbsolutePath+"/")) { - itPath = itPath.substring(jalviewDirAbsolutePath.length()+1) - } - if (addedLibPath.get(itPath)) { - // don't duplicate - } else { - def lib = new Library(fileReference(itPath)) - // this doesn't work... yet. Adding test=true attribute using withXml below - //def attrs = new Node(null, 'attributes', ["test":"true"]) - //lib.appendNode(attrs) // - cp.entries += lib - addedLibPath.put(itPath, true) + cp.entries += new Output("${eclipse_bin_dir}/main") + if (file(helpSourceDir).isDirectory()) { + cp.entries += new Library(fileReference(helpSourceDir)) } + if (file(resourceDir).isDirectory()) { + cp.entries += new Library(fileReference(resourceDir)) } - } - // withXml changes ignored by buildship, these add the "test=true" attribute - withXml { - def node = it.asNode() + HashMap alreadyAddedLibPath = new HashMap<>(); - def srcTestAttributes - node.children().each{ cpe -> - def attributes = cpe.attributes() - if (attributes.get("kind") == "src" && attributes.get("path") == "test") { - srcTestAttributes = cpe.find { a -> a.name() == "attributes" } - return + sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.each { + //don't want to add outputDir as eclipse is using its own output dir in bin/main + if (it.isDirectory() || ! it.exists()) { + // don't add dirs to classpath, especially if they don't exist + return false // groovy "continue" in .any closure } - } - def addTestAttribute = true - srcTestAttributes.each{a -> - if (a.name() == "attribute" && a.attributes().getAt("name") == "test") { - addTestAttribute = false + def itPath = it.toString() + if (itPath.startsWith("${jalviewDirAbsolutePath}/")) { + // make relative path + itPath = itPath.substring(jalviewDirAbsolutePath.length()+1) + } + if (alreadyAddedLibPath.get(itPath)) { + //println("Not adding duplicate entry "+itPath) + } else { + //println("Adding entry "+itPath) + cp.entries += new Library(fileReference(itPath)) + alreadyAddedLibPath.put(itPath, true) } } - if (addTestAttribute) { - srcTestAttributes.append(new Node(null, "attribute", [name:"test", value:"true"])) - } - node.children().each{ cpe -> - def attributes = cpe.attributes() - if (attributes.get("kind") == "lib" && attributes.get("path").startsWith("utils/")) { - cpe.appendNode('attributes') - .appendNode('attribute', [name:"test", value:"true"]) + //fileTree(dir: "$jalviewDir/$utilsDir", include: ["test*/*.jar"]).each { + sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.any { + //no longer want to add outputDir as eclipse is using its own output dir in bin/main + if (it.isDirectory() || ! it.exists()) { + // don't add dirs to classpath + return false // groovy "continue" in .any closure + } + + def itPath = it.toString() + if (itPath.startsWith("${jalviewDirAbsolutePath}/")) { + itPath = itPath.substring(jalviewDirAbsolutePath.length()+1) + } + if (alreadyAddedLibPath.get(itPath)) { + // don't duplicate + } else { + def lib = new Library(fileReference(itPath)) + lib.entryAttributes["test"] = "true" + cp.entries += lib + alreadyAddedLibPath.put(itPath, true) } } - } // withXML + + } // whenMerged + } // file containers 'org.eclipse.buildship.core.gradleclasspathcontainer' + } // classpath jdt { @@ -432,10 +528,12 @@ eclipse { targetCompatibility = compile_target_compatibility javaRuntimeName = eclipse_java_runtime_name + // add in jalview project specific properties/preferences into eclipse core preferences + // and also the codestyle XML file file { withProperties { props -> def jalview_prefs = new Properties() - def ins = new FileInputStream(jalviewDirAbsolutePath+"/"+eclipse_extra_jdt_prefs_file) + def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}") jalview_prefs.load(ins) ins.close() jalview_prefs.forEach { t, v -> @@ -443,17 +541,39 @@ eclipse { props.putAt(t, v) } } + // codestyle file -- overrides previous formatter prefs + def csFile = file("${jalviewDirAbsolutePath}/${eclipse_codestyle_file}") + if (csFile.exists()) { + XmlParser parser = new XmlParser() + def profiles = parser.parse(csFile) + def profile = profiles.'profile'.find { p -> (p.'@kind' == "CodeFormatterProfile" && p.'@name' == "Jalview") } + if (profile != null) { + profile.'setting'.each { s -> + def id = s.'@id' + def value = s.'@value' + if (id != null && value != null) { + props.putAt(id, value) + } + } + } + } } } - } - //synchronizationTasks eclipseClasspath - //autoBuildTasks eclipseClasspath + } // jdt + + if (IN_ECLIPSE) { + // Don't want these to be activated if in headless build + synchronizationTasks "eclipseSynchronizationTask" + //autoBuildTasks "eclipseAutoBuildTask" + + } } + task cloverInstr() { // only instrument source, we build test classes as normal - inputs.files files (sourceSets.main.allJava) // , fileTree(dir:"$jalviewDir/$testSourceDir", include: ["**/*.java"])) + inputs.files files (sourceSets.main.allJava) // , fileTree(dir: testSourceDir, include: ["**/*.java"])) outputs.dir cloverInstrDir doFirst { @@ -490,7 +610,6 @@ task cloverReport { com.atlassian.clover.reporters.xml.XMLReporter.runReport(args) } } - // end clover bits compileJava { @@ -504,6 +623,7 @@ compileJava { } + compileTestJava { if (use_clover) { dependsOn compileCloverJava @@ -531,21 +651,29 @@ compileCloverJava { classpath += configurations.cloverRuntime } + clean { - delete sourceSets.main.java.outputDir + doFirst { + delete sourceSets.main.java.outputDir + } } + cleanTest { - delete sourceSets.test.java.outputDir - delete cloverInstrDir + doFirst { + delete sourceSets.test.java.outputDir + delete cloverInstrDir + } } + // format is a string like date.format("dd MMMM yyyy") def getDate(format) { def date = new Date() return date.format(format) } + task setGitVals { def hashStdOut = new ByteArrayOutputStream() exec { @@ -561,36 +689,49 @@ task setGitVals { ignoreExitValue true } - project.ext.gitHash = hashStdOut.toString().trim() - project.ext.gitBranch = branchStdOut.toString().trim() + gitHash = hashStdOut.toString().trim() + gitBranch = branchStdOut.toString().trim() outputs.upToDateWhen { false } } + task createBuildProperties(type: WriteProperties) { + group = "build" + description = "Create the ${buildProperties} file" dependsOn setGitVals - inputs.dir("$jalviewDir/$sourceDir") - inputs.dir("$classes") - inputs.dir("$jalviewDir/$resourceDir") + inputs.dir(sourceDir) + inputs.dir(resourceDir) + file(buildProperties).getParentFile().mkdirs() outputFile (buildProperties) // taking time specific comment out to allow better incremental builds comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss") //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd") property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy") property "VERSION", JALVIEW_VERSION - property "INSTALLATION", INSTALLATION+" git-commit:"+project.ext.gitHash+" ["+project.ext.gitBranch+"]" + property "INSTALLATION", INSTALLATION+" git-commit:"+gitHash+" ["+gitBranch+"]" outputs.file(outputFile) } -def buildingHTML = "$jalviewDir/$docDir/building.html" -task deleteBuildingHTML(type: Delete) { - delete buildingHTML + +clean { + doFirst { + delete buildProperties + } +} + + +task cleanBuildingHTML(type: Delete) { + doFirst { + delete buildingHTML + } } + task convertBuildingMD(type: Exec) { - dependsOn deleteBuildingHTML - def buildingMD = "$jalviewDir/$docDir/building.md" - def css = "$jalviewDir/$docDir/github.css" + dependsOn cleanBuildingHTML + def buildingMD = "${jalviewDir}/${docDir}/building.md" + def css = "${jalviewDir}/${docDir}/github.css" def pandoc = null pandoc_exec.split(",").each { @@ -610,7 +751,7 @@ task convertBuildingMD(type: Exec) { commandLine pandoc, '-s', '-o', buildingHTML, '--metadata', 'pagetitle="Building Jalview from Source"', '--toc', '-H', css, buildingMD } else { println("Cannot find pandoc. Skipping convert building.md to HTML") - throw new StopExecutionException() + throw new StopExecutionException("Cannot find pandoc. Skipping convert building.md to HTML") } } @@ -620,33 +761,44 @@ task convertBuildingMD(type: Exec) { inputs.file(css) outputs.file(buildingHTML) } + + clean { - delete buildingHTML + doFirst { + delete buildingHTML + } } + task syncDocs(type: Sync) { dependsOn convertBuildingMD - def syncDir = "$classes/$docDir" - from fileTree("$jalviewDir/$docDir") + def syncDir = "${classesDir}/${docDir}" + from fileTree("${jalviewDir}/${docDir}") into syncDir } -def helpFile = "$classes/$helpDir/help.jhm" task copyHelp(type: Copy) { - def inputDir = "$jalviewDir/$helpParentDir/$helpDir" - def outputDir = "$classes/$helpDir" + def inputDir = helpSourceDir + def outputDir = "${classesDir}/${helpDir}" from(inputDir) { exclude '**/*.gif' - exclude '**/*.jpg' - exclude '**/*.png' - filter(ReplaceTokens, beginToken: '$$', endToken: '$$', tokens: ['Version-Rel': JALVIEW_VERSION,'Year-Rel': getDate("yyyy")]) + exclude '**/*.jpg' + exclude '**/*.png' + filter(ReplaceTokens, + beginToken: '$$', + endToken: '$$', + tokens: [ + 'Version-Rel': JALVIEW_VERSION, + 'Year-Rel': getDate("yyyy") + ] + ) } from(inputDir) { include '**/*.gif' - include '**/*.jpg' - include '**/*.png' + include '**/*.jpg' + include '**/*.png' } into outputDir @@ -655,22 +807,25 @@ task copyHelp(type: Copy) { outputs.dir(outputDir) } + task syncLib(type: Sync) { - def syncDir = "$classes/$libDistDir" - from fileTree("$jalviewDir/$libDistDir") + def syncDir = "${classesDir}/${libDistDir}" + from fileTree("${jalviewDir}/${libDistDir}") into syncDir } + task syncResources(type: Sync) { - from "$jalviewDir/$resourceDir" + dependsOn createBuildProperties + from resourceDir include "**/*.*" - exclude "install4j" - into "$classes" + into "${classesDir}" preserve { include "**" } } + task prepare { dependsOn syncResources dependsOn syncDocs @@ -701,67 +856,79 @@ test { sourceCompatibility = compile_source_compatibility targetCompatibility = compile_target_compatibility jvmArgs += additional_compiler_args - print ("Setting target compatibility to "+targetCompatibility+"\n") + } + task buildIndices(type: JavaExec) { dependsOn copyHelp classpath = sourceSets.main.compileClasspath main = "com.sun.java.help.search.Indexer" - workingDir = "$classes/$helpDir" + workingDir = "${classesDir}/${helpDir}" def argDir = "html" args = [ argDir ] - inputs.dir("$workingDir/$argDir") - - outputs.dir("$classes/doc") - outputs.dir("$classes/help") - outputs.file("$workingDir/JavaHelpSearch/DOCS") - outputs.file("$workingDir/JavaHelpSearch/DOCS.TAB") - outputs.file("$workingDir/JavaHelpSearch/OFFSETS") - outputs.file("$workingDir/JavaHelpSearch/POSITIONS") - outputs.file("$workingDir/JavaHelpSearch/SCHEMA") - outputs.file("$workingDir/JavaHelpSearch/TMAP") + inputs.dir("${workingDir}/${argDir}") + + outputs.dir("${classesDir}/doc") + outputs.dir("${classesDir}/help") + outputs.file("${workingDir}/JavaHelpSearch/DOCS") + outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB") + outputs.file("${workingDir}/JavaHelpSearch/OFFSETS") + outputs.file("${workingDir}/JavaHelpSearch/POSITIONS") + outputs.file("${workingDir}/JavaHelpSearch/SCHEMA") + outputs.file("${workingDir}/JavaHelpSearch/TMAP") } + task compileLinkCheck(type: JavaCompile) { options.fork = true - classpath = files("$jalviewDir/$utilsDir") - destinationDir = file("$jalviewDir/$utilsDir") - source = fileTree(dir: "$jalviewDir/$utilsDir", include: ["HelpLinksChecker.java", "BufferedLineReader.java"]) - - inputs.file("$jalviewDir/$utilsDir/HelpLinksChecker.java") - inputs.file("$jalviewDir/$utilsDir/HelpLinksChecker.java") - outputs.file("$jalviewDir/$utilsDir/HelpLinksChecker.class") - outputs.file("$jalviewDir/$utilsDir/BufferedLineReader.class") + classpath = files("${jalviewDir}/${utilsDir}") + destinationDir = file("${jalviewDir}/${utilsDir}") + source = fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"]) + + inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java") + inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java") + outputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.class") + outputs.file("${jalviewDir}/${utilsDir}/BufferedLineReader.class") } -def helplinkscheckertouchfile = file("$jalviewDir/$utilsDir/HelpLinksChecker.touch") + task linkCheck(type: JavaExec) { dependsOn prepare, compileLinkCheck - classpath = files("$jalviewDir/$utilsDir") + + def helpLinksCheckerOutFile = file("${jalviewDir}/${utilsDir}/HelpLinksChecker.out") + classpath = files("${jalviewDir}/${utilsDir}") main = "HelpLinksChecker" workingDir = jalviewDir - def help = "$classes/$helpDir" - args = [ "$classes/$helpDir", "-nointernet" ] - - doLast { - helplinkscheckertouchfile.createNewFile() - } - - inputs.dir("$classes/$helpDir") - outputs.file(helplinkscheckertouchfile) + def help = "${classesDir}/${helpDir}" + args = [ "${classesDir}/${helpDir}", "-nointernet" ] + + def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append + def errFOS = outFOS + standardOutput = new org.apache.tools.ant.util.TeeOutputStream( + outFOS, + standardOutput) + errorOutput = new org.apache.tools.ant.util.TeeOutputStream( + outFOS, + errorOutput) + + inputs.dir("${classesDir}/${helpDir}") + outputs.file(helpLinksCheckerOutFile) } // import the pubhtmlhelp target -ant.properties.basedir = "$jalviewDir" -ant.properties.helpBuildDir = jalviewDirAbsolutePath+"/$classes/$helpDir" -ant.importBuild "$utilsDir/publishHelp.xml" +ant.properties.basedir = "${jalviewDir}" +ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes_dir}/${helpDir}" +ant.importBuild "${utilsDir}/publishHelp.xml" task cleanPackageDir(type: Delete) { - delete fileTree("$jalviewDir/$packageDir").include("*.jar") + doFirst { + delete fileTree(dir: "${jalviewDir}/${packageDir}", include: "*.jar") + } } + jar { dependsOn linkCheck dependsOn buildIndices @@ -774,7 +941,7 @@ jar { "Codebase": application_codebase } - destinationDir = file("$jalviewDir/$packageDir") + destinationDir = file("${jalviewDir}/${packageDir}") archiveName = rootProject.name+".jar" exclude "cache*/**" @@ -783,24 +950,27 @@ jar { exclude "**/*.jar" exclude "**/*.jar.*" - inputs.dir("$classes") - outputs.file("$jalviewDir/$packageDir/$archiveName") + inputs.dir(classesDir) + outputs.file("${jalviewDir}/${packageDir}/${archiveName}") } + task copyJars(type: Copy) { - from fileTree("$classes").include("**/*.jar").include("*.jar").files - into "$jalviewDir/$packageDir" + from fileTree(dir: classesDir, include: "**/*.jar").files + into "${jalviewDir}/${packageDir}" } + // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well task syncJars(type: Sync) { - from fileTree("$jalviewDir/$libDistDir").include("**/*.jar").include("*.jar").files - into "$jalviewDir/$packageDir" + from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files + into "${jalviewDir}/${packageDir}" preserve { include jar.archiveName } } + task makeDist { group = "build" description = "Put all required libraries in dist" @@ -810,9 +980,10 @@ task makeDist { dependsOn cleanPackageDir dependsOn syncJars dependsOn jar - outputs.dir("$jalviewDir/$packageDir") + outputs.dir("${jalviewDir}/${packageDir}") } + task cleanDist { dependsOn cleanPackageDir dependsOn cleanTest @@ -824,7 +995,7 @@ shadowJar { if (buildDist) { dependsOn makeDist } - from ("$jalviewDir/$libDistDir") { + from ("${jalviewDir}/${libDistDir}") { include("*.jar") } manifest { @@ -836,6 +1007,7 @@ shadowJar { minimize() } + task getdownWebsite() { group = "distribution" description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer" @@ -843,33 +1015,33 @@ task getdownWebsite() { dependsOn makeDist } - // clean the getdown website and files dir before creating getdown folders - delete project.ext.getdownWebsiteDir - delete project.ext.getdownFilesDir - def getdownWebsiteResourceFilenames = [] def getdownTextString = "" - def getdownResourceDir = project.ext.getdownResourceDir - def getdownAppDir = project.ext.getdownAppDir + def getdownResourceDir = getdownResourceDir + def getdownAppDir = getdownAppDir def getdownResourceFilenames = [] doFirst { + // clean the getdown website and files dir before creating getdown folders + delete getdownWebsiteDir + delete getdownFilesDir + copy { from buildProperties - rename(buildPropertiesFile, getdown_build_properties) - into project.ext.getdownAppDir + rename(build_properties_file, getdown_build_properties) + into getdownAppDir } - getdownWebsiteResourceFilenames += getdown_app_dir+"/"+getdown_build_properties + getdownWebsiteResourceFilenames += "${getdown_app_dir}/${getdown_build_properties}" // go through properties looking for getdown_txt_... def props = project.properties.sort { it.key } - if (getdown_alt_java_min_version.length() > 0) { - props.put("getdown_txt_java_min_version", getdown_alt_java_min_version) - } - if (getdown_alt_java_max_version.length() > 0) { - props.put("getdown_txt_java_max_version", getdown_alt_java_max_version) - } - props.put("getdown_txt_multi_java_location", getdown_alt_multi_java_location) + if (getdown_alt_java_min_version.length() > 0) { + props.put("getdown_txt_java_min_version", getdown_alt_java_min_version) + } + if (getdown_alt_java_max_version.length() > 0) { + props.put("getdown_txt_java_max_version", getdown_alt_java_max_version) + } + props.put("getdown_txt_multi_java_location", getdown_alt_multi_java_location) props.put("getdown_txt_appbase", getdown_app_base) props.each{ prop, val -> @@ -877,7 +1049,7 @@ task getdownWebsite() { if (prop.startsWith("getdown_txt_multi_")) { def key = prop.substring(18) val.split(",").each{ v -> - def line = key + " = " + v + "\n" + def line = "${key} = ${v}\n" getdownTextString += line } } else { @@ -889,16 +1061,16 @@ task getdownWebsite() { r = file(val) } else if (val.indexOf('/') > 0) { // relative path (relative to jalviewDir) - r = file( jalviewDir + '/' + val ) + r = file( "${jalviewDir}/${val}" ) } if (r.exists()) { - val = getdown_resource_dir + '/' + r.getName() + val = "${getdown_resource_dir}/" + r.getName() getdownWebsiteResourceFilenames += val getdownResourceFilenames += r.getPath() } } if (! prop.startsWith("getdown_txt_resource")) { - def line = prop.substring(12) + " = " + val + "\n" + def line = prop.substring(12) + " = ${val}\n" getdownTextString += line } } @@ -906,12 +1078,12 @@ task getdownWebsite() { } getdownWebsiteResourceFilenames.each{ filename -> - getdownTextString += "resource = "+filename+"\n" + getdownTextString += "resource = ${filename}\n" } getdownResourceFilenames.each{ filename -> copy { from filename - into project.ext.getdownResourceDir + into getdownResourceDir } } @@ -925,24 +1097,26 @@ task getdownWebsite() { } } codeFiles.sort().each{f -> - def line = "code = " + getdown_app_dir + '/' + f.getName() + "\n" + def name = f.getName() + def line = "code = ${getdown_app_dir}/${name}\n" getdownTextString += line copy { from f.getPath() - into project.ext.getdownAppDir + into getdownAppDir } } // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist /* if (JAVA_VERSION.equals("11")) { - def j11libFiles = fileTree(dir: "$jalviewDir/$j11libDir", include: ["*.jar"]).getFiles() + def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles() j11libFiles.sort().each{f -> - def line = "code = " + getdown_j11lib_dir + '/' + f.getName() + "\n" + def name = f.getName() + def line = "code = ${getdown_j11lib_dir}/${name}\n" getdownTextString += line copy { from f.getPath() - into project.ext.getdownJ11libDir + into getdownJ11libDir } } } @@ -950,19 +1124,19 @@ task getdownWebsite() { // getdown-launcher.jar should not be in main application class path so the main application can move it when updated. Listed as a resource so it gets updated. //getdownTextString += "class = " + file(getdownLauncher).getName() + "\n" - getdownTextString += "resource = " + getdown_launcher_new + "\n" - getdownTextString += "class = " + mainClass + "\n" + getdownTextString += "resource = ${getdown_launcher_new}\n" + getdownTextString += "class = ${mainClass}\n" - def getdown_txt = file(project.ext.getdownWebsiteDir + "/getdown.txt") + def getdown_txt = file("${getdownWebsiteDir}/getdown.txt") getdown_txt.write(getdownTextString) - def launch_jvl = file(project.ext.getdownWebsiteDir + "/" + getdown_launch_jvl) + def launch_jvl = file("${getdownWebsiteDir}/${getdown_launch_jvl}") launch_jvl.write("appbase="+props.get("getdown_txt_appbase")) copy { from getdownLauncher rename(file(getdownLauncher).getName(), getdown_launcher_new) - into project.ext.getdownWebsiteDir + into getdownWebsiteDir } copy { @@ -970,14 +1144,14 @@ task getdownWebsite() { if (file(getdownLauncher).getName() != getdown_launcher) { rename(file(getdownLauncher).getName(), getdown_launcher) } - into project.ext.getdownWebsiteDir + into getdownWebsiteDir } if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) { copy { from getdown_txt from getdownLauncher - from getdownWebsiteDir+"/"+getdown_build_properties + from "${getdownWebsiteDir}/${getdown_build_properties}" if (file(getdownLauncher).getName() != getdown_launcher) { rename(file(getdownLauncher).getName(), getdown_launcher) } @@ -994,7 +1168,7 @@ task getdownWebsite() { from getdown_txt from launch_jvl from getdownLauncher - from getdownWebsiteDir+"/"+getdown_build_properties + from "${getdownWebsiteDir}/${getdown_build_properties}" if (file(getdownLauncher).getName() != getdown_launcher) { rename(file(getdownLauncher).getName(), getdown_launcher) } @@ -1002,39 +1176,41 @@ task getdownWebsite() { } copy { - from getdownResourceDir - into project.ext.getdownFilesDir + '/' + getdown_resource_dir + from getdownResourceDir + into "${getdownFilesDir}/${getdown_resource_dir}" } } if (buildDist) { - inputs.dir(jalviewDir + '/' + packageDir) + inputs.dir("${jalviewDir}/${packageDir}") } - outputs.dir(project.ext.getdownWebsiteDir) - outputs.dir(project.ext.getdownFilesDir) + outputs.dir(getdownWebsiteDir) + outputs.dir(getdownFilesDir) } + task getdownDigest(type: JavaExec) { group = "distribution" description = "Digest the getdown website folder" dependsOn getdownWebsite doFirst { - classpath = files(getdownWebsiteDir + '/' + getdown_launcher) + classpath = files("${getdownWebsiteDir}/${getdown_launcher}") } main = "com.threerings.getdown.tools.Digester" - args project.ext.getdownWebsiteDir - inputs.dir(project.ext.getdownWebsiteDir) - outputs.file(project.ext.getdownWebsiteDir + '/' + "digest2.txt") + args getdownWebsiteDir + inputs.dir(getdownWebsiteDir) + outputs.file("${getdownWebsiteDir}/digest2.txt") } + task getdown() { group = "distribution" description = "Create the minimal and full getdown app folder for installers and website and create digest file" dependsOn getdownDigest doLast { if (reportRsyncCommand) { - def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith("/")?"":"/") - def toDir = getdown_rsync_dest + "/" + getdownDir + (getdownDir.endsWith("/")?"":"/") + def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith('/')?'':'/') + def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/') println "LIKELY RSYNC COMMAND:" println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'" if (RUNRSYNC == "true") { @@ -1049,11 +1225,15 @@ task getdown() { } } + clean { - delete project.ext.getdownWebsiteDir - delete project.ext.getdownFilesDir + doFirst { + delete getdownWebsiteDir + delete getdownFilesDir + } } + install4j { def install4jHomeDir = "/opt/install4j" def hostname = "hostname".execute().text.trim() @@ -1074,59 +1254,67 @@ install4j { } } -def install4jConf -def macosJavaVMDir -def macosJavaVMTgz -def windowsJavaVMDir -def windowsJavaVMTgz -def install4jDir = "$jalviewDir/$install4jResourceDir" -def install4jConfFile = "jalview-installers-java"+JAVA_VERSION+".install4j" -install4jConf = "$install4jDir/$install4jConfFile" task copyInstall4jTemplate(type: Copy) { - macosJavaVMDir = System.env.HOME+"/buildtools/jre/openjdk-java_vm/getdown/macos-jre"+JAVA_VERSION+"/jre" - macosJavaVMTgz = System.env.HOME+"/buildtools/jre/openjdk-java_vm/install4j/tgz/macos-jre"+JAVA_VERSION+".tar.gz" - windowsJavaVMDir = System.env.HOME+"/buildtools/jre/openjdk-java_vm/getdown/windows-jre"+JAVA_VERSION+"/jre" - windowsJavaVMTgz = System.env.HOME+"/buildtools/jre/openjdk-java_vm/install4j/tgz/windows-jre"+JAVA_VERSION+".tar.gz" from (install4jDir) { include install4jTemplate - rename (install4jTemplate, install4jConfFile) - filter(ReplaceTokens, beginToken: '', endToken: '', tokens: ['9999999999': JAVA_VERSION]) - filter(ReplaceTokens, beginToken: '$$', endToken: '$$', - tokens: [ - 'JAVA_VERSION': JAVA_VERSION, - 'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION, - 'VERSION': JALVIEW_VERSION, - 'MACOS_JAVA_VM_DIR': macosJavaVMDir, - 'MACOS_JAVA_VM_TGZ': macosJavaVMTgz, - 'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir, - 'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz, - 'INSTALL4JINFOPLISTFILEASSOCIATIONS': install4jInfoPlistFileAssociations, - 'COPYRIGHT_MESSAGE': install4jCopyrightMessage, - 'MACOS_BUNDLE_ID': install4jMacOSBundleId, - 'GETDOWN_RESOURCE_DIR': getdown_resource_dir, - 'GETDOWN_DIST_DIR': getdown_app_dir, - 'GETDOWN_ALT_DIR': getdown_app_dir_alt, - 'GETDOWN_INSTALL_DIR': getdown_install_dir - ] + rename (install4jTemplate, install4jConfFileName) + filter(ReplaceTokens, + beginToken: '', + endToken: '', + tokens: [ + '9999999999': JAVA_VERSION + ] + ) + filter(ReplaceTokens, + beginToken: '$$', + endToken: '$$', + tokens: [ + 'JAVA_VERSION': JAVA_VERSION, + 'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION, + 'VERSION': JALVIEW_VERSION, + 'MACOS_JAVA_VM_DIR': macosJavaVMDir, + 'MACOS_JAVA_VM_TGZ': macosJavaVMTgz, + 'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir, + 'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz, + 'INSTALL4JINFOPLISTFILEASSOCIATIONS': install4jInfoPlistFileAssociations, + 'COPYRIGHT_MESSAGE': install4jCopyrightMessage, + 'MACOS_BUNDLE_ID': install4jMacOSBundleId, + 'GETDOWN_RESOURCE_DIR': getdown_resource_dir, + 'GETDOWN_DIST_DIR': getdown_app_dir, + 'GETDOWN_ALT_DIR': getdown_app_dir_alt, + 'GETDOWN_INSTALL_DIR': getdown_install_dir + ] ) - if (OSX_KEYPASS=="") { - filter(ReplaceTokens, beginToken: 'codeSigning macEnabled="', endToken: '"', tokens: ['true':'codeSigning macEnabled="false"']) - filter(ReplaceTokens, beginToken: 'runPostProcessor="true" ',endToken: 'Processor', tokens: ['post':'runPostProcessor="false" postProcessor']) + if (OSX_KEYPASS == "") { + filter(ReplaceTokens, + beginToken: 'codeSigning macEnabled="', + endToken: '"', + tokens: [ + 'true': 'codeSigning macEnabled="false"' + ] + ) + filter(ReplaceTokens, + beginToken: 'runPostProcessor="true" ', + endToken: 'Processor', + tokens: [ + 'post': 'runPostProcessor="false" postProcessor' + ] + ) } } into install4jDir - outputs.files(install4jConf) + outputs.files(install4jConfFile) doLast { // include file associations in installer - def installerFileAssociationsXml = file("$install4jDir/$install4jInstallerFileAssociations").text + def installerFileAssociationsXml = file("${install4jDir}/${install4jInstallerFileAssociations}").text ant.replaceregexp( byline: false, flags: "s", match: '', replace: installerFileAssociationsXml, - file: install4jConf + file: install4jConfFile ) /* // include uninstaller applescript app files in dmg @@ -1136,53 +1324,62 @@ task copyInstall4jTemplate(type: Copy) { flags: "s", match: '', replace: installerDMGUninstallerXml, - file: install4jConf + file: install4jConfFile ) */ } } + +clean { + doFirst { + delete install4jConfFile + } +} + + task installers(type: com.install4j.gradle.Install4jTask) { group = "distribution" description = "Create the install4j installers" dependsOn getdown dependsOn copyInstall4jTemplate - projectFile = file(install4jConf) - println("Using projectFile "+projectFile) + projectFile = file(install4jConfFile) variables = [majorVersion: version.substring(2, 11), build: 001, OSX_KEYSTORE: OSX_KEYSTORE, JSIGN_SH: JSIGN_SH] - destination = "$jalviewDir/$install4jBuildDir/$JAVA_VERSION" + destination = "${jalviewDir}/${install4jBuildDir}/${JAVA_VERSION}" buildSelected = true if (OSX_KEYPASS) { macKeystorePassword=OSX_KEYPASS + } + doFirst { + println("Using projectFile "+projectFile) } - inputs.dir(project.ext.getdownWebsiteDir) - inputs.file(install4jConf) + inputs.dir(getdownWebsiteDir) + inputs.file(install4jConfFile) inputs.dir(macosJavaVMDir) inputs.dir(windowsJavaVMDir) - outputs.dir("$jalviewDir/$install4jBuildDir/$JAVA_VERSION") - + outputs.dir("${jalviewDir}/${install4jBuildDir}/${JAVA_VERSION}") } -clean { - delete install4jConf -} spotless { java { + licenseHeaderFile "${jalviewDir}/${source_license_file}" removeUnusedImports() - importOrder 'jalview', 'java', 'javax', 'org', 'com' - eclipse(spotless_eclipse_version).configFile eclipse_jdt_prefs_file + importOrder 'jalview', 'java', 'javax', 'org', 'com', 'sun', '' + eclipse().configFile "${jalviewDir}/${eclipse_codestyle_file}" } } task sourceDist (type: Tar) { + group 'Distribution' + description 'Creates a source files compressed tar file' dependsOn 'spotlessApply' def VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_") - def outputFileName = project.name + "_" + VERSION_UNDERSCORES + ".tar.gz" + def outputFileName = "${project.name}_${VERSION_UNDERSCORES}.tar.gz" // cater for buildship < 3.1 [3.0.1 is max version in eclipse 2018-09] try { archiveFileName = outputFileName @@ -1199,7 +1396,7 @@ task sourceDist (type: Tar) { ,"benchmarking/*" ,"**/.*" ,"*.class" - ,"**/*.class","$j11modDir/**/*.jar","appletlib","**/*locales" + ,"**/*.class","${j11modDir}/**/*.jar","appletlib","**/*locales" ,"*locales/**", ,"utils/InstallAnywhere"] def PROCESS_FILES=[ "AUTHORS", @@ -1225,39 +1422,1055 @@ task sourceDist (type: Tar) { from(jalviewDir) { exclude (EXCLUDE_FILES) include (PROCESS_FILES) - filter(ReplaceTokens, beginToken: '$$', endToken: '$$', tokens: ['Version-Rel': JALVIEW_VERSION,'Year-Rel': getDate("yyyy")]) + filter(ReplaceTokens, + beginToken: '$$', + endToken: '$$', + tokens: [ + 'Version-Rel': JALVIEW_VERSION, + 'Year-Rel': getDate("yyyy") + ] + ) } from(jalviewDir) { exclude (EXCLUDE_FILES) exclude (PROCESS_FILES) - exclude ("appletlib") - exclude ("**/*locales") - exclude ("*locales/**") - exclude ("utils/InstallAnywhere") + exclude ("appletlib") + exclude ("**/*locales") + exclude ("*locales/**") + exclude ("utils/InstallAnywhere") exclude (getdown_files_dir) - exclude (getdown_website_dir) + exclude (getdown_website_dir) - // exluding these as not using jars as modules yet - exclude ("$j11modDir/**/*.jar") -} -// from (jalviewDir) { -// // explicit includes for stuff that seemed to not get included -// include(fileTree("test/**/*.")) -// exclude(EXCLUDE_FILES) -// exclude(PROCESS_FILES) -// } + // exluding these as not using jars as modules yet + exclude ("${j11modDir}/**/*.jar") + } + // from (jalviewDir) { + // // explicit includes for stuff that seemed to not get included + // include(fileTree("test/**/*.")) + // exclude(EXCLUDE_FILES) + // exclude(PROCESS_FILES) + // } } + task helppages { dependsOn copyHelp dependsOn pubhtmlhelp - inputs.dir("$classes/$helpDir") - outputs.dir("$helpOutputDir") + inputs.dir("${classesDir}/${helpDir}") + outputs.dir("${buildDir}/distributions/${helpDir}") +} + + +task j2sSetHeadlessBuild { + doFirst { + IN_ECLIPSE = false + } +} + + +task jalviewjsSetEclipseWorkspace { + def propKey = "jalviewjs_eclipse_workspace" + def propVal = null + if (project.hasProperty(propKey)) { + propVal = project.getProperty(propKey) + if (propVal.startsWith("~/")) { + propVal = System.getProperty("user.home") + propVal.substring(1) + } + } + def propsFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_workspace_location_file}" + def propsFile = file(propsFileName) + def eclipseWsDir = propVal + def props = new Properties() + + def writeProps = true + if (( eclipseWsDir == null || !file(eclipseWsDir).exists() ) && propsFile.exists()) { + def ins = new FileInputStream(propsFileName) + props.load(ins) + ins.close() + if (props.getProperty(propKey, null) != null) { + eclipseWsDir = props.getProperty(propKey) + writeProps = false + } + } + + if (eclipseWsDir == null || !file(eclipseWsDir).exists()) { + def tempDir = File.createTempDir() + eclipseWsDir = tempDir.getAbsolutePath() + writeProps = true + } + eclipseWorkspace = file(eclipseWsDir) + + doFirst { + // do not run a headless transpile when we claim to be in Eclipse + if (IN_ECLIPSE) { + println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'") + } else { + println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + } + + if (writeProps) { + props.setProperty(propKey, eclipseWsDir) + propsFile.parentFile.mkdirs() + def bytes = new ByteArrayOutputStream() + props.store(bytes, null) + def propertiesString = bytes.toString() + propsFile.text = propertiesString + print("NEW ") + } else { + print("EXISTING ") + } + + println("ECLIPSE WORKSPACE: "+eclipseWorkspace.getPath()) + } + + //inputs.property(propKey, eclipseWsDir) // eclipseWsDir only gets set once this task runs, so will be out-of-date + outputs.file(propsFileName) + outputs.upToDateWhen { eclipseWorkspace.exists() && propsFile.exists() } +} + + +task jalviewjsEclipsePaths { + def eclipseProduct + + def eclipseRoot = jalviewjs_eclipse_root + if (eclipseRoot.startsWith("~/")) { + eclipseRoot = System.getProperty("user.home") + eclipseRoot.substring(1) + } + if (OperatingSystem.current().isMacOsX()) { + eclipseRoot += "/Eclipse.app" + eclipseBinary = "${eclipseRoot}/Contents/MacOS/eclipse" + eclipseProduct = "${eclipseRoot}/Contents/Eclipse/.eclipseproduct" + } else if (OperatingSystem.current().isWindows()) { // check these paths!! + if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) { + eclipseRoot += "/eclipse.exe" + } + eclipseBinary = "${eclipseRoot}/eclipse" + eclipseProduct = "${eclipseRoot}/.eclipseproduct" + } else { // linux or unix + if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) { + eclipseRoot += "/eclipse" + } + eclipseBinary = "${eclipseRoot}/eclipse" + eclipseProduct = "${eclipseRoot}/.eclipseproduct" + } + + eclipseVersion = "4.13" // default + def assumedVersion = true + if (file(eclipseProduct).exists()) { + def fis = new FileInputStream(eclipseProduct) + def props = new Properties() + props.load(fis) + eclipseVersion = props.getProperty("version") + fis.close() + assumedVersion = false + } + + def propKey = "eclipse_debug" + eclipseDebug = (project.hasProperty(propKey) && project.getProperty(propKey).equals("true")) + + doFirst { + // do not run a headless transpile when we claim to be in Eclipse + if (IN_ECLIPSE) { + println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'") + } else { + println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + } + + if (!assumedVersion) { + println("ECLIPSE VERSION=${eclipseVersion}") + } + } +} + + +task eclipseSetup { + dependsOn eclipseProject + dependsOn eclipseClasspath + dependsOn eclipseJdt +} + + +// this version (type: Copy) will delete anything in the eclipse dropins folder that isn't in fromDropinsDir +task jalviewjsEclipseCopyDropins(type: Copy) { + dependsOn jalviewjsEclipsePaths + + def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_eclipse_dropins_dir}", include: "*.jar") + inputFiles += file("${jalviewDir}/${jalviewjs_j2s_plugin}") + def outputDir = "${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" + + from inputFiles + into outputDir +} + + +// this eclipse -clean doesn't actually work +task jalviewjsCleanEclipse(type: Exec) { + dependsOn eclipseSetup + dependsOn jalviewjsEclipsePaths + dependsOn jalviewjsEclipseCopyDropins + + executable(eclipseBinary) + args(["-nosplash", "--launcher.suppressErrors", "-data", eclipseWorkspace.getPath(), "-clean", "-console", "-consoleLog"]) + if (eclipseDebug) { + args += "-debug" + } + args += "-l" + + def inputString = """exit +y +""" + def inputByteStream = new ByteArrayInputStream(inputString.getBytes()) + standardInput = inputByteStream +} + +/* not really working yet +jalviewjsEclipseCopyDropins.finalizedBy jalviewjsCleanEclipse +*/ + + +task jalviewjsTransferUnzipSwingJs { + def file_zip = "${jalviewDir}/${jalviewjs_swingjs_zip}" + + doLast { + copy { + from zipTree(file_zip) + into "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}" + } + } + + inputs.file file_zip + outputs.dir "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}" +} + + +task jalviewjsTransferUnzipLib { + def zipFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_libjs_dir}", include: "*.zip") + + doLast { + zipFiles.each { file_zip -> + copy { + from zipTree(file_zip) + into "${jalviewDir}/${jalviewjsTransferSiteLibDir}" + } + } + } + + inputs.files zipFiles + outputs.dir "${jalviewDir}/${jalviewjsTransferSiteLibDir}" +} + + +task jalviewjsTransferUnzipAllLibs { + dependsOn jalviewjsTransferUnzipSwingJs + dependsOn jalviewjsTransferUnzipLib +} + + +task jalviewjsCreateJ2sSettings(type: WriteProperties) { + group "JalviewJS" + description "Create the .j2s file from the j2s.* properties" + + jalviewjsJ2sProps = project.properties.findAll { it.key.startsWith("j2s.") }.sort { it.key } + def siteDirProperty = "j2s.site.directory" + def setSiteDir = false + jalviewjsJ2sProps.each { prop, val -> + if (val != null) { + if (prop == siteDirProperty) { + if (!(val.startsWith('/') || val.startsWith("file://") )) { + val = "${jalviewDir}/${jalviewjsTransferSiteJsDir}/${val}" + } + setSiteDir = true + } + property(prop,val) + } + if (!setSiteDir) { // default site location, don't override specifically set property + property(siteDirProperty,"${jalviewDirRelativePath}/${jalviewjsTransferSiteJsDir}") + } + } + outputFile = jalviewjsJ2sSettingsFileName + + if (! IN_ECLIPSE) { + inputs.properties(jalviewjsJ2sProps) + outputs.file(jalviewjsJ2sSettingsFileName) + } +} + + +task jalviewjsEclipseSetup { + dependsOn jalviewjsEclipseCopyDropins + dependsOn jalviewjsSetEclipseWorkspace + dependsOn jalviewjsCreateJ2sSettings +} + + +task jalviewjsSyncAllLibs (type: Sync) { + dependsOn jalviewjsTransferUnzipAllLibs + def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteLibDir}") + inputFiles += fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}") + def outputDir = "${jalviewDir}/${jalviewjsSiteDir}" + + from inputFiles + into outputDir + def outputFiles = [] + rename { filename -> + outputFiles += "${outputDir}/${filename}" + null + } + preserve { + include "**" + } + outputs.files outputFiles + inputs.files inputFiles +} + + +task jalviewjsSyncResources (type: Sync) { + def inputFiles = fileTree(dir: resourceDir) + def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}" + + from inputFiles + into outputDir + def outputFiles = [] + rename { filename -> + outputFiles += "${outputDir}/${filename}" + null + } + preserve { + include "**" + } + outputs.files outputFiles + inputs.files inputFiles +} + + +task jalviewjsSyncSiteResources (type: Sync) { + def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_site_resource_dir}") + def outputDir = "${jalviewDir}/${jalviewjsSiteDir}" + + from inputFiles + into outputDir + def outputFiles = [] + rename { filename -> + outputFiles += "${outputDir}/${filename}" + null + } + preserve { + include "**" + } + outputs.files outputFiles + inputs.files inputFiles +} + + +task jalviewjsSyncBuildProperties (type: Sync) { + dependsOn createBuildProperties + def inputFiles = [file(buildProperties)] + def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}" + + from inputFiles + into outputDir + def outputFiles = [] + rename { filename -> + outputFiles += "${outputDir}/${filename}" + null + } + preserve { + include "**" + } + outputs.files outputFiles + inputs.files inputFiles +} + + +task jalviewjsProjectImport(type: Exec) { + dependsOn eclipseSetup + dependsOn jalviewjsEclipsePaths + dependsOn jalviewjsEclipseSetup + + doFirst { + // do not run a headless import when we claim to be in Eclipse + if (IN_ECLIPSE) { + println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + throw new StopExecutionException("Not running headless import whilst IN_ECLIPSE is '${IN_ECLIPSE}'") + } else { + println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + } + } + + //def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview/org.eclipse.jdt.core" + def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview" + executable(eclipseBinary) + args(["-nosplash", "--launcher.suppressErrors", "-application", "com.seeq.eclipse.importprojects.headlessimport", "-data", eclipseWorkspace.getPath(), "-import", jalviewDirAbsolutePath]) + if (eclipseDebug) { + args += "-debug" + } + args += [ "--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" ] + if (!IN_ECLIPSE) { + args += [ "-D${j2sHeadlessBuildProperty}=true" ] + } + + inputs.file("${jalviewDir}/.project") + outputs.upToDateWhen { + file(projdir).exists() + } +} + + +task jalviewjsTranspile(type: Exec) { + dependsOn jalviewjsEclipseSetup + dependsOn jalviewjsProjectImport + dependsOn jalviewjsEclipsePaths + + doFirst { + // do not run a headless transpile when we claim to be in Eclipse + if (IN_ECLIPSE) { + println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'") + } else { + println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}") + } + } + + executable(eclipseBinary) + args(["-nosplash", "--launcher.suppressErrors", "-application", "org.eclipse.jdt.apt.core.aptBuild", "-data", eclipseWorkspace, "-${jalviewjs_eclipse_build_arg}", eclipse_project_name ]) + if (eclipseDebug) { + args += "-debug" + } + args += [ "--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" ] + if (!IN_ECLIPSE) { + args += [ "-D${j2sHeadlessBuildProperty}=true" ] + } + + def stdout + def stderr + doFirst { + stdout = new ByteArrayOutputStream() + stderr = new ByteArrayOutputStream() + + def logOutFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}" + def logOutFile = file(logOutFileName) + logOutFile.createNewFile() + logOutFile.text = """ROOT: ${jalviewjs_eclipse_root} +BINARY: ${eclipseBinary} +VERSION: ${eclipseVersion} +WORKSPACE: ${eclipseWorkspace} +DEBUG: ${eclipseDebug} +---- +""" + def logOutFOS = new FileOutputStream(logOutFile, true) // true == append + // combine stdout and stderr + def logErrFOS = logOutFOS + + if (jalviewjs_j2s_to_console.equals("true")) { + standardOutput = new org.apache.tools.ant.util.TeeOutputStream( + new org.apache.tools.ant.util.TeeOutputStream( + logOutFOS, + stdout), + standardOutput) + errorOutput = new org.apache.tools.ant.util.TeeOutputStream( + new org.apache.tools.ant.util.TeeOutputStream( + logErrFOS, + stderr), + errorOutput) + } else { + standardOutput = new org.apache.tools.ant.util.TeeOutputStream( + logOutFOS, + stdout) + errorOutput = new org.apache.tools.ant.util.TeeOutputStream( + logErrFOS, + stderr) + } + } + + doLast { + if (stdout.toString().contains("Error processing ")) { + // j2s did not complete transpile + //throw new TaskExecutionException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'") + if (jalviewjs_ignore_transpile_errors.equals("true")) { + println("IGNORING TRANSPILE ERRORS") + println("See eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'") + } else { + throw new GradleException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'") + } + } + } + + inputs.dir("${jalviewDir}/${sourceDir}") + outputs.dir("${jalviewDir}/${jalviewjsTransferSiteJsDir}") + outputs.upToDateWhen( { file("${jalviewDir}/${jalviewjsTransferSiteJsDir}${jalviewjs_server_resource}").exists() } ) +} + + +def jalviewjsCallCore(String name, FileCollection list, String prefixFile, String suffixFile, String jsfile, String zjsfile, File logOutFile, Boolean logOutConsole) { + + def stdout = new ByteArrayOutputStream() + def stderr = new ByteArrayOutputStream() + + def coreFile = file(jsfile) + def msg = "" + msg = "Creating core for ${name}...\nGenerating ${jsfile}" + println(msg) + logOutFile.createNewFile() + logOutFile.append(msg+"\n") + + def coreTop = file(prefixFile) + def coreBottom = file(suffixFile) + coreFile.getParentFile().mkdirs() + coreFile.createNewFile() + coreFile.write( coreTop.text ) + list.each { + f -> + if (f.exists()) { + def t = f.text + t.replaceAll("Clazz\\.([^_])","Clazz_${1}") + coreFile.append( t ) + } else { + msg = "...file '"+f.getPath()+"' does not exist, skipping" + println(msg) + logOutFile.append(msg+"\n") + } + } + coreFile.append( coreBottom.text ) + + msg = "Generating ${zjsfile}" + println(msg) + logOutFile.append(msg+"\n") + def logOutFOS = new FileOutputStream(logOutFile, true) // true == append + def logErrFOS = logOutFOS + + javaexec { + classpath = files(["${jalviewDir}/tools/closure_compiler.jar"]) + args = [ "--js", jsfile, "--js_output_file", zjsfile ] + maxHeapSize = "2g" + + msg = "\nRunning '"+commandLine.join(' ')+"'\n" + println(msg) + logOutFile.append(msg+"\n") + + if (logOutConsole) { + standardOutput = new org.apache.tools.ant.util.TeeOutputStream( + new org.apache.tools.ant.util.TeeOutputStream( + logOutFOS, + stdout), + standardOutput) + errorOutput = new org.apache.tools.ant.util.TeeOutputStream( + new org.apache.tools.ant.util.TeeOutputStream( + logErrFOS, + stderr), + errorOutput) + } else { + standardOutput = new org.apache.tools.ant.util.TeeOutputStream( + logOutFOS, + stdout) + errorOutput = new org.apache.tools.ant.util.TeeOutputStream( + logErrFOS, + stderr) + } + } + msg = "--" + println(msg) + logOutFile.append(msg+"\n") +} + + +task jalviewjsBuildAllCores { + group "JalviewJS" + description "Build the core js lib closures listed in the classlists dir" + dependsOn jalviewjsTranspile + dependsOn jalviewjsTransferUnzipSwingJs + + def j2sDir = "${jalviewDir}/${jalviewjsTransferSiteJsDir}/${jalviewjs_j2s_subdir}" + def swingJ2sDir = "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}/${jalviewjs_j2s_subdir}" + def libJ2sDir = "${jalviewDir}/${jalviewjsTransferSiteLibDir}/${jalviewjs_j2s_subdir}" + def jsDir = "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}/${jalviewjs_js_subdir}" + def outputDir = "${jalviewDir}/${jalviewjsTransferSiteCoreDir}/${jalviewjs_j2s_subdir}/core" + def prefixFile = "${jsDir}/core/coretop2.js" + def suffixFile = "${jsDir}/core/corebottom2.js" + + inputs.file prefixFile + inputs.file suffixFile + + def classlistFiles = [] + // add the classlists found int the jalviewjs_classlists_dir + fileTree(dir: "${jalviewDir}/${jalviewjs_classlists_dir}", include: "*.txt").each { + file -> + def name = file.getName() - ".txt" + classlistFiles += [ + 'file': file, + 'name': name + ] + } + + // _jmol and _jalview cores. Add any other peculiar classlist.txt files here + //classlistFiles += [ 'file': file("${jalviewDir}/${jalviewjs_classlist_jmol}"), 'name': "_jvjmol" ] + classlistFiles += [ 'file': file("${jalviewDir}/${jalviewjs_classlist_jalview}"), 'name': jalviewjsJalviewCoreName ] + + jalviewjsCoreClasslists = [] + + classlistFiles.each { + hash -> + + def file = hash['file'] + if (! file.exists()) { + //println("...classlist file '"+file.getPath()+"' does not exist, skipping") + return false // this is a "continue" in groovy .each closure + } + def name = hash['name'] + if (name == null) { + name = file.getName() - ".txt" + } + + def filelist = [] + file.eachLine { + line -> + filelist += line + } + def list = fileTree(dir: j2sDir, includes: filelist) + + def jsfile = "${outputDir}/core${name}.js" + def zjsfile = "${outputDir}/core${name}.z.js" + + jalviewjsCoreClasslists += [ + 'jsfile': jsfile, + 'zjsfile': zjsfile, + 'list': list, + 'name': name + ] + + inputs.file(file) + inputs.files(list) + outputs.file(jsfile) + outputs.file(zjsfile) + } + + // _stevesoft core. add any cores without a classlist here (and the inputs and outputs) + def stevesoftClasslistName = "_stevesoft" + def stevesoftClasslist = [ + 'jsfile': "${outputDir}/core${stevesoftClasslistName}.js", + 'zjsfile': "${outputDir}/core${stevesoftClasslistName}.z.js", + 'list': fileTree(dir: j2sDir, include: "com/stevesoft/pat/**/*.js"), + 'name': stevesoftClasslistName + ] + jalviewjsCoreClasslists += stevesoftClasslist + inputs.files(stevesoftClasslist['list']) + outputs.file(stevesoftClasslist['jsfile']) + outputs.file(stevesoftClasslist['zjsfile']) + + // _all core + def allClasslistName = "_all" + def allJsFiles = fileTree(dir: j2sDir, include: "**/*.js") + allJsFiles += fileTree( + dir: libJ2sDir, + include: "**/*.js", + excludes: [ + // these exlusions are files that the closure-compiler produces errors for. Should fix them + "**/org/jmol/jvxl/readers/IsoIntersectFileReader.js", + "**/org/jmol/export/JSExporter.js" + ] + ) + allJsFiles += fileTree( + dir: swingJ2sDir, + include: "**/*.js", + excludes: [ + // these exlusions are files that the closure-compiler produces errors for. Should fix them + "**/sun/misc/Unsafe.js", + "**/swingjs/jquery/jquery-editable-select.js", + "**/swingjs/jquery/j2sComboBox.js", + "**/sun/misc/FloatingDecimal.js" + ] + ) + def allClasslist = [ + 'jsfile': "${outputDir}/core${allClasslistName}.js", + 'zjsfile': "${outputDir}/core${allClasslistName}.z.js", + 'list': allJsFiles, + 'name': allClasslistName + ] + // not including this version of "all" core at the moment + //jalviewjsCoreClasslists += allClasslist + inputs.files(allClasslist['list']) + outputs.file(allClasslist['jsfile']) + outputs.file(allClasslist['zjsfile']) + + doFirst { + def logOutFile = file("${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_closure_stdout}") + logOutFile.getParentFile().mkdirs() + logOutFile.createNewFile() + logOutFile.write(getDate("yyyy-MM-dd HH:mm:ss")+" jalviewjsBuildAllCores\n----\n") + + jalviewjsCoreClasslists.each { + jalviewjsCallCore(it.name, it.list, prefixFile, suffixFile, it.jsfile, it.zjsfile, logOutFile, jalviewjs_j2s_to_console.equals("true")) + } + } + +} + + +def jalviewjsPublishCoreTemplate(String coreName, String templateName, File inputFile, String outputFile) { + copy { + from inputFile + into file(outputFile).getParentFile() + rename { filename -> + if (filename.equals(inputFile.getName())) { + return file(outputFile).getName() + } + return null + } + filter(ReplaceTokens, + beginToken: '_', + endToken: '_', + tokens: [ + 'MAIN': '"'+mainClass+'"', + 'CODE': "null", + 'NAME': jalviewjsJalviewTemplateName+" [core ${coreName}]", + 'COREKEY': jalviewjs_core_key, + 'CORENAME': coreName + ] + ) + } +} + + +task jalviewjsPublishCoreTemplates { + dependsOn jalviewjsBuildAllCores + def inputFileName = "${jalviewDir}/${j2s_coretemplate_html}" + def inputFile = file(inputFileName) + def outputDir = "${jalviewDir}/${jalviewjsTransferSiteCoreDir}" + + def outputFiles = [] + jalviewjsCoreClasslists.each { cl -> + def outputFile = "${outputDir}/${jalviewjsJalviewTemplateName}_${cl.name}.html" + cl['outputfile'] = outputFile + outputFiles += outputFile + } + + doFirst { + jalviewjsCoreClasslists.each { cl -> + jalviewjsPublishCoreTemplate(cl.name, jalviewjsJalviewTemplateName, inputFile, cl.outputfile) + } + } + inputs.file(inputFile) + outputs.files(outputFiles) +} + + +task jalviewjsSyncCore (type: Sync) { + dependsOn jalviewjsBuildAllCores + dependsOn jalviewjsPublishCoreTemplates + def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteCoreDir}") + def outputDir = "${jalviewDir}/${jalviewjsSiteDir}" + + from inputFiles + into outputDir + def outputFiles = [] + rename { filename -> + outputFiles += "${outputDir}/${filename}" + null + } + preserve { + include "**" + } + outputs.files outputFiles + inputs.files inputFiles +} + + +// this Copy version of TransferSiteJs will delete anything else in the target dir +task jalviewjsCopyTransferSiteJs(type: Copy) { + dependsOn jalviewjsTranspile + from "${jalviewDir}/${jalviewjsTransferSiteJsDir}" + into "${jalviewDir}/${jalviewjsSiteDir}" +} + + +// this Sync version of TransferSite is used by buildship to keep the website automatically up to date when a file changes +task jalviewjsSyncTransferSiteJs(type: Sync) { + from "${jalviewDir}/${jalviewjsTransferSiteJsDir}" + include "**/*.*" + into "${jalviewDir}/${jalviewjsSiteDir}" + preserve { + include "**" + } +} + + +jalviewjsSyncAllLibs.mustRunAfter jalviewjsCopyTransferSiteJs +jalviewjsSyncResources.mustRunAfter jalviewjsCopyTransferSiteJs +jalviewjsSyncSiteResources.mustRunAfter jalviewjsCopyTransferSiteJs +jalviewjsSyncBuildProperties.mustRunAfter jalviewjsCopyTransferSiteJs + +jalviewjsSyncAllLibs.mustRunAfter jalviewjsSyncTransferSiteJs +jalviewjsSyncResources.mustRunAfter jalviewjsSyncTransferSiteJs +jalviewjsSyncSiteResources.mustRunAfter jalviewjsSyncTransferSiteJs +jalviewjsSyncBuildProperties.mustRunAfter jalviewjsSyncTransferSiteJs + + +task jalviewjsPrepareSite { + group "JalviewJS" + description "Prepares the website folder including unzipping files and copying resources" + dependsOn jalviewjsSyncAllLibs + dependsOn jalviewjsSyncResources + dependsOn jalviewjsSyncSiteResources + dependsOn jalviewjsSyncBuildProperties + dependsOn jalviewjsSyncCore +} + + +task jalviewjsBuildSite { + group "JalviewJS" + description "Builds the whole website including transpiled code" + dependsOn jalviewjsCopyTransferSiteJs + dependsOn jalviewjsPrepareSite +} + + +task cleanJalviewjsTransferSite { + doFirst { + delete "${jalviewDir}/${jalviewjsTransferSiteJsDir}" + delete "${jalviewDir}/${jalviewjsTransferSiteLibDir}" + delete "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}" + delete "${jalviewDir}/${jalviewjsTransferSiteCoreDir}" + } +} + + +task cleanJalviewjsSite { + dependsOn cleanJalviewjsTransferSite + doFirst { + delete "${jalviewDir}/${jalviewjsSiteDir}" + } +} + + +task jalviewjsSiteTar(type: Tar) { + group "JalviewJS" + description "Creates a tar.gz file for the website" + dependsOn jalviewjsBuildSite + def outputFilename = "jalviewjs-site-${JALVIEW_VERSION}.tar.gz" + try { + archiveFileName = outputFilename + } catch (Exception e) { + archiveName = outputFilename + } + + compression Compression.GZIP + + from "${jalviewDir}/${jalviewjsSiteDir}" + into jalviewjs_site_dir // this is inside the tar file + + inputs.dir("${jalviewDir}/${jalviewjsSiteDir}") +} + + +task jalviewjsServer { + group "JalviewJS" + def filename = "jalviewjsTest.html" + description "Starts a webserver on localhost to test the website. See ${filename} to access local site on most recently used port." + def htmlFile = "${jalviewDirAbsolutePath}/${filename}" + doLast { + + SimpleHttpFileServerFactory factory = new SimpleHttpFileServerFactory() + def port = Integer.valueOf(jalviewjs_server_port) + def start = port + def running = false + def url + def jalviewjsServer + while(port < start+1000 && !running) { + try { + def doc_root = new File("${jalviewDirAbsolutePath}/${jalviewjsSiteDir}") + jalviewjsServer = factory.start(doc_root, port) + running = true + url = jalviewjsServer.getResourceUrl(jalviewjs_server_resource) + println("SERVER STARTED with document root ${doc_root}.") + println("Go to "+url+" . Run gradle --stop to stop (kills all gradle daemons).") + println("For debug: "+url+"?j2sdebug") + println("For verbose: "+url+"?j2sverbose") + } catch (Exception e) { + port++; + } + } + def htmlText = """ +

JalviewJS Test. <${url}>

+

JalviewJS Test with debug. <${url}?j2sdebug>

+

JalviewJS Test with verbose. <${url}?j2sdebug>

+ """ + jalviewjsCoreClasslists.each { cl -> + def urlcore = jalviewjsServer.getResourceUrl(file(cl.outputfile).getName()) + htmlText += """ +

${jalviewjsJalviewTemplateName} [core ${cl.name}]. <${urlcore}>

+ """ + println("For core ${cl.name}: "+urlcore) + } + + file(htmlFile).text = htmlText + } + + outputs.file(htmlFile) + outputs.upToDateWhen({false}) +} + + +task cleanJalviewjsAll { + group "JalviewJS" + description "Delete all configuration and build artifacts to do with JalviewJS build" + dependsOn cleanJalviewjsSite + dependsOn jalviewjsEclipsePaths + + doFirst { + delete "${jalviewDir}/${jalviewjsBuildDir}" + delete "${jalviewDir}/${eclipse_bin_dir}" + if (eclipseWorkspace != null && file(eclipseWorkspace.getAbsolutePath()+"/.metadata").exists()) { + delete file(eclipseWorkspace.getAbsolutePath()+"/.metadata") + } + delete "${jalviewDir}/${jalviewjs_j2s_settings}" + } + + outputs.upToDateWhen( { false } ) +} + + +task jalviewjsIDE_checkJ2sPlugin { + group "00 JalviewJS in Eclipse" + description "Compare the swingjs/net.sf.j2s.core.jar file with the Eclipse IDE's plugin version (found in the 'dropins' dir)" + + doFirst { + def j2sPlugin = string("${jalviewDir}/${jalviewjs_j2s_plugin}") + def j2sPluginFile = file(j2sPlugin) + def copyPlugin = jalviewjs_eclipseIDE_auto_copy_j2s_plugin == "true" + def eclipseHome = System.properties["eclipse.home.location"] + def doCopy = false + if (eclipseHome == null || ! IN_ECLIPSE) { + throw new StopExecutionException("Cannot find running Eclipse home from System.properties['eclipse.home.location']. Skipping J2S Plugin Check.") + } + def eclipseJ2sPlugin = "${eclipseHome}/dropins/${j2sPluginFile.getName()}" + def eclipseJ2sPluginFile = file(eclipseJ2sPlugin) + if (!eclipseJ2sPluginFile.exists()) { + def msg = "Eclipse J2S Plugin is not installed (could not find '${eclipseJ2sPlugin}')" + System.err.println(msg) + if (! copyPlugin) { + throw new GradleException(msg) + } + doCopy = true + } + + def digest = MessageDigest.getInstance("MD5") + + digest.update(j2sPluginFile.text.bytes) + def j2sPluginMd5 = new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0') + + digest.update(eclipseJ2sPluginFile.text.bytes) + def eclipseJ2sPluginMd5 = new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0') + + if (j2sPluginMd5 != eclipseJ2sPluginMd5) { + def msg = "WARNING! Eclipse J2S Plugin '${eclipseJ2sPlugin}' is different to this commit's version '${j2sPlugin}'" + System.err.println(msg) + if (! copyPlugin) { + throw new StopExecutionException(msg) + } + doCopy = true + } + + if (doCopy) { + def msg = "WARNING! Auto-copying this commit's j2s plugin version '${j2sPlugin}' to Eclipse J2S Plugin '${eclipseJ2sPlugin}'\n May require an Eclipse restart" + println(msg) + copy { + from j2sPlugin + eclipseJ2sPluginFile.getParentFile().mkdirs() + into eclipseJ2sPluginFile.getParent() + } + } else { + def msg = "Eclipse J2S Plugin is the same as '${j2sPlugin}' (this is good)" + println(msg) + } + } +} + + +task jalviewjsIDE_j2sFile { + group "00 JalviewJS in Eclipse" + description "Creates the .j2s file" + dependsOn jalviewjsCreateJ2sSettings +} + + +task jalviewjsIDE_SyncCore { + group "00 JalviewJS in Eclipse" + description "Build the core js lib closures listed in the classlists dir and publish core html from template" + dependsOn jalviewjsSyncCore } -project.afterEvaluate { - tasks.findByName('spotlessApply').dependsOn eclipseJdt +task jalviewjsIDE_SyncSiteAll { + dependsOn jalviewjsSyncAllLibs + dependsOn jalviewjsSyncResources + dependsOn jalviewjsSyncSiteResources + dependsOn jalviewjsSyncBuildProperties +} + + +cleanJalviewjsTransferSite.mustRunAfter jalviewjsIDE_SyncSiteAll + + +task jalviewjsIDE_PrepareSite { + group "00 JalviewJS in Eclipse" + description "Sync libs and resources to site dir, but not closure cores" + + dependsOn jalviewjsIDE_SyncSiteAll + dependsOn cleanJalviewjsTransferSite +} + + +task jalviewjsIDE_AssembleSite { + group "00 JalviewJS in Eclipse" + description "Assembles unzipped supporting zipfiles, resources, site resources and closure cores into the Eclipse transpiled site" + dependsOn jalviewjsPrepareSite +} + + +task jalviewjsIDE_SiteClean { + group "00 JalviewJS in Eclipse" + description "Deletes the Eclipse transpiled site" + dependsOn cleanJalviewjsSite +} + + +task jalviewjsIDE_Server { + group "00 JalviewJS in Eclipse" + description "Starts a webserver on localhost to test the website" + dependsOn jalviewjsServer +} + + +// buildship runs this at import or gradle refresh +task eclipseSynchronizationTask { + //dependsOn eclipseSetup + dependsOn createBuildProperties + if (J2S_ENABLED) { + dependsOn jalviewjsIDE_j2sFile + dependsOn jalviewjsIDE_checkJ2sPlugin + dependsOn jalviewjsIDE_PrepareSite + } +} + + +// buildship runs this at build time or project refresh +task eclipseAutoBuildTask { + //dependsOn jalviewjsIDE_checkJ2sPlugin + //dependsOn jalviewjsIDE_PrepareSite +} + + + + + + + + +task jalviewjs { + group "JalviewJS" + description "Build the site" + dependsOn jalviewjsBuildSite } diff --git a/gradle.properties b/gradle.properties index 45bf3ca..b446713 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,6 +2,14 @@ jalviewDir = . #JAVA_VERSION = 1.8 JAVA_VERSION = 11 + +source_dir = src +source_license_file = src/jalview/LICENSE +#source_dir = utils/jalviewjs/test/src + +test_source_dir = test +#test_source_dir = utils/jalviewjs/test/test + JALVIEW_VERSION = DEVELOPMENT INSTALLATION = Source jalview_keystore = keys/.keystore @@ -18,14 +26,12 @@ testngGroups = Functional j8libDir = j8lib j11libDir = j11lib -resourceDir = resources -helpParentDir = help -helpDir = help -helpOutputDir = build/distributions/help +resource_dir = resources +help_parent_dir = help +help_dir = help docDir = doc -sourceDir = src schemaDir = schemas -classesDir = classes +classes_dir = classes examplesDir = examples clover = false use_clover = false @@ -35,11 +41,10 @@ packageDir = dist ARCHIVEDIR = outputJar = jalview.jar -testSourceDir = test testOutputDir = tests utilsDir = utils -buildPropertiesFile = .build_properties +build_properties_file = .build_properties application_codebase = *.jalview.org mainClass = jalview.bin.Jalview shadowJarMainClass = jalview.bin.Launcher @@ -121,10 +126,6 @@ OSX_KEYSTORE = OSX_KEYPASS = JSIGN_SH = echo -spotless_eclipse_version = 4.10.0 -eclipse_extra_jdt_prefs_file = .settings/org.eclipse.jdt.core.jalview.prefs -eclipse_jdt_prefs_file = .settings/org.eclipse.jdt.core.prefs - pandoc_exec = /usr/local/bin/pandoc,/usr/bin/pandoc dev = false @@ -141,4 +142,74 @@ RUNRSYNC=false bamboo_channelbase = https://builds.jalview.org/browse bamboo_planKey = bamboo_getdown_channel_suffix = /latest/artifact/shared/getdown-channel - + +eclipse_extra_jdt_prefs_file = .settings/org.eclipse.jdt.core.jalview.prefs +eclipse_codestyle_file = utils/eclipse/JalviewCodeStyle.xml +eclipse_project_name = jalview +eclipse_bin_dir = bin +eclipse_debug = false + +# for developing in Eclipse as IDE, set this to automatically copy current swingjs/net.sf.j2s.core.jar to your dropins dir +jalviewjs_eclipseIDE_auto_copy_j2s_plugin = false +# Override this in a local.properties file +jalviewjs_eclipse_root = ~/buildtools/eclipse/jee-2019-09 + +jalviewjs_eclipse_dropins_dir = utils/jalviewjs/eclipse/dropins +jalviewjs_swingjs_zip = swingjs/SwingJS-site.zip +jalviewjs_j2s_plugin = swingjs/net.sf.j2s.core.jar +jalviewjs_libjs_dir = utils/jalviewjs/libjs +jalviewjs_site_resource_dir = utils/jalviewjs/site-resources +jalviewjs_classlists_dir = utils/jalviewjs/classlists +jalviewjs_classlist_jalview = utils/jalviewjs/_j2sclasslist.txt +jalviewjs_j2s_settings = .j2s +#jalviewjs_eclipse_workspace = ~/tmp/eclipse-workspace +# these 3 files/dirs found in build/jalviewjs +jalviewjs_eclipse_tmp_dropins_dir = eclipse_dropins +jalviewjs_eclipse_workspace_location_file = eclipse_workspace_location +jalviewjs_site_dir = site +# these dirs are subdirs of the site dir +jalviewjs_swingjs_subdir = swingjs +jalviewjs_j2s_subdir = swingjs/j2s +jalviewjs_js_subdir = swingjs/js +#jalviewjs_eclipseBuildArg = build +jalviewjs_eclipse_build_arg = cleanBuild +jalviewjs_server_port = 9001 +jalviewjs_server_wait = 30 +jalviewjs_server_resource = /jalview_bin_Jalview.html +jalviewjs_core_name = _jalview +jalviewjs_name = JalviewJS +jalviewjs_core_key = core +#jalviewjs_core_key = preloadCore +jalviewjs_ignore_transpile_errors = true + +j2s.compiler.status = enable +#j2s.site.directory = null ## site defined from buildDir+'/jalviewjs/'+jalviewjs_site_dir +#j2s.log.methods.declared = j2s_methods_declared.log +#j2s.log.methods.called = j2s_methods_called.log +#a semicolon-separated list of package-level file paths to be excluded +j2s.excluded.paths = test;testng;util +#j2s.include.tests = true +#j2s.testing = null +#j2s.compiler.nonqualified.packages = null +#j2s.compiler.nonqualified.classes = null +#j2s.compiler.mode = debug +#a semicolon-separated list of package (foo.) or class (foo.bar) replacements to be made +j2s.class.replacements = org.apache.log4j.->jalview.javascript.log4j. +j2s.template.html = utils/jalviewjs/template.html +j2s_coretemplate_html = utils/jalviewjs/coretemplate.html +#output file name for logging methods declared - delete the file to regenerate a listing +#j2s.prop.j2s.log.methods.declared=swingjs/methodsDeclared_csv +#output file name for logging methods called - delete the file to regenerate a listing +#j2s.prop.j2s.log.methods_called=swingjs/methodsCalled_csv +#if set, every instance of methods called will be logged +#otherwise, only the first call to a method will be logged +#output will be comma-separated: called method,caller class +#j2s.prop.j2s.log.all.calls=true + +jalviewjs_j2s_transpile_stdout = j2s-transpile.out +#jalviewjs_j2s_stderr = j2s-transpile.err # all going into out +jalviewjs_j2s_to_console = true +jalviewjs_j2s_closure_stdout = j2s-closure.out + + +testp=gradle.properties diff --git a/src/jalview/LICENSE b/src/jalview/LICENSE new file mode 100644 index 0000000..95f51dc --- /dev/null +++ b/src/jalview/LICENSE @@ -0,0 +1,20 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */