flutter.gradle 12.5 KB
Newer Older
1 2
import java.nio.file.Path
import java.nio.file.Paths
3 4

import com.android.builder.model.AndroidProject
5
import org.apache.tools.ant.taskdefs.condition.Os
6 7 8 9 10
import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.Project
import org.gradle.api.Plugin
import org.gradle.api.Task
11
import org.gradle.api.file.CopySpec
12 13
import org.gradle.api.file.FileCollection
import org.gradle.api.tasks.Copy
14
import org.gradle.api.tasks.InputFiles
15 16
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction
17
import org.gradle.api.tasks.bundling.Jar
18

19 20 21 22 23
buildscript {
  repositories {
    jcenter()
  }
  dependencies {
24
    classpath 'com.android.tools.build:gradle:2.2.3'
25 26 27 28 29
  }
}

apply plugin: FlutterPlugin

30
class FlutterPlugin implements Plugin<Project> {
31
    private File flutterRoot
32
    private File flutterExecutable
33
    private String localEngine
34
    private String localEngineSrcPath
35 36
    private Properties localProperties

37 38 39 40 41 42 43 44 45 46 47 48 49
    private File flutterJar
    private File debugFlutterJar
    private File profileFlutterJar
    private File releaseFlutterJar

    private Properties readPropertiesIfExist(File propertiesFile) {
        Properties result = new Properties()
        if (propertiesFile.exists()) {
            propertiesFile.withInputStream { stream -> result.load(stream) }
        }
        return result
    }

50 51
    private String resolveProperty(Project project, String name, String defaultValue) {
        if (localProperties == null) {
52
            localProperties = readPropertiesIfExist(project.rootProject.file("local.properties"))
53
        }
54
        String result
55 56 57 58 59 60 61 62 63 64 65
        if (project.hasProperty(name)) {
            result = project.property(name)
        }
        if (result == null) {
            result = localProperties.getProperty(name)
        }
        if (result == null) {
            result = defaultValue
        }
        return result
    }
66 67 68

    @Override
    void apply(Project project) {
69 70 71 72 73 74
        // Add a 'profile' build type
        project.android.buildTypes {
            profile {
                initWith debug
            }
        }
75

76
        String flutterRootPath = resolveProperty(project, "flutter.sdk", System.env.FLUTTER_HOME)
77
        if (flutterRootPath == null) {
78
            throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file or with a FLUTTER_HOME environment variable.")
79
        }
80 81
        flutterRoot = project.file(flutterRootPath)
        if (!flutterRoot.isDirectory()) {
82 83 84
            throw new GradleException("flutter.sdk must point to the Flutter SDK directory")
        }

85 86 87
        String flutterExecutableName = Os.isFamily(Os.FAMILY_WINDOWS) ? "flutter.bat" : "flutter"
        flutterExecutable = Paths.get(flutterRoot.absolutePath, "bin", flutterExecutableName).toFile();

88 89 90 91 92 93
        if (project.hasProperty('localEngineOut')) {
            String engineOutPath = project.property('localEngineOut')
            File engineOut = project.file(engineOutPath)
            if (!engineOut.isDirectory()) {
                throw new GradleException('localEngineOut must point to a local engine build')
            }
94
            flutterJar = Paths.get(engineOut.absolutePath, "flutter.jar").toFile()
95
            if (!flutterJar.isFile()) {
96
                throw new GradleException('Local engine build does not contain flutter.jar')
97
            }
98 99 100 101

            localEngine = engineOut.name
            localEngineSrcPath = engineOut.parentFile.parent

102 103
            project.dependencies {
                compile project.files(flutterJar)
104
            }
105 106
        } else {
            Path baseEnginePath = Paths.get(flutterRoot.absolutePath, "bin", "cache", "artifacts", "engine")
107 108 109
            debugFlutterJar = baseEnginePath.resolve("android-arm").resolve("flutter.jar").toFile()
            profileFlutterJar = baseEnginePath.resolve("android-arm-profile").resolve("flutter.jar").toFile()
            releaseFlutterJar = baseEnginePath.resolve("android-arm-release").resolve("flutter.jar").toFile()
110
            if (!debugFlutterJar.isFile()) {
111
                project.exec {
112
                    executable flutterExecutable.absolutePath
113 114
                    args "precache"
                }
115 116
                if (!debugFlutterJar.isFile()) {
                    throw new GradleException("Unable to find flutter.jar in SDK: ${debugFlutterJar}")
117 118
                }
            }
119 120 121 122 123 124

            // Add x86/x86_64 native library. Debug mode only, for now.
            File flutterX86Jar = project.file("${project.buildDir}/${AndroidProject.FD_INTERMEDIATES}/flutter/flutter-x86.jar")
            project.tasks.create("flutterBuildX86Jar", Jar) {
                destinationDir flutterX86Jar.parentFile
                archiveName flutterX86Jar.name
125
                from("${flutterRoot}/bin/cache/artifacts/engine/android-x86/libflutter.so") {
126 127
                    into "lib/x86"
                }
128
                from("${flutterRoot}/bin/cache/artifacts/engine/android-x64/libflutter.so") {
129 130 131 132 133 134 135 136 137
                    into "lib/x86_64"
                }
            }

            project.dependencies {
                debugCompile project.files(flutterX86Jar, debugFlutterJar)
                profileCompile project.files(profileFlutterJar)
                releaseCompile project.files(releaseFlutterJar)
            }
138 139
        }

140 141
        project.extensions.create("flutter", FlutterExtension)
        project.afterEvaluate this.&addFlutterTask
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167

        File pluginsFile = new File(project.rootProject.projectDir.parentFile, '.flutter-plugins')
        Properties plugins = readPropertiesIfExist(pluginsFile)

        plugins.each { name, _ ->
            def pluginProject = project.rootProject.findProject(":$name")
            if (pluginProject != null) {
                project.dependencies {
                    compile pluginProject
                }
                pluginProject.afterEvaluate this.&addFlutterJarDependency
            } else {
                project.logger.error("Plugin project :$name not found. Please update settings.gradle.")
            }
        }
    }

    private void addFlutterJarDependency(Project project) {
        project.dependencies {
            if (flutterJar != null) {
                provided project.files(flutterJar)
            } else {
                debugProvided project.files(debugFlutterJar)
                releaseProvided project.files(releaseFlutterJar)
            }
        }
168 169 170 171 172 173 174
    }

    private void addFlutterTask(Project project) {
        if (project.flutter.source == null) {
            throw new GradleException("Must provide Flutter source directory")
        }

175
        String target = project.flutter.target
176 177 178
        if (target == null) {
            target = 'lib/main.dart'
        }
179 180 181
        if (project.hasProperty('target')) {
            target = project.property('target')
        }
182

183 184 185
        if (project.tasks.findByName('flutterBuildX86Jar')) {
            project.compileDebugJavaWithJavac.dependsOn project.flutterBuildX86Jar
        }
186

187 188 189 190 191
        File kernel
        if (project.hasProperty('kernel')) {
            kernel = project.file(project.property('kernel'))
        }

192
        project.android.applicationVariants.all { variant ->
193 194 195 196 197 198
            if (!["debug", "profile", "release"].contains(variant.name)) {
                throw new GradleException("Build variant must be one of \"debug\", \"profile\", or \"release\" but was \"${variant.name}\"")
            }

            FlutterTask flutterTask = project.tasks.create("flutterBuild${variant.name.capitalize()}", FlutterTask) {
                flutterRoot this.flutterRoot
199
                flutterExecutable this.flutterExecutable
200 201
                buildMode variant.name
                localEngine this.localEngine
202
                localEngineSrcPath this.localEngineSrcPath
203
                targetPath target
204
                kernelFile kernel
205 206 207 208
                sourceDir project.file(project.flutter.source)
                intermediateDir project.file("${project.buildDir}/${AndroidProject.FD_INTERMEDIATES}/flutter/${variant.name}")
            }

209
            Task copyFlxTask = project.tasks.create(name: "copyFlutterAssets${variant.name.capitalize()}", type: Copy) {
210 211 212
                dependsOn flutterTask
                dependsOn variant.mergeAssets
                into variant.mergeAssets.outputDir
213
                with flutterTask.assets
214 215 216 217 218 219 220 221
            }
            variant.outputs[0].processResources.dependsOn(copyFlxTask)
        }
    }
}

class FlutterExtension {
    String source
222
    String target
223 224 225
}

class FlutterTask extends DefaultTask {
226
    File flutterRoot
227
    File flutterExecutable
228 229
    String buildMode
    String localEngine
230
    String localEngineSrcPath
231
    @Input
232
    String targetPath
233 234
    @Optional @InputFile
    File kernelFile
235 236 237 238 239 240

    File sourceDir

    @OutputDirectory
    File intermediateDir

241 242 243 244
    CopySpec getAssets() {
        return project.copySpec {
            from "${intermediateDir}/app.flx"
            if (buildMode != 'debug') {
245 246 247 248
                from "${intermediateDir}/vm_snapshot_data"
                from "${intermediateDir}/vm_snapshot_instr"
                from "${intermediateDir}/isolate_snapshot_data"
                from "${intermediateDir}/isolate_snapshot_instr"
249 250
            }
        }
251 252
    }

253 254 255 256 257 258 259 260 261 262 263 264 265 266
    FileCollection readDependencies(File dependenciesFile) {
        if (dependenciesFile.exists()) {
            try {
                // Dependencies file has Makefile syntax:
                //   <target> <files>: <source> <files> <separated> <by> <space>
                String depText = dependenciesFile.text
                return project.files(depText.split(': ')[1].split())
            } catch (Exception e) {
                logger.error("Error reading dependency file ${dependenciesFile}: ${e}")
            }
        }
        return null
    }

267 268
    @InputFiles
    FileCollection getSourceFiles() {
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
        File dependenciesFile
        if (buildMode != 'debug') {
            dependenciesFile = project.file("${intermediateDir}/snapshot.d")
        } else {
            dependenciesFile = project.file("${intermediateDir}/snapshot_blob.bin.d")
        }
        FileCollection sources = readDependencies(dependenciesFile)
        if (sources != null) {
            // We have a dependencies file. Add a dependency on gen_snapshot as well, since the
            // snapshots have to be rebuilt if it changes.
            FileCollection snapshotter = readDependencies(project.file("${intermediateDir}/gen_snapshot.d"))
            if (snapshotter != null) {
                sources = sources.plus(snapshotter)
            }
            // Finally, add a dependency on pubspec.yaml as well.
            return sources.plus(project.files('pubspec.yaml'))
        }
        // No dependencies file (or problems parsing it). Fall back to source files.
        return project.fileTree(
                dir: sourceDir,
                exclude: ['android', 'ios'],
                include: ['**/*.dart', 'pubspec.yaml']
        )
292 293
    }

294 295 296 297 298 299 300
    @TaskAction
    void build() {
        if (!sourceDir.isDirectory()) {
            throw new GradleException("Invalid Flutter source directory: ${sourceDir}")
        }

        intermediateDir.mkdirs()
301 302

        if (buildMode != "debug") {
303
            project.exec {
304
                executable flutterExecutable.absolutePath
305 306 307
                workingDir sourceDir
                if (localEngine != null) {
                    args "--local-engine", localEngine
308
                    args "--local-engine-src-path", localEngineSrcPath
309 310
                }
                args "build", "aot"
311
                args "--quiet"
312 313 314 315
                args "--target", targetPath
                args "--target-platform", "android-arm"
                args "--output-dir", "${intermediateDir}"
                args "--${buildMode}"
316 317 318
            }
        }

319
        project.exec {
320
            executable flutterExecutable.absolutePath
321
            workingDir sourceDir
322
            if (localEngine != null) {
323
                args "--local-engine", localEngine
324
                args "--local-engine-src-path", localEngineSrcPath
325
            }
326
            args "build", "flx"
327
            args "--target", targetPath
328 329 330
            if (kernelFile != null) {
                args "--kernel", kernelFile.absolutePath
            }
331 332
            args "--output-file", "${intermediateDir}/app.flx"
            if (buildMode != "debug") {
333
                args "--precompiled"
334
            } else {
335 336
                args "--snapshot", "${intermediateDir}/snapshot_blob.bin"
                args "--depfile", "${intermediateDir}/snapshot_blob.bin.d"
337
            }
338 339 340 341
            args "--working-dir", "${intermediateDir}/flx"
        }
    }
}