Skip to content

Commit 1878e43

Browse files
moljacmoljac
authored
[Xamarin.Android.Tools.AndroidSdk] Error & Warning Localization (#96)
Context: https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1009374/ Context: dotnet/android@0342fe5 Localize error and warning messages produced by `Xamarin.Android.Tools.AndroidSdk.dll`. We will be following the [.NET Resource Localization pattern][0] and generating satellite assemblies using [`.resx` files][1], in particular `src/Xamarin.Android.Tools.AndroidSdk/Properties/Resources.resx`. `Resources.resx` is an XML file, and will contain `/root/data` elements in which `//data/@name` will be a semantically meaningful shorthand for the actual error message, followed by a `_`-separated list of "parameter names" for the message, if the message has any format string placeholders. The `//data/value` will be the error or warning message: <root> <data name="InvalidMonodroidConfigFile_path_message" xml:space="preserve"> <value>An exception occurred while reading configuration file '{0}'. Exception: {1}</value> <comment> {0} - The path of the file being read. {1} - The exception message of the associated exception. </comment> </data> </root> An optional `//data/comment` element may be provided to describe the meaning within the `//data/value` element to translators. When using Visual Studio or Visual Studio for Mac, changes to `Resrouces.resx` will cause `Resources.Designer.cs` to be updated: namespace Xamarin.Android.Tools.AndroidSdk.Properties { internal partial class Resources { internal static string InvalidMonodroidConfigFile_path_message { get => … } } } The `Resources` members should be used to obtain all strings for use in `logger()` calls: logger (TraceLevel.Error, string.Format (Resources.InvalidMonodroidConfigFile_path_message, file, ex.Message)); When an MSBuild error or warning code is used with more than one output string, then a semantically meaningful suffix should be used to distinguish between the two. Note that this infrastructure does not interoperate with C#6 string interpolation. Any error or warning messages currently using C#6 string interpolation will need to use .NET 1.0-style format strings. Our translation team doesn't work directly with `.resx` files. Instead, the translation team works with [XLIFF files][2]. `Resources.resx` is converted into a set of `src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.*.xlf` files via `XliffTasks.targets` from the [dotnet/xliff-tasks][3] repo. The `Resources.*.xlf` files should be automatically updated whenever `Resources.resx` is updated. [0]: https://docs.microsoft.com/dotnet/framework/resources/index [1]: https://docs.microsoft.com/dotnet/framework/resources/creating-resource-files-for-desktop-apps#resources-in-resx-files [2]: http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html [3]: https://github.com/dotnet/xliff-tasks
1 parent f2af06f commit 1878e43

22 files changed

+539
-4
lines changed

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.Designer.cs eol=crlf
2+
*.resx text
3+
*.xlf text

‎azure-pipelines.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ jobs:
3131
displayName: 'NuGet Restore'
3232
inputs:
3333
restoreSolution: Xamarin.Android.Tools.sln
34+
feedsToUse: config
35+
nugetConfigPath: NuGet.config
3436
- task: MSBuild@1
3537
displayName: 'Build solution Xamarin.Android.Tools.sln'
3638
inputs:

‎src/Xamarin.Android.Tools.AndroidSdk/JdkInfo.cs‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
using System.Xml;
1212
using System.Xml.Linq;
1313

14+
using Xamarin.Android.Tools.AndroidSdk.Properties;
15+
1416
namespace Xamarin.Android.Tools
1517
{
1618
public class JdkInfo {
@@ -341,7 +343,7 @@ static IEnumerable<string> GetMacOSMicrosoftJdkPaths ()
341343
jdk = new JdkInfo (path, locator);
342344
}
343345
catch (Exception e) {
344-
logger (TraceLevel.Warning, $"The directory `{path}`, via locator `{locator}`, is not a valid JDK directory: {e.Message}");
346+
logger (TraceLevel.Warning, string.Format (Resources.InvalidJdkDirectory_path_locator_message, path, locator, e.Message));
345347
logger (TraceLevel.Verbose, e.ToString ());
346348
}
347349
return jdk;

‎src/Xamarin.Android.Tools.AndroidSdk/ProcessUtils.cs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,11 @@ public static Task<TResult> ExecuteToolAsync<TResult> (string exe, Func<string,
123123
tcs.TrySetResult (result != null ? result (output) : default (TResult)!);
124124
} else {
125125
var errorMessage = !string.IsNullOrEmpty (errorOutput) ? errorOutput : output;
126+
errorMessage = string.IsNullOrEmpty (errorMessage)
127+
? $"`{exeName}` returned non-zero exit code"
128+
: $"{t.Result} : {errorMessage}";
126129

127-
tcs.TrySetException (new InvalidOperationException (string.IsNullOrEmpty (errorMessage) ? exeName + " returned non-zero exit code" : string.Format ("{0} : {1}", t.Result, errorMessage)));
130+
tcs.TrySetException (new InvalidOperationException (errorMessage));
128131
}
129132
}, TaskContinuationOptions.ExecuteSynchronously);
130133

‎src/Xamarin.Android.Tools.AndroidSdk/Properties/Resources.Designer.cs‎

Lines changed: 81 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Xamarin.Android.Tools.AndroidSdk/Properties/Resources.resx‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="InvalidJdkDirectory_path_locator_message" xml:space="preserve">
121+
<value>An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</value>
122+
<comment>
123+
{0} - The path of the invalid installation
124+
{1} - a "contextual" name for where {0} came from: `Preferred Registry` (Windows Registry), `OpenJDK`, `$JAVA_HOME` (environment variable), etc.
125+
{2} - The exception message of the associated exception.</comment>
126+
</data>
127+
<data name="InvalidMonodroidConfigFile_path_message" xml:space="preserve">
128+
<value>An exception occurred while reading configuration file '{0}'. Exception: {1}</value>
129+
<comment>
130+
{0} - The path of the file being read.
131+
{1} - The exception message of the associated exception.</comment>
132+
</data>
133+
</root>

‎src/Xamarin.Android.Tools.AndroidSdk/Properties/xlf/Resources.cs.xlf‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="cs" original="../Resources.resx">
4+
<body>
5+
<trans-unit id="InvalidJdkDirectory_path_locator_message">
6+
<source>An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</source>
7+
<target state="new">An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</target>
8+
<note>
9+
{0} - The path of the invalid installation
10+
{1} - a "contextual" name for where {0} came from: `Preferred Registry` (Windows Registry), `OpenJDK`, `$JAVA_HOME` (environment variable), etc.
11+
{2} - The exception message of the associated exception.</note>
12+
</trans-unit>
13+
<trans-unit id="InvalidMonodroidConfigFile_path_message">
14+
<source>An exception occurred while reading configuration file '{0}'. Exception: {1}</source>
15+
<target state="new">An exception occurred while reading configuration file '{0}'. Exception: {1}</target>
16+
<note>
17+
{0} - The path of the file being read.
18+
{1} - The exception message of the associated exception.</note>
19+
</trans-unit>
20+
</body>
21+
</file>
22+
</xliff>

‎src/Xamarin.Android.Tools.AndroidSdk/Properties/xlf/Resources.de.xlf‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="de" original="../Resources.resx">
4+
<body>
5+
<trans-unit id="InvalidJdkDirectory_path_locator_message">
6+
<source>An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</source>
7+
<target state="new">An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</target>
8+
<note>
9+
{0} - The path of the invalid installation
10+
{1} - a "contextual" name for where {0} came from: `Preferred Registry` (Windows Registry), `OpenJDK`, `$JAVA_HOME` (environment variable), etc.
11+
{2} - The exception message of the associated exception.</note>
12+
</trans-unit>
13+
<trans-unit id="InvalidMonodroidConfigFile_path_message">
14+
<source>An exception occurred while reading configuration file '{0}'. Exception: {1}</source>
15+
<target state="new">An exception occurred while reading configuration file '{0}'. Exception: {1}</target>
16+
<note>
17+
{0} - The path of the file being read.
18+
{1} - The exception message of the associated exception.</note>
19+
</trans-unit>
20+
</body>
21+
</file>
22+
</xliff>

‎src/Xamarin.Android.Tools.AndroidSdk/Properties/xlf/Resources.es.xlf‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="es" original="../Resources.resx">
4+
<body>
5+
<trans-unit id="InvalidJdkDirectory_path_locator_message">
6+
<source>An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</source>
7+
<target state="new">An exception occurred while validating the Java SDK installation in '{0}' that was found while searching the paths from '{1}'. Ensure that the Android section of the Visual Studio options has a valid Java SDK directory configured. To use a custom SDK path for a command line build, set the 'JavaSdkDirectory' MSBuild property to the custom path. Exception: {2}</target>
8+
<note>
9+
{0} - The path of the invalid installation
10+
{1} - a "contextual" name for where {0} came from: `Preferred Registry` (Windows Registry), `OpenJDK`, `$JAVA_HOME` (environment variable), etc.
11+
{2} - The exception message of the associated exception.</note>
12+
</trans-unit>
13+
<trans-unit id="InvalidMonodroidConfigFile_path_message">
14+
<source>An exception occurred while reading configuration file '{0}'. Exception: {1}</source>
15+
<target state="new">An exception occurred while reading configuration file '{0}'. Exception: {1}</target>
16+
<note>
17+
{0} - The path of the file being read.
18+
{1} - The exception message of the associated exception.</note>
19+
</trans-unit>
20+
</body>
21+
</file>
22+
</xliff>

0 commit comments

Comments
 (0)