Skip to content

Turn on single-file analyzer and fix problems #5426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agocke merged 3 commits into from
Aug 16, 2021
+25 −23
Merged

Turn on single-file analyzer and fix problems #5426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c032e9a
Add single-file analyzer and fix warnings
agocke Aug 14, 2021
76274fb
Apply suggestions from code review
agocke Aug 16, 2021
f72a5c2
Remove attribute
agocke Aug 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Directory.Build.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
<CoverletOutput>$(TargetDir)coverage\$(MSBuildProjectName).coverage</CoverletOutput>
</PropertyGroup>

<!-- Turn on single-file publishing analysis for everything except the test projects -->
<PropertyGroup Condition="'$(IsTestProject)' != 'true'">
<EnableSingleFileAnalyzer>true</EnableSingleFileAnalyzer>
</PropertyGroup>

<PropertyGroup Condition="'$(IsTestProject)' == 'true' ">
<TargetArchitecture Condition="'$(TargetArchitecture)' == ''">x64</TargetArchitecture>
<Platform Condition="'$(Platform)' == 'AnyCPU' or '$(Platform)' == 'Any CPU'">$(TargetArchitecture)</Platform>
Expand Down Expand Up @@ -52,7 +57,7 @@

<ItemGroup>
<!-- Set TargetingPackVersion -->
<FrameworkReference Update="Microsoft.NETCore.App"
<FrameworkReference Update="Microsoft.NETCore.App"
Condition=" '$(VSRedistCommonNetCoreSharedFrameworkx6460PackageVersion)'!='' And $(TargetFramework.StartsWith('net6.')) ">
<TargetingPackVersion>$(VSRedistCommonNetCoreSharedFrameworkx6460PackageVersion)</TargetingPackVersion>
</FrameworkReference>
Expand Down
2 changes: 2 additions & 0 deletions src/System.Windows.Forms.Design/src/System/Drawing/Design/ToolboxItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using System.Runtime.Serialization;
using System.Windows.Forms;
Expand Down Expand Up @@ -556,6 +557,7 @@ public Type GetType(IDesignerHost host)
/// locate the type. If reference is true, the given assembly name will be added
/// to the designer host's set of references.
/// </summary>
[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Single-file case is handled")]
protected virtual Type GetType(IDesignerHost host, AssemblyName assemblyName, string typeName, bool reference)
{
ITypeResolutionService ts = null;
Expand Down
3 changes: 3 additions & 0 deletions src/System.Windows.Forms/src/System/Resources/AssemblyNamesTypeResolutionService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

using System.Collections;
using System.ComponentModel.Design;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;

namespace System.Resources
Expand All @@ -29,6 +30,7 @@ public Assembly GetAssembly(AssemblyName name)
return GetAssembly(name, true);
}

[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Handles single file case")]
public Assembly GetAssembly(AssemblyName name, bool throwOnError)
{
Assembly result = null;
Expand Down Expand Up @@ -76,6 +78,7 @@ public Assembly GetAssembly(AssemblyName name, bool throwOnError)
return result;
}

[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Returns null if in a single file")]
public string GetPathOfAssembly(AssemblyName name)
{
return name.CodeBase;
Expand Down
23 changes: 4 additions & 19 deletions src/System.Windows.Forms/src/System/Windows/Forms/Application.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

using System.ComponentModel;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Drawing;
using System.Globalization;
using System.Reflection;
Expand Down Expand Up @@ -55,9 +56,6 @@ public sealed partial class Application
private static readonly object s_eventApplicationExit = new object();
private static readonly object s_eventThreadExit = new object();

// Constant string used in Application.Restart()
private const string IEEXEC = "ieexec.exe";

// Defines a new callback delegate type
[EditorBrowsable(EditorBrowsableState.Advanced)]
public delegate bool MessageLoopCallback();
Expand Down Expand Up @@ -819,6 +817,7 @@ internal static void DoEventsModal()
/// Enables visual styles for all subsequent <see cref="Run()"/> and <see cref="Control.CreateHandle"/> calls.
/// Uses the default theming manifest file shipped with the redist.
/// </summary>
[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Single-file case is handled")]
public static void EnableVisualStyles()
{
// Pull manifest from our resources
Expand Down Expand Up @@ -951,14 +950,15 @@ internal static void FormActivated(bool modal, bool activated)
/// Retrieves the FileVersionInfo associated with the main module for
/// the application.
/// </summary>
[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Single-file case is handled")]
private static FileVersionInfo GetAppFileVersionInfo()
{
lock (s_internalSyncObject)
{
if (s_appFileVersion is null)
{
Type t = GetAppMainType();
if (t is not null)
if (t is not null && t.Assembly.Location.Length > 0)
Copy link
Copy Markdown
Member

@dreddy-work dreddy-work Aug 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What made to add this second condition here?

Copy link
Copy Markdown
Member Author

@agocke agocke Aug 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is in a single-file, t.Module.FullyQualifiedName will return <Unknown> and GetVersionInfo will fail. ExecutablePath should be single-file safe, however.

{
s_appFileVersion = FileVersionInfo.GetVersionInfo(t.Module.FullyQualifiedName);
}
Expand Down Expand Up @@ -1140,21 +1140,6 @@ public static void Restart()

Process process = Process.GetCurrentProcess();
Debug.Assert(process is not null);
if (string.Equals(process.MainModule.ModuleName, IEEXEC, StringComparison.OrdinalIgnoreCase))
{
string clrPath = Path.GetDirectoryName(typeof(object).Module.FullyQualifiedName);

if (string.Equals(clrPath + "\\" + IEEXEC, process.MainModule.FileName, StringComparison.OrdinalIgnoreCase))
{
// HRef exe case
hrefExeCase = true;
Exit();
if (AppDomain.CurrentDomain.GetData("APP_LAUNCH_URL") is string launchUrl)
{
Process.Start(process.MainModule.FileName, launchUrl);
}
}
}

if (!hrefExeCase)
{
Expand Down
13 changes: 10 additions & 3 deletions src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlVersionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// See the LICENSE file in the project root for more information.

using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;

namespace System.Windows.Forms
Expand All @@ -25,6 +26,7 @@ internal ControlVersionInfo(Control owner)
/// <summary>
/// The company name associated with the component.
/// </summary>
[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Single-file case is handled")]
internal string CompanyName
{
get
Expand All @@ -37,7 +39,7 @@ internal string CompanyName
_companyName = ((AssemblyCompanyAttribute)attrs[0]).Company;
}

if (_companyName is null || _companyName.Length == 0)
if ((_companyName is null || _companyName.Length == 0) && !OwnerIsInMemoryAssembly)
{
_companyName = GetFileVersionInfo().CompanyName;
if (_companyName is not null)
Expand Down Expand Up @@ -74,6 +76,7 @@ internal string CompanyName
/// <summary>
/// The product name associated with this component.
/// </summary>
[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Single-file case is handled")]
internal string ProductName
{
get
Expand All @@ -86,7 +89,7 @@ internal string ProductName
_productName = ((AssemblyProductAttribute)attrs[0]).Product;
}

if (_productName is null || _productName.Length == 0)
if ((_productName is null || _productName.Length == 0) && !OwnerIsInMemoryAssembly)
{
_productName = GetFileVersionInfo().ProductName;
if (_productName is not null)
Expand Down Expand Up @@ -123,6 +126,7 @@ internal string ProductName
/// <summary>
/// The product version associated with this component.
/// </summary>
[UnconditionalSuppressMessage("SingleFile", "IL3002", Justification = "Single-file case is handled")]
internal string ProductVersion
{
get
Expand All @@ -137,7 +141,7 @@ internal string ProductVersion
}

// win32 version info
if (_productVersion is null || _productVersion.Length == 0)
if ((_productVersion is null || _productVersion.Length == 0) && !OwnerIsInMemoryAssembly)
{
_productVersion = GetFileVersionInfo().ProductVersion;
if (_productVersion is not null)
Expand All @@ -161,6 +165,7 @@ internal string ProductVersion
/// Retrieves the FileVersionInfo associated with the main module for
/// the component.
/// </summary>
[RequiresAssemblyFiles("Throws if " + nameof(_owner) + " is an in-memory assembly. Check " + nameof(OwnerIsInMemoryAssembly) + " first")]
private FileVersionInfo GetFileVersionInfo()
{
if (_versionInfo is null)
Expand All @@ -172,6 +177,8 @@ private FileVersionInfo GetFileVersionInfo()

return _versionInfo;
}

private bool OwnerIsInMemoryAssembly => _owner.GetType().Assembly.Location.Length == 0;
}
}
}