Merge pull request #2086 from ericstj/resourceEnum

Add support for generating resource IDs as an enum
dotnet · Jul 4, 2018 · 70f7153 · 70f7153
2 parents 94f18eb + 3bf98ea
commit 70f7153
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 8 deletions.
diff --git a/src/Microsoft.DotNet.Build.Tasks/GenerateResourcesCode.cs b/src/Microsoft.DotNet.Build.Tasks/GenerateResourcesCode.cs
@@ -57,8 +57,18 @@ public class GenerateResourcesCode : BuildTask
         /// </summary>
         public bool AsConstants { get; set; }
 
+        /// <summary>
+        /// Emit enum of Resource IDs instead of a class with properties that retrieve values.
+        /// </summary>
+        public bool AsEnum { get; set; }
+
         public override bool Execute()
         {
+            if (AsConstants && AsEnum)
+            {
+                Log.LogError($"{nameof(AsConstants)} and {nameof(AsEnum)} cannot both be set to true.");
+            }
+
             try
             {
                 _resourcesName = "FxResources." + AssemblyName;
@@ -136,12 +146,14 @@ private void WriteResources()
             var accessorNamespace = String.IsNullOrEmpty(ResourcesNamespace) ? _srNamespace : ResourcesNamespace;
             var accessorClassName = String.IsNullOrEmpty(ResourcesClassName) ? _srClassName : ResourcesClassName;
 
+
             if (_targetLanguage == TargetLanguage.CSharp)
             {
                 _targetStream.WriteLine($"namespace {accessorNamespace}");
                 _targetStream.WriteLine("{");
                 _targetStream.WriteLine("");
-                _targetStream.WriteLine($"    internal static partial class {accessorClassName}");
+                var accessor = AsEnum ? "enum" : "static partial class";
+                _targetStream.WriteLine($"    internal {accessor} {accessorClassName}");
                 _targetStream.WriteLine("    {");
                 _targetStream.WriteLine("");
 
@@ -150,7 +162,8 @@ private void WriteResources()
             {
                 _targetStream.WriteLine($"Namespace {accessorNamespace}");
                 _targetStream.WriteLine("");
-                _targetStream.WriteLine($"    Friend Partial Class {accessorClassName}");
+                var accessor = AsEnum ? "Enum" : "Partial Class";
+                _targetStream.WriteLine($"    Friend {accessor} {accessorClassName}");
                 _targetStream.WriteLine("");
             }
 
@@ -161,6 +174,22 @@ private void WriteResources()
                     WriteResourceConstant((string)resourcePair.Key);
                 }
             }
+            else if (AsEnum)
+            {
+                foreach(var resourcePair in resources)
+                {
+                    _targetStream.Write($"        {resourcePair.Key}");
+                    if (_targetLanguage == TargetLanguage.CSharp)
+                    {
+                        _targetStream.WriteLine(",");
+                    }
+                    else
+                    {
+                        _targetStream.WriteLine();
+                    }
+                }
+
+            }
             else
             {
                 _targetStream.WriteLine(_targetLanguage == TargetLanguage.CSharp ?
@@ -196,7 +225,8 @@ private void WriteResources()
             }
             else
             {
-                _targetStream.WriteLine("    End Class");
+                var accessor = AsEnum ? "Enum" : "Partial Class";
+                _targetStream.WriteLine($"    End {accessor}");
                 _targetStream.WriteLine("End Namespace");
             }
         }
@@ -258,22 +288,25 @@ private enum TargetLanguage
             CSharp, VB
         }
 
-        internal Dictionary<string, string> GetResources(string fileName)
+        internal List<KeyValuePair<string, string>> GetResources(string fileName)
         {
-            Dictionary<string, string> resources = new Dictionary<string, string>();
+            // preserve the ordering of the resources
+            List<KeyValuePair<string, string>> resources = new List<KeyValuePair<string, string>>();
+            HashSet<string> resourceIds = new HashSet<string>();
 
             XDocument doc = XDocument.Load(fileName, LoadOptions.PreserveWhitespace);
             foreach (XElement dataElem in doc.Element("root").Elements("data"))
             {
                 string name = dataElem.Attribute("name").Value;
                 string value = dataElem.Element("value").Value;
-                if (resources.ContainsKey(name))
+                if (resourceIds.Contains(name))
                 {
                     Log.LogError($"Duplicate resource id \"{name}\"");
                 }
                 else
                 {
-                    resources[name] = value;
+                    resourceIds.Add(name);
+                    resources.Add(new KeyValuePair<string, string>(name, value));
                 }
             }
 

diff --git a/src/Microsoft.DotNet.Build.Tasks/PackageFiles/resources.targets b/src/Microsoft.DotNet.Build.Tasks/PackageFiles/resources.targets
@@ -105,7 +105,8 @@
         SRClassName="$(GenerateResourcesSRClassName)"
         ResourcesNamespace="$(GenerateResourcesResourcesNamespace)"
         ResourcesClassName="$(GenerateResourcesResourcesClassName)"
-        AsConstants="$(GenerateResourcesCodeAsConstants)">
+        AsConstants="$(GenerateResourcesCodeAsConstants)"
+        AsEnum="$(GenerateResourcesCodeAsEnum)">
     </GenerateResourcesCode>
 
     <ItemGroup>