windows.dart 6.91 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import '../../artifacts.dart';
import '../../base/file_system.dart';
7
import '../../build_info.dart';
8
import '../build_system.dart';
9 10 11
import '../depfile.dart';
import '../exceptions.dart';
import 'assets.dart';
12
import 'common.dart';
13 14
import 'desktop.dart';
import 'icon_tree_shaker.dart';
15
import 'shader_compiler.dart';
16 17 18 19 20 21 22 23 24 25

/// The only files/subdirectories we care about.
const List<String> _kWindowsArtifacts = <String>[
  'flutter_windows.dll',
  'flutter_windows.dll.exp',
  'flutter_windows.dll.lib',
  'flutter_windows.dll.pdb',
  'flutter_export.h',
  'flutter_messenger.h',
  'flutter_plugin_registrar.h',
26
  'flutter_texture_registrar.h',
27 28 29 30
  'flutter_windows.h',
];

const String _kWindowsDepfile = 'windows_engine_sources.d';
31 32

/// Copies the Windows desktop embedding files to the copy directory.
33 34 35 36 37 38 39 40 41 42 43 44
class UnpackWindows extends Target {
  const UnpackWindows();

  @override
  String get name => 'unpack_windows';

  @override
  List<Source> get inputs => const <Source>[
    Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/windows.dart'),
  ];

  @override
45 46 47 48
  List<Source> get outputs => const <Source>[];

  @override
  List<String> get depfiles => const <String>[_kWindowsDepfile];
49 50 51 52 53

  @override
  List<Target> get dependencies => const <Target>[];

  @override
54
  Future<void> build(Environment environment) async {
55 56 57 58 59
    final String? buildModeEnvironment = environment.defines[kBuildMode];
    if (buildModeEnvironment == null) {
      throw MissingDefineException(kBuildMode, name);
    }
    final BuildMode buildMode = getBuildModeForName(buildModeEnvironment);
60 61 62
    final String engineSourcePath = environment.artifacts
      .getArtifactPath(
        Artifact.windowsDesktopPath,
63
        platform: TargetPlatform.windows_x64,
64 65 66 67 68
        mode: buildMode,
      );
    final String clientSourcePath = environment.artifacts
      .getArtifactPath(
        Artifact.windowsCppClientWrapper,
69
        platform: TargetPlatform.windows_x64,
70 71
        mode: buildMode,
      );
72 73
    final Directory outputDirectory = environment.fileSystem.directory(
      environment.fileSystem.path.join(
74 75 76
        environment.projectDir.path,
        'windows',
        'flutter',
77 78 79 80 81 82
        'ephemeral',
      ),
    );
    final Depfile depfile = unpackDesktopArtifacts(
      fileSystem: environment.fileSystem,
      artifacts: _kWindowsArtifacts,
83
      engineSourcePath: engineSourcePath,
84
      outputDirectory: outputDirectory,
85
      clientSourcePaths: <String>[clientSourcePath],
86 87
      icuDataPath: environment.artifacts.getArtifactPath(
        Artifact.icuData,
88
        platform: TargetPlatform.windows_x64
89
      )
90 91 92 93 94 95 96 97 98 99 100 101
    );
    final DepfileService depfileService = DepfileService(
      fileSystem: environment.fileSystem,
      logger: environment.logger,
    );
    depfileService.writeToFile(
      depfile,
      environment.buildDir.childFile(_kWindowsDepfile),
    );
  }
}

102 103 104
/// Creates a bundle for the Windows desktop target.
abstract class BundleWindowsAssets extends Target {
  const BundleWindowsAssets();
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125

  @override
  List<Target> get dependencies => const <Target>[
    KernelSnapshot(),
    UnpackWindows(),
  ];

  @override
  List<Source> get inputs => const <Source>[
    Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/windows.dart'),
    Source.pattern('{PROJECT_DIR}/pubspec.yaml'),
    ...IconTreeShaker.inputs,
  ];

  @override
  List<String> get depfiles => const <String>[
    'flutter_assets.d',
  ];

  @override
  Future<void> build(Environment environment) async {
126 127
    final String? buildModeEnvironment = environment.defines[kBuildMode];
    if (buildModeEnvironment == null) {
128
      throw MissingDefineException(kBuildMode, 'bundle_windows_assets');
129
    }
130
    final BuildMode buildMode = getBuildModeForName(buildModeEnvironment);
131 132 133 134 135 136 137 138 139 140
    final Directory outputDirectory = environment.outputDir
      .childDirectory('flutter_assets');
    if (!outputDirectory.existsSync()) {
      outputDirectory.createSync();
    }

    // Only copy the kernel blob in debug mode.
    if (buildMode == BuildMode.debug) {
      environment.buildDir.childFile('app.dill')
        .copySync(outputDirectory.childFile('kernel_blob.bin').path);
141
    }
142 143 144
    final Depfile depfile = await copyAssets(
      environment,
      outputDirectory,
145
      targetPlatform: TargetPlatform.windows_x64,
146
      shaderTarget: ShaderTarget.sksl,
147
    );
148 149 150 151 152 153 154 155
    final DepfileService depfileService = DepfileService(
      fileSystem: environment.fileSystem,
      logger: environment.logger,
    );
    depfileService.writeToFile(
      depfile,
      environment.buildDir.childFile('flutter_assets.d'),
    );
156 157
  }
}
158 159 160 161

/// A wrapper for AOT compilation that copies app.so into the output directory.
class WindowsAotBundle extends Target {
  /// Create a [WindowsAotBundle] wrapper for [aotTarget].
162
  const WindowsAotBundle(this.aotTarget);
163 164 165 166 167

  /// The [AotElfBase] subclass that produces the app.so.
  final AotElfBase aotTarget;

  @override
168
  String get name => 'windows_aot_bundle';
169 170 171 172 173 174 175

  @override
  List<Source> get inputs => const <Source>[
    Source.pattern('{BUILD_DIR}/app.so'),
  ];

  @override
176
  List<Source> get outputs =>
177 178 179 180 181 182 183 184 185 186 187 188
    const <Source>[
      Source.pattern('{OUTPUT_DIR}/windows/app.so'),
    ];

  @override
  List<Target> get dependencies => <Target>[
    aotTarget,
  ];

  @override
  Future<void> build(Environment environment) async {
    final File outputFile = environment.buildDir.childFile('app.so');
189
    final Directory outputDirectory = environment.outputDir.childDirectory('windows');
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    if (!outputDirectory.existsSync()) {
      outputDirectory.createSync(recursive: true);
    }
    outputFile.copySync(outputDirectory.childFile('app.so').path);
  }
}

class ReleaseBundleWindowsAssets extends BundleWindowsAssets {
  const ReleaseBundleWindowsAssets();

  @override
  String get name => 'release_bundle_windows_assets';

  @override
  List<Source> get outputs => const <Source>[];

  @override
  List<Target> get dependencies => <Target>[
    ...super.dependencies,
209
    const WindowsAotBundle(AotElfRelease(TargetPlatform.windows_x64)),
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  ];
}

class ProfileBundleWindowsAssets extends BundleWindowsAssets {
  const ProfileBundleWindowsAssets();

  @override
  String get name => 'profile_bundle_windows_assets';

  @override
  List<Source> get outputs => const <Source>[];

  @override
  List<Target> get dependencies => <Target>[
    ...super.dependencies,
225
    const WindowsAotBundle(AotElfProfile(TargetPlatform.windows_x64)),
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
  ];
}

class DebugBundleWindowsAssets extends BundleWindowsAssets {
  const DebugBundleWindowsAssets();

  @override
  String get name => 'debug_bundle_windows_assets';

  @override
  List<Source> get inputs => <Source>[
    const Source.pattern('{BUILD_DIR}/app.dill'),
  ];

  @override
  List<Source> get outputs => <Source>[
    const Source.pattern('{OUTPUT_DIR}/flutter_assets/kernel_blob.bin'),
  ];
}