Skip to content

Commit 5b0ff79

Browse files
dellis1972dellis1972
committed
[Xamarin.Android.Build.Tasks] Run aapt2 compile incrementally.
The `aapt2 compile` command runs in two modes. The one we currently use is the `archive` mode. We calling `aapt2 compile` with the `--dir` argument you end up generating one `flata` archive for all the files. The side effect of this is that even if you only change one file, it will need to regenerate the entire `flata` archive. But it has a second mode. Rather than using `--dir` you just send in a single file. This then writes a single `.flat` file to the output directory. While this does mean you have to call `aapt2 compile` for EVERY file, it does mean we can leverage MSbuilds support for partial targets. This means MSbuild will detect ONLY the files which changed and allow us to call `aapt2 compile` with just THOSE files. While this may impact on initial build times, the goal is to make incremental builds quicker. This is especially true for users to use ALLOT of `AndroidResource` items.
1 parent b954e34 commit 5b0ff79

File tree

14 files changed

+429
-156
lines changed

14 files changed

+429
-156
lines changed

‎src/Xamarin.Android.Build.Tasks/MSBuild/Xamarin/Android/Xamarin.Android.Aapt2.targets‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
3737
/>
3838
<ItemGroup Condition="'$(_Aapt2Version)' != '@(_Aapt2VersionCache)'">
3939
<_CompiledFlataArchive Include="$(_AndroidLibrayProjectIntermediatePath)**\*.flata" />
40-
<_CompiledFlataArchive Include="$(IntermediateOutputPath)\*.flata" />
40+
<_CompiledFlataArchive Include="$(_AndroidLibraryFlatFilesDirectory)*.flat" />
41+
<_CompiledFlataArchive Include="$(_AndroidLibraryFlatArchivesDirectory)\*.flata" />
4142
<_CompiledFlataStamp Include="$(_AndroidLibrayProjectIntermediatePath)**\compiled.stamp" />
4243
</ItemGroup>
4344
<Delete
@@ -89,6 +90,7 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
8990
ContinueOnError="$(DesignTimeBuild)"
9091
ExplicitCrunch="$(AndroidExplicitCrunch)"
9192
ExtraArgs="$(AndroidAapt2CompileExtraArgs)"
93+
FlatFilesDirectory="$(_AndroidLibraryFlatFilesDirectory)"
9294
FlatArchivesDirectory="$(_AndroidLibraryFlatArchivesDirectory)"
9395
ResourceDirectories="@(_LibraryResourceHashDirectories)"
9496
ToolPath="$(Aapt2ToolPath)"
@@ -130,25 +132,36 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
130132
<Touch Files="$(_AndroidStampDirectory)_ConvertResourcesCases.stamp" AlwaysCreate="True" />
131133
</Target>
132134

135+
<Target Name="_CalcuateResourceFileName">
136+
<ItemGroup>
137+
<_CompileFiles Include="$(MonoAndroidResDirIntermediate)**\*.*" />
138+
</ItemGroup>
139+
<Aapt2CalculateCompiledResourceFileName Files="@(_CompileFiles)">
140+
<Output TaskParameter="Result" ItemName="_CompileResourcesInputs" />
141+
</Aapt2CalculateCompiledResourceFileName>
142+
</Target>
143+
133144
<Target Name="_CompileResources"
134145
Condition=" '$(_AndroidUseAapt2)' == 'True' And '@(AndroidResource)' != '' "
135-
Inputs="$(MSBuildAllProjects);$(_AndroidBuildPropertiesCache);@(AndroidResource)"
136-
Outputs="$(_AndroidLibraryFlatArchivesDirectory)\_CompileResources.stamp"
137-
DependsOnTargets="$(_BeforeCompileResources);_ConvertResourcesCases"
146+
Inputs="$(MSBuildAllProjects);$(_AndroidBuildPropertiesCache);@(_CompileResourcesInputs)"
147+
Outputs="@(_CompileResourcesInputs->'$(_AndroidLibraryFlatFilesDirectory)%(_ResourceSubDir)_%(Filename)%(_ResourceExtension).flat')"
148+
DependsOnTargets="$(_BeforeCompileResources);_ConvertResourcesCases;_CalcuateResourceFileName"
138149
>
150+
<MakeDir Directories="$(_AndroidLibraryFlatFilesDirectory)" Condition="!Exists('$(_AndroidLibraryFlatFilesDirectory)')" />
139151
<Aapt2Compile
140152
ContinueOnError="$(DesignTimeBuild)"
141153
ExplicitCrunch="$(AndroidExplicitCrunch)"
142154
ExtraArgs="$(AndroidAapt2CompileExtraArgs)"
155+
FlatFilesDirectory="$(_AndroidLibraryFlatFilesDirectory)"
143156
FlatArchivesDirectory="$(_AndroidLibraryFlatArchivesDirectory)"
157+
ResourcesToCompile="@(_CompileResourcesInputs)"
144158
ResourceDirectories="$(MonoAndroidResDirIntermediate)"
145159
ResourceNameCaseMap="$(_AndroidResourceNameCaseMap)"
146160
ToolPath="$(Aapt2ToolPath)"
147161
ToolExe="$(Aapt2ToolExe)"
148162
/>
149-
<Touch Files="$(_AndroidLibraryFlatArchivesDirectory)\_CompileResources.stamp" AlwaysCreate="True" />
150163
<ItemGroup>
151-
<FileWrites Include="$(_AndroidLibraryFlatArchivesDirectory)\compiled.flata" />
164+
<FileWrites Include="@(_CompileResourcesInputs->'$(_AndroidLibraryFlatFilesDirectory)%(_ResourceSubDir)_%(Filename)%(_ResourceExtension).flat')" />
152165
</ItemGroup>
153166
</Target>
154167

@@ -171,7 +184,7 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
171184
ApplicationName="$(_AndroidPackage)"
172185
JavaPlatformJarPath="$(JavaPlatformJarPath)"
173186
JavaDesignerOutputDirectory="$(ResgenTemporaryDirectory)"
174-
CompiledResourceFlatArchive="$(_AndroidLibraryFlatArchivesDirectory)\compiled.flata"
187+
CompiledResourceFlatArchive="$(_AndroidLibraryFlatFilesDirectory)"
175188
ManifestFiles="$(ResgenTemporaryDirectory)\AndroidManifest.xml"
176189
AdditionalResourceArchives="@(_LibraryResourceHashDirectories->'$(_AndroidLibraryFlatArchivesDirectory)%(Hash).flata')"
177190
AdditionalAndroidResourcePaths="@(_LibraryResourceHashDirectories)"
@@ -202,9 +215,11 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
202215
<Aapt2Compile
203216
Condition=" '$(AndroidUseAapt2)' == 'True' And '@(_ProcessedCustomViews)' != '' "
204217
ContinueOnError="$(DesignTimeBuild)"
205-
ResourceDirectories="@(_ProcessedCustomViews->'%(ResourceDirectory)'->Distinct())"
218+
ResourcesToCompile="@(_ProcessedCustomViews->'%(Resource)'->Distinct())"
219+
ResourceDirectories="$(MonoAndroidResDirIntermediate);@(_LibraryResourceHashDirectories)"
206220
ExplicitCrunch="$(AndroidExplicitCrunch)"
207221
ExtraArgs="$(AndroidAapt2CompileExtraArgs)"
222+
FlatFilesDirectory="$(_AndroidLibraryFlatFilesDirectory)"
208223
FlatArchivesDirectory="$(_AndroidLibraryFlatArchivesDirectory)"
209224
ToolPath="$(Aapt2ToolPath)"
210225
ToolExe="$(Aapt2ToolExe)">
@@ -225,7 +240,7 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
225240
</PropertyGroup>
226241
<Aapt2Link
227242
Condition="'$(_AndroidUseAapt2)' == 'True'"
228-
CompiledResourceFlatArchive="$(_AndroidLibraryFlatArchivesDirectory)\compiled.flata"
243+
CompiledResourceFlatArchive="$(_AndroidLibraryFlatFilesDirectory)"
229244
ResourceNameCaseMap="$(_AndroidResourceNameCaseMap)"
230245
ResourceDirectories="$(MonoAndroidResDirIntermediate)"
231246
AssemblyIdentityMapFile="$(_AndroidLibrayProjectAssemblyMapFile)"

‎src/Xamarin.Android.Build.Tasks/Tasks/Aapt2.cs‎

Lines changed: 13 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -39,79 +39,28 @@ protected string ResourceDirectoryFullPath (string resourceDirectory)
3939
return (Path.IsPathRooted (resourceDirectory) ? resourceDirectory : Path.Combine (WorkingDirectory, resourceDirectory)).TrimEnd ('\\');
4040
}
4141

42+
protected string GetFullPath (string dir)
43+
{
44+
return (Path.IsPathRooted (dir) ? dir : Path.GetFullPath (Path.Combine (WorkingDirectory, dir)));
45+
}
46+
4247
protected string GenerateFullPathToTool ()
4348
{
4449
return Path.Combine (ToolPath, string.IsNullOrEmpty (ToolExe) ? ToolName : ToolExe);
4550
}
4651

47-
protected bool RunAapt (string commandLine, IList<OutputLine> output)
52+
Aapt2Daemon daemon;
53+
public override bool Execute ()
4854
{
49-
var stdout_completed = new ManualResetEvent (false);
50-
var stderr_completed = new ManualResetEvent (false);
51-
var psi = new ProcessStartInfo () {
52-
FileName = GenerateFullPathToTool (),
53-
Arguments = commandLine,
54-
UseShellExecute = false,
55-
RedirectStandardOutput = true,
56-
RedirectStandardError = true,
57-
StandardOutputEncoding = Encoding.UTF8,
58-
CreateNoWindow = true,
59-
WindowStyle = ProcessWindowStyle.Hidden,
60-
WorkingDirectory = WorkingDirectory,
61-
};
62-
object lockObject = new object ();
63-
using (var proc = new Process ()) {
64-
proc.OutputDataReceived += (sender, e) => {
65-
if (e.Data != null)
66-
lock (lockObject)
67-
output.Add (new OutputLine (e.Data, stdError: false));
68-
else
69-
stdout_completed.Set ();
70-
};
71-
proc.ErrorDataReceived += (sender, e) => {
72-
if (e.Data != null)
73-
lock (lockObject)
74-
output.Add (new OutputLine (e.Data, stdError: !IsAapt2Warning (e.Data)));
75-
else
76-
stderr_completed.Set ();
77-
};
78-
LogDebugMessage ("Executing {0}", commandLine);
79-
proc.StartInfo = psi;
80-
proc.Start ();
81-
proc.BeginOutputReadLine ();
82-
proc.BeginErrorReadLine ();
83-
CancellationToken.Register (() => {
84-
try {
85-
proc.Kill ();
86-
} catch (Exception) {
87-
}
88-
});
89-
proc.WaitForExit ();
90-
if (psi.RedirectStandardError)
91-
stderr_completed.WaitOne (TimeSpan.FromSeconds (30));
92-
if (psi.RedirectStandardOutput)
93-
stdout_completed.WaitOne (TimeSpan.FromSeconds (30));
94-
return proc.ExitCode == 0 && !output.Any (x => x.StdError);
95-
}
55+
// Must register on the UI thread!
56+
daemon = Aapt2Daemon.GetInstance (BuildEngine4, GenerateFullPathToTool ());
57+
return base.Execute ();
9658
}
9759

98-
bool IsAapt2Warning (string singleLine)
60+
protected bool RunAapt (string [] args, IList<OutputLine> output)
9961
{
100-
var match = AndroidRunToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
101-
if (match.Success) {
102-
var file = match.Groups ["file"].Value;
103-
var level = match.Groups ["level"].Value.ToLowerInvariant ();
104-
var message = match.Groups ["message"].Value;
105-
if (singleLine.StartsWith ($"{ToolName} W", StringComparison.OrdinalIgnoreCase))
106-
return true;
107-
if (file.StartsWith ("W/", StringComparison.OrdinalIgnoreCase))
108-
return true;
109-
if (message.Contains ("warn:"))
110-
return true;
111-
if (level.Contains ("warning"))
112-
return true;
113-
}
114-
return false;
62+
LogDebugMessage ($"Executing {string.Join (" ", args)}");
63+
return daemon.RunAapt2 (output, args);
11564
}
11665

11766
protected bool LogAapt2EventsFromOutput (string singleLine, MessageImportance messageImportance, bool apptResult)

‎src/Xamarin.Android.Build.Tasks/Tasks/Aapt2CalculateCompiledResourceFileName.cs‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
using System.Collections.Generic;
2+
using Microsoft.Build.Utilities;
3+
using Microsoft.Build.Framework;
4+
using Xamarin.Android.Tools;
5+
6+
namespace Xamarin.Android.Tasks
7+
{
8+
public class Aapt2CalculateCompiledResourceFileName : Task {
9+
[Required]
10+
public ITaskItem [] Files { get; set; }
11+
12+
[Output]
13+
public ITaskItem [] Result { get; set;}
14+
public override bool Execute (){
15+
foreach (var f in Files) {
16+
var dir = f.GetMetadata ("RecursiveDir");
17+
f.SetMetadata ("_ResourceSubDir", dir.TrimEnd ('\\').TrimEnd ('/'));
18+
f.SetMetadata ("_ResourceExtension", f.GetMetadata ("Extension"));
19+
if (dir.StartsWith ("values"))
20+
f.SetMetadata ("_ResourceExtension", ".arsc");
21+
}
22+
Result = Files;
23+
return !Log.HasLoggedErrors;
24+
}
25+
}
26+
}

‎src/Xamarin.Android.Build.Tasks/Tasks/Aapt2Compile.cs‎

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,48 @@ public class Aapt2Compile : Aapt2 {
1919
public override string TaskPrefix => "A2C";
2020

2121
List<ITaskItem> archives = new List<ITaskItem> ();
22+
List<ITaskItem> files = new List<ITaskItem> ();
2223

2324
public bool ExplicitCrunch { get; set; }
2425

2526
public string ExtraArgs { get; set; }
2627

2728
public string FlatArchivesDirectory { get; set; }
2829

30+
public string FlatFilesDirectory { get; set; }
31+
public ITaskItem [] ResourcesToCompile { get; set; }
32+
2933
[Output]
3034
public ITaskItem [] CompiledResourceFlatArchives => archives.ToArray ();
3135

36+
[Output]
37+
public ITaskItem [] CompiledResourceFlatFiles => files.ToArray ();
38+
3239
public override System.Threading.Tasks.Task RunTaskAsync ()
3340
{
3441
LoadResourceCaseMap ();
3542

36-
return this.WhenAllWithLock (ResourceDirectories, ProcessDirectory);
43+
return this.WhenAllWithLock (ResourcesToCompile ?? ResourceDirectories, ProcessDirectory);
3744
}
3845

39-
void ProcessDirectory (ITaskItem resourceDirectory, object lockObject)
46+
void ProcessDirectory (ITaskItem item, object lockObject)
4047
{
41-
if (!Directory.EnumerateDirectories (resourceDirectory.ItemSpec).Any ())
48+
FileAttributes fa = File.GetAttributes (item.ItemSpec);
49+
bool isDirectory = (fa & FileAttributes.Directory) == FileAttributes.Directory;
50+
if (isDirectory && !Directory.EnumerateDirectories (item.ItemSpec).Any ())
4251
return;
4352

4453
var output = new List<OutputLine> ();
45-
var hash = resourceDirectory.GetMetadata ("Hash");
46-
var filename = !string.IsNullOrEmpty (hash) ? hash : "compiled";
47-
var outputArchive = Path.Combine (FlatArchivesDirectory, $"{filename}.flata");
48-
var success = RunAapt (GenerateCommandLineCommands (resourceDirectory, outputArchive), output);
49-
if (success && File.Exists (Path.Combine (WorkingDirectory, outputArchive))) {
54+
var outputArchive = GetFullPath (FlatFilesDirectory);
55+
if (isDirectory) {
56+
var hash = item.GetMetadata ("Hash");
57+
var filename = !string.IsNullOrEmpty (hash) ? hash : "compiled";
58+
outputArchive = Path.Combine (FlatArchivesDirectory, $"{filename}.flata");
59+
}
60+
var success = RunAapt (GenerateCommandLineCommands (item, isDirectory, outputArchive), output);
61+
if (!isDirectory)
62+
outputArchive = Path.Combine (FlatFilesDirectory, $"{item.GetMetadata ("_FlatFile")}");
63+
if (success && File.Exists (outputArchive)) {
5064
lock (lockObject)
5165
archives.Add (new TaskItem (outputArchive));
5266
}
@@ -56,21 +70,28 @@ void ProcessDirectory (ITaskItem resourceDirectory, object lockObject)
5670
}
5771
}
5872

59-
protected string GenerateCommandLineCommands (ITaskItem dir, string outputArchive)
73+
protected string[] GenerateCommandLineCommands (ITaskItem item, bool isDirectory, string outputArchive)
6074
{
61-
var cmd = new CommandLineBuilder ();
62-
cmd.AppendSwitch ("compile");
63-
cmd.AppendSwitchIfNotNull ("-o ", outputArchive);
64-
if (!string.IsNullOrEmpty (ResourceSymbolsTextFile))
65-
cmd.AppendSwitchIfNotNull ("--output-text-symbols ", ResourceSymbolsTextFile);
66-
cmd.AppendSwitchIfNotNull ("--dir ", dir.ItemSpec.TrimEnd ('\\'));
75+
List<string> cmd = new List<string> ();
76+
cmd.Add ("compile");
77+
cmd.Add ($"-o");
78+
cmd.Add (GetFullPath (outputArchive));
79+
if (!string.IsNullOrEmpty (ResourceSymbolsTextFile)) {
80+
cmd.Add ($"--output-text-symbols");
81+
cmd.Add (GetFullPath (ResourceSymbolsTextFile));
82+
}
83+
if (isDirectory) {
84+
cmd.Add ("--dir");
85+
cmd.Add (GetFullPath (item.ItemSpec).TrimEnd ('\\'));
86+
} else
87+
cmd.Add (GetFullPath (item.ItemSpec));
6788
if (ExplicitCrunch)
68-
cmd.AppendSwitch ("--no-crunch");
89+
cmd.Add ("--no-crunch");
6990
if (!string.IsNullOrEmpty (ExtraArgs))
70-
cmd.AppendSwitch (ExtraArgs);
91+
cmd.Add (ExtraArgs);
7192
if (MonoAndroidHelper.LogInternalExceptions)
72-
cmd.AppendSwitch ("-v");
73-
return cmd.ToString ();
93+
cmd.Add ("-v");
94+
return cmd.ToArray ();
7495
}
7596

7697
}

0 commit comments

Comments
 (0)