housekeeping: tidying of build warnings in event builder (#1826)

Author: olevett

src/EventBuilder/AutoPlatform.cs

@@ -15,10 +15,12 @@ public enum AutoPlatform
         /// </summary>
         Android,
 
+#pragma warning disable SA1300 // Element should begin with upper-case letter
         /// <summary>
         /// iOS platform.
         /// </summary>
         iOS,
+#pragma warning restore SA1300 // Element should begin with upper-case letter
 
         /// <summary>
         /// Mac platform.
@@ -60,4 +62,4 @@ public enum AutoPlatform
         /// </summary>
         Essentials
     }
-}
+}

src/EventBuilder/Cecil/DelegateTemplateInformation.cs

@@ -1,8 +1,9 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
 using System;
+using System.Globalization;
 using System.Linq;
 using EventBuilder.Entities;
 using Mono.Cecil;
@@ -69,7 +70,11 @@ public static NamespaceInfo[] Create(AssemblyDefinition[] targetAssemblies)
                                     string.Join(
                                         ", ",
                                         z.Parameters.Select(
-                                            a => string.Format("{0} {1}", a.ParameterType.FullName, a.Name))),
+                                            a => string.Format(
+                                                CultureInfo.InvariantCulture,
+                                                "{0} {1}",
+                                                a.ParameterType.FullName,
+                                                a.Name))),
                                 ParameterTypeList =
                                     string.Join(", ", z.Parameters.Select(a => a.ParameterType.FullName)),
                                 ParameterNameList = string.Join(", ", z.Parameters.Select(a => a.Name))

src/EventBuilder/Cecil/EventTemplateInformation.cs

@@ -1,8 +1,10 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using EventBuilder.Entities;
 using Mono.Cecil;
@@ -35,6 +37,86 @@ public static class EventTemplateInformation
             { "Tizen.NUI.EventHandlerWithReturnType`3", "Tizen.NUI.EventHandlerWithReturnType" },
         };
 
+        /// <summary>
+        /// Creates namespace information from the specified target assemblies.
+        /// </summary>
+        /// <param name="targetAssemblies">The target assemblies.</param>
+        /// <returns>The namespaces in the target assemblies.</returns>
+        public static NamespaceInfo[] Create(AssemblyDefinition[] targetAssemblies)
+        {
+            var publicTypesWithEvents = targetAssemblies
+                .SelectMany(SafeTypes.GetSafeTypes)
+                .Where(x => x.IsPublic && !x.HasGenericParameters)
+                .Select(x => new { Type = x, Events = GetPublicEvents(x) })
+                .Where(x => x.Events.Length > 0)
+                .ToArray();
+
+            var garbageNamespaceList = new[]
+            {
+                "Windows.UI.Xaml.Data",
+                "Windows.UI.Xaml.Interop",
+                "Windows.UI.Xaml.Input",
+                "MonoTouch.AudioToolbox",
+                "MonoMac.AudioToolbox",
+                "ReactiveUI.Events",
+
+                // Winforms
+                "System.Collections.Specialized",
+                "System.Configuration",
+                "System.ComponentModel.Design",
+                "System.ComponentModel.Design.Serialization",
+                "System.CodeDom",
+                "System.Data.SqlClient",
+                "System.Data.OleDb",
+                "System.Data.Odbc",
+                "System.Data.Common",
+                "System.Drawing.Design",
+                "System.Media",
+                "System.Net",
+                "System.Net.Mail",
+                "System.Net.NetworkInformation",
+                "System.Net.Sockets",
+                "System.ServiceProcess.Design",
+                "System.Windows.Input",
+                "System.Windows.Forms.ComponentModel.Com2Interop",
+                "System.Windows.Forms.Design",
+                "System.Timers"
+            };
+
+            var namespaceData = publicTypesWithEvents
+                .GroupBy(x => x.Type.Namespace)
+                .Where(x => !garbageNamespaceList.Contains(x.Key))
+                .Select(x => new NamespaceInfo
+                {
+                    Name = x.Key,
+                    Types = x.Select(y => new PublicTypeInfo
+                    {
+                        Name = y.Type.Name,
+                        Type = y.Type,
+                        Events = y.Events.Select(z => new PublicEventInfo
+                        {
+                            Name = z.Name,
+                            EventHandlerType = GetRealTypeName(z.EventType),
+                            EventArgsType = GetEventArgsTypeForEvent(z),
+                            ObsoleteEventInfo = GetObsoleteInfo(z)
+                        }).ToArray()
+                    }).ToArray()
+                }).ToArray();
+
+            foreach (var type in namespaceData.SelectMany(x => x.Types))
+            {
+                var parentWithEvents = GetParents(type.Type).FirstOrDefault(x => GetPublicEvents(x).Any());
+                if (parentWithEvents == null)
+                {
+                    continue;
+                }
+
+                type.Parent = new ParentInfo { Name = parentWithEvents.FullName };
+            }
+
+            return namespaceData;
+        }
+
         private static string RenameBogusTypes(string typeName)
         {
             if (SubstitutionList.ContainsKey(typeName))
@@ -88,6 +170,7 @@ private static string GetRealTypeName(TypeDefinition t)
             }
 
             var ret = string.Format(
+                CultureInfo.InvariantCulture,
                 "{0}<{1}>",
                 RenameBogusTypes(t.Namespace + "." + t.Name),
                 string.Join(",", t.GenericParameters.Select(x => GetRealTypeName(x.Resolve()))));
@@ -105,6 +188,7 @@ private static string GetRealTypeName(TypeReference t)
             }
 
             var ret = string.Format(
+                CultureInfo.InvariantCulture,
                 "{0}<{1}>",
                 RenameBogusTypes(generic.Namespace + "." + generic.Name),
                 string.Join(",", generic.GenericArguments.Select(GetRealTypeName)));
@@ -123,7 +207,8 @@ private static string GetRealTypeName(TypeReference t)
 
         private static ObsoleteEventInfo GetObsoleteInfo(EventDefinition ei)
         {
-            var obsoleteAttribute = ei.CustomAttributes.FirstOrDefault(attr => attr.AttributeType.FullName.Equals("System.ObsoleteAttribute"));
+            var obsoleteAttribute = ei.CustomAttributes
+                .FirstOrDefault(attr => attr.AttributeType.FullName.Equals("System.ObsoleteAttribute", StringComparison.InvariantCulture));
 
             if (obsoleteAttribute == null)
             {
@@ -144,86 +229,6 @@ private static EventDefinition[] GetPublicEvents(TypeDefinition t)
                     .ToArray();
         }
 
-        /// <summary>
-        /// Creates namespace information from the specified target assemblies.
-        /// </summary>
-        /// <param name="targetAssemblies">The target assemblies.</param>
-        /// <returns>The namespaces in the target assemblies.</returns>
-        public static NamespaceInfo[] Create(AssemblyDefinition[] targetAssemblies)
-        {
-            var publicTypesWithEvents = targetAssemblies
-                .SelectMany(SafeTypes.GetSafeTypes)
-                .Where(x => x.IsPublic && !x.HasGenericParameters)
-                .Select(x => new { Type = x, Events = GetPublicEvents(x) })
-                .Where(x => x.Events.Length > 0)
-                .ToArray();
-
-            var garbageNamespaceList = new[]
-            {
-                "Windows.UI.Xaml.Data",
-                "Windows.UI.Xaml.Interop",
-                "Windows.UI.Xaml.Input",
-                "MonoTouch.AudioToolbox",
-                "MonoMac.AudioToolbox",
-                "ReactiveUI.Events",
-
-                // Winforms
-                "System.Collections.Specialized",
-                "System.Configuration",
-                "System.ComponentModel.Design",
-                "System.ComponentModel.Design.Serialization",
-                "System.CodeDom",
-                "System.Data.SqlClient",
-                "System.Data.OleDb",
-                "System.Data.Odbc",
-                "System.Data.Common",
-                "System.Drawing.Design",
-                "System.Media",
-                "System.Net",
-                "System.Net.Mail",
-                "System.Net.NetworkInformation",
-                "System.Net.Sockets",
-                "System.ServiceProcess.Design",
-                "System.Windows.Input",
-                "System.Windows.Forms.ComponentModel.Com2Interop",
-                "System.Windows.Forms.Design",
-                "System.Timers"
-            };
-
-            var namespaceData = publicTypesWithEvents
-                .GroupBy(x => x.Type.Namespace)
-                .Where(x => !garbageNamespaceList.Contains(x.Key))
-                .Select(x => new NamespaceInfo
-                {
-                    Name = x.Key,
-                    Types = x.Select(y => new PublicTypeInfo
-                    {
-                        Name = y.Type.Name,
-                        Type = y.Type,
-                        Events = y.Events.Select(z => new PublicEventInfo
-                        {
-                            Name = z.Name,
-                            EventHandlerType = GetRealTypeName(z.EventType),
-                            EventArgsType = GetEventArgsTypeForEvent(z),
-                            ObsoleteEventInfo = GetObsoleteInfo(z)
-                        }).ToArray()
-                    }).ToArray()
-                }).ToArray();
-
-            foreach (var type in namespaceData.SelectMany(x => x.Types))
-            {
-                var parentWithEvents = GetParents(type.Type).FirstOrDefault(x => GetPublicEvents(x).Any());
-                if (parentWithEvents == null)
-                {
-                    continue;
-                }
-
-                type.Parent = new ParentInfo { Name = parentWithEvents.FullName };
-            }
-
-            return namespaceData;
-        }
-
         private static IEnumerable<TypeDefinition> GetParents(TypeDefinition type)
         {
             var current = type.BaseType != null

src/EventBuilder/Cecil/StaticEventTemplateInformation.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using EventBuilder.Entities;
 using Mono.Cecil;
@@ -116,6 +117,7 @@ private static string GetRealTypeName(TypeDefinition t)
             }
 
             var ret = string.Format(
+                CultureInfo.InvariantCulture,
                 "{0}<{1}>",
                 t.Namespace + "." + t.Name,
                 string.Join(",", t.GenericParameters.Select(x => GetRealTypeName(x.Resolve()))));
@@ -133,6 +135,7 @@ private static string GetRealTypeName(TypeReference t)
             }
 
             var ret = string.Format(
+                CultureInfo.InvariantCulture,
                 "{0}<{1}>",
                 generic.Namespace + "." + generic.Name,
                 string.Join(",", generic.GenericArguments.Select(GetRealTypeName)));

src/EventBuilder/CommandLineOptions.cs

@@ -42,7 +42,9 @@ public class CommandLineOptions
         /// Manual generation using the specified assemblies. Use with --platform=NONE.
         /// </summary>
         [ValueList(typeof(List<string>))]
+#pragma warning disable CA2227 // Collection properties should be read only
         public List<string> Assemblies { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
 
         /// <summary>
         /// Gets the usage.

src/EventBuilder/Entities/PublicTypeInfo.cs

@@ -50,6 +50,6 @@ public class PublicTypeInfo
         /// <summary>
         /// Gets or sets the multi parameter methods.
         /// </summary>
-        public MultiParameterMethod[] MultiParameterMethods { get; set; }
+        public IEnumerable<MultiParameterMethod> MultiParameterMethods { get; set; }
     }
 }

src/EventBuilder/ExitCode.cs

@@ -0,0 +1,22 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+namespace EventBuilder
+{
+    /// <summary>
+    ///     The exit/return code (aka %ERRORLEVEL%) on application exit.
+    /// </summary>
+    public enum ExitCode
+    {
+        /// <summary>
+        /// Success
+        /// </summary>
+        Success = 0,
+
+        /// <summary>
+        /// Error
+        /// </summary>
+        Error = 1,
+    }
+}

src/EventBuilder/Platforms/Android.cs

@@ -37,7 +37,6 @@ public Android(string referenceAssembliesLocation)
             }
             else
             {
-
                 var assemblies =
                    Directory.GetFiles(
                        Path.Combine(referenceAssembliesLocation, "MonoAndroid"),

src/EventBuilder/Platforms/BasePlatform.cs

@@ -25,9 +25,9 @@ protected BasePlatform()
         public abstract AutoPlatform Platform { get; }
 
         /// <inheritdoc />
-        public List<string> Assemblies { get; set; }
+        public List<string> Assemblies { get; }
 
         /// <inheritdoc />
-        public List<string> CecilSearchDirectories { get; set; }
+        public List<string> CecilSearchDirectories { get; }
     }
 }

src/EventBuilder/Platforms/IPlatform.cs

@@ -19,12 +19,12 @@ public interface IPlatform
         /// <summary>
         /// Gets or sets the assemblies.
         /// </summary>
-        List<string> Assemblies { get; set; }
+        List<string> Assemblies { get; }
 
         /// <summary>
         /// Gets or sets the cecil search directories.
         /// Cecil when run on Mono needs some direction as to the location of the platform specific MSCORLIB.
         /// </summary>
-        List<string> CecilSearchDirectories { get; set; }
+        List<string> CecilSearchDirectories { get; }
     }
 }