Skip to content

Nullable annotation for System.Windows.Extensions #57896

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
merged 12 commits into from
Nov 24, 2021
Merged

Nullable annotation for System.Windows.Extensions #57896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
66e021d
Enable nullable in project file.
huoyaoyuan Aug 22, 2021
00fcf07
Annotate SoundPlayer
huoyaoyuan Aug 22, 2021
52898fd
Annotate remaining types
huoyaoyuan Aug 22, 2021
fabeb33
Update ref source
huoyaoyuan Aug 22, 2021
de15658
Events should be nullable
huoyaoyuan Aug 22, 2021
4e1f870
Fix assertion for NRE
huoyaoyuan Aug 22, 2021
22d98fd
Update nullability of SoundLocation.
huoyaoyuan Aug 25, 2021
599cdce
Adjust nullability of SoundLocation and Stream.
huoyaoyuan Sep 7, 2021
f810312
Title and message should be nullable
huoyaoyuan Sep 7, 2021
8b7d013
Merge branch 'main'
huoyaoyuan Sep 22, 2021
689255c
Fix new NRT issue
huoyaoyuan Sep 23, 2021
9319514
Merge branch 'main'
huoyaoyuan Nov 24, 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
6 changes: 3 additions & 3 deletions src/libraries/Common/src/Interop/Windows/CryptUI/Interop.CryptUIDlgCertificate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal sealed class CRYPTUI_VIEWCERTIFICATE_STRUCTW
internal uint dwSize;
internal IntPtr hwndParent;
internal uint dwFlags;
internal string szTitle;
internal string? szTitle;
internal IntPtr pCertContext;
internal IntPtr rgszPurposes;
internal uint cPurposes;
Expand All @@ -38,9 +38,9 @@ internal sealed class CRYPTUI_SELECTCERTIFICATE_STRUCTW
internal uint dwSize;
internal IntPtr hwndParent;
internal uint dwFlags;
internal string szTitle;
internal string? szTitle;
internal uint dwDontUseColumn;
internal string szDisplayString;
internal string? szDisplayString;
internal IntPtr pFilterCallback;
internal IntPtr pDisplayCallback;
internal IntPtr pvCallbackData;
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/Common/src/Interop/Windows/WinMm/Interop.PlaySound.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ internal static partial class WinMM
internal static partial bool PlaySound(string soundName, IntPtr hmod, int soundFlags);

[GeneratedDllImport(Libraries.WinMM, EntryPoint = "PlaySoundW", ExactSpelling = true)]
internal static partial bool PlaySound(byte[] soundName, IntPtr hmod, int soundFlags);
internal static partial bool PlaySound(byte[]? soundName, IntPtr hmod, int soundFlags);
}
}
18 changes: 9 additions & 9 deletions src/libraries/System.Windows.Extensions/ref/System.Windows.Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ namespace System.Media
public partial class SoundPlayer : System.ComponentModel.Component, System.Runtime.Serialization.ISerializable
{
public SoundPlayer() { }
public SoundPlayer(System.IO.Stream stream) { }
public SoundPlayer(System.IO.Stream? stream) { }
protected SoundPlayer(System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext context) { }
public SoundPlayer(string soundLocation) { }
public bool IsLoadCompleted { get { throw null; } }
public int LoadTimeout { get { throw null; } set { } }
public string SoundLocation { get { throw null; } set { } }
public System.IO.Stream Stream { get { throw null; } set { } }
public object Tag { get { throw null; } set { } }
public event System.ComponentModel.AsyncCompletedEventHandler LoadCompleted { add { } remove { } }
public event System.EventHandler SoundLocationChanged { add { } remove { } }
public event System.EventHandler StreamChanged { add { } remove { } }
public System.IO.Stream? Stream { get { throw null; } set { } }
public object? Tag { get { throw null; } set { } }
public event System.ComponentModel.AsyncCompletedEventHandler? LoadCompleted { add { } remove { } }
public event System.EventHandler? SoundLocationChanged { add { } remove { } }
public event System.EventHandler? StreamChanged { add { } remove { } }
public void Load() { }
public void LoadAsync() { }
protected virtual void OnLoadCompleted(System.ComponentModel.AsyncCompletedEventArgs e) { }
Expand Down Expand Up @@ -53,8 +53,8 @@ public sealed partial class X509Certificate2UI
public X509Certificate2UI() { }
public static void DisplayCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public static void DisplayCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, System.IntPtr hwndParent) { }
public static System.Security.Cryptography.X509Certificates.X509Certificate2Collection SelectFromCollection(System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificates, string title, string message, System.Security.Cryptography.X509Certificates.X509SelectionFlag selectionFlag) { throw null; }
public static System.Security.Cryptography.X509Certificates.X509Certificate2Collection SelectFromCollection(System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificates, string title, string message, System.Security.Cryptography.X509Certificates.X509SelectionFlag selectionFlag, System.IntPtr hwndParent) { throw null; }
public static System.Security.Cryptography.X509Certificates.X509Certificate2Collection SelectFromCollection(System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificates, string? title, string? message, System.Security.Cryptography.X509Certificates.X509SelectionFlag selectionFlag) { throw null; }
public static System.Security.Cryptography.X509Certificates.X509Certificate2Collection SelectFromCollection(System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificates, string? title, string? message, System.Security.Cryptography.X509Certificates.X509SelectionFlag selectionFlag, System.IntPtr hwndParent) { throw null; }
}
public enum X509SelectionFlag
{
Expand All @@ -68,7 +68,7 @@ public partial class XamlAccessLevel
{
internal XamlAccessLevel() { }
public System.Reflection.AssemblyName AssemblyAccessToAssemblyName { get { throw null; } }
public string PrivateAccessToTypeName { get { throw null; } }
public string? PrivateAccessToTypeName { get { throw null; } }
public static System.Xaml.Permissions.XamlAccessLevel AssemblyAccessTo(System.Reflection.Assembly assembly) { throw null; }
public static System.Xaml.Permissions.XamlAccessLevel AssemblyAccessTo(System.Reflection.AssemblyName assemblyName) { throw null; }
public static System.Xaml.Permissions.XamlAccessLevel PrivateAccessTo(string assemblyQualifiedTypeName) { throw null; }
Expand Down
1 change: 1 addition & 0 deletions src/libraries/System.Windows.Extensions/ref/System.Windows.Extensions.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppMinimum)</TargetFrameworks>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<Compile Include="System.Windows.Extensions.cs" />
Expand Down
1 change: 1 addition & 0 deletions src/libraries/System.Windows.Extensions/src/System.Windows.Extensions.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<Nullable>annotations</Nullable>
<TargetFrameworks>$(NetCoreAppCurrent)-windows;$(NetCoreAppCurrent);$(NetCoreAppMinimum)-windows;$(NetCoreAppMinimum)</TargetFrameworks>
<Nullable>enable</Nullable>
<IsPackable>true</IsPackable>
<PackageDescription>Provides miscellaneous Windows-specific types

Expand Down
59 changes: 33 additions & 26 deletions src/libraries/System.Windows.Extensions/src/System/Media/SoundPlayer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System.ComponentModel;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Net;
using System.Runtime.InteropServices;
Expand All @@ -18,7 +19,7 @@ public class SoundPlayer : Component, ISerializable
private const int BlockSize = 1024;
private const int DefaultLoadTimeout = 10000; // 10 secs

private Uri _uri;
private Uri? _uri;
private string _soundLocation = string.Empty;
private int _loadTimeout = DefaultLoadTimeout;

Expand All @@ -28,16 +29,16 @@ public class SoundPlayer : Component, ISerializable
// the worker copyTask
// we start the worker copyTask ONLY from entry points in the SoundPlayer API
// we also set the tread to null only from the entry points in the SoundPlayer API
private Task _copyTask;
private CancellationTokenSource _copyTaskCancellation;
private Task? _copyTask;
private CancellationTokenSource? _copyTaskCancellation;

// local buffer information
private int _currentPos;
private Stream _stream;
private Exception _lastLoadException;
private Stream? _stream;
private Exception? _lastLoadException;
private bool _doesLoadAppearSynchronous;
private byte[] _streamData;
private AsyncOperation _asyncOperation;
private byte[]? _streamData;
private AsyncOperation? _asyncOperation;
private readonly SendOrPostCallback _loadAsyncOperationCompleted;

// event
Expand All @@ -55,7 +56,7 @@ public SoundPlayer(string soundLocation) : this()
SetupSoundLocation(soundLocation ?? string.Empty);
}

public SoundPlayer(Stream stream) : this()
public SoundPlayer(Stream? stream) : this()
{
_stream = stream;
}
Expand Down Expand Up @@ -99,7 +100,7 @@ public string SoundLocation
}
}

public Stream Stream
public Stream? Stream
{
get
{
Expand All @@ -126,7 +127,7 @@ public Stream Stream

public bool IsLoadCompleted { get; private set; }

public object Tag { get; set; }
public object? Tag { get; set; }

public void LoadAsync()
{
Expand Down Expand Up @@ -161,9 +162,9 @@ public void LoadAsync()
LoadStream(false);
}

private void LoadAsyncOperationCompleted(object arg)
private void LoadAsyncOperationCompleted(object? arg)
{
OnLoadCompleted((AsyncCompletedEventArgs)arg);
OnLoadCompleted((AsyncCompletedEventArgs)arg!);
}

// called for loading a stream synchronously
Expand Down Expand Up @@ -227,6 +228,7 @@ private void LoadAndPlay(int flags)
else
{
LoadSync();
Debug.Assert(_streamData != null);
ValidateSoundData(_streamData);
Interop.WinMM.PlaySound(_streamData, IntPtr.Zero, Interop.WinMM.SND_MEMORY | Interop.WinMM.SND_NODEFAULT | flags);
}
Expand Down Expand Up @@ -271,7 +273,9 @@ private void LoadSync()
_stream = webResponse.GetResponseStream();
}

if (_stream.CanSeek)
// DO NOT assert - NRE is expected for null stream
// See SoundPlayerTests.Load_NullStream_ThrowsNullReferenceException
Copy link
Member

Choose a reason for hiding this comment

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

It'd be worth opening an issue for this to decide separately whether we should throw a better exception in that case.

if (_stream!.CanSeek)
{
// if we can get data synchronously, then get it
LoadStream(true);
Expand Down Expand Up @@ -304,6 +308,7 @@ private void LoadSync()

private void LoadStream(bool loadSync)
{
Debug.Assert(_stream != null);
if (loadSync && _stream.CanSeek)
{
int streamLen = (int)_stream.Length;
Expand Down Expand Up @@ -339,9 +344,9 @@ public void PlayLooping()
LoadAndPlay(Interop.WinMM.SND_LOOP | Interop.WinMM.SND_ASYNC);
}

private static Uri ResolveUri(string partialUri)
private static Uri? ResolveUri(string partialUri)
{
Uri result = null;
Uri? result = null;
try
{
result = new Uri(partialUri);
Expand Down Expand Up @@ -399,7 +404,7 @@ private void SetupSoundLocation(string soundLocation)
}
}

private void SetupStream(Stream stream)
private void SetupStream(Stream? stream)
{
if (_copyTask != null)
{
Expand All @@ -420,10 +425,10 @@ private void SetupStream(Stream stream)

public void Stop()
{
Interop.WinMM.PlaySound((byte[])null, IntPtr.Zero, Interop.WinMM.SND_PURGE);
Interop.WinMM.PlaySound((byte[]?)null, IntPtr.Zero, Interop.WinMM.SND_PURGE);
}

public event AsyncCompletedEventHandler LoadCompleted
public event AsyncCompletedEventHandler? LoadCompleted
{
add
{
Expand All @@ -435,7 +440,7 @@ public event AsyncCompletedEventHandler LoadCompleted
}
}

public event EventHandler SoundLocationChanged
public event EventHandler? SoundLocationChanged
{
add
{
Expand All @@ -447,7 +452,7 @@ public event EventHandler SoundLocationChanged
}
}

public event EventHandler StreamChanged
public event EventHandler? StreamChanged
{
add
{
Expand All @@ -461,22 +466,22 @@ public event EventHandler StreamChanged

protected virtual void OnLoadCompleted(AsyncCompletedEventArgs e)
{
((AsyncCompletedEventHandler)Events[s_eventLoadCompleted])?.Invoke(this, e);
((AsyncCompletedEventHandler?)Events[s_eventLoadCompleted])?.Invoke(this, e);
}

protected virtual void OnSoundLocationChanged(EventArgs e)
{
((EventHandler)Events[s_eventSoundLocationChanged])?.Invoke(this, e);
((EventHandler?)Events[s_eventSoundLocationChanged])?.Invoke(this, e);
}

protected virtual void OnStreamChanged(EventArgs e)
{
((EventHandler)Events[s_eventStreamChanged])?.Invoke(this, e);
((EventHandler?)Events[s_eventStreamChanged])?.Invoke(this, e);
}

private async Task CopyStreamAsync(CancellationToken cancellationToken)
{
Exception exception = null;
Exception? exception = null;
try
{
// setup the http stream
Expand All @@ -485,7 +490,7 @@ private async Task CopyStreamAsync(CancellationToken cancellationToken)
#pragma warning disable SYSLIB0014 // WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete. Use HttpClient instead.
WebRequest webRequest = WebRequest.Create(_uri);
#pragma warning restore SYSLIB0014
using (cancellationToken.Register(r => ((WebRequest)r).Abort(), webRequest))
using (cancellationToken.Register(r => ((WebRequest)r!).Abort(), webRequest))
{
WebResponse webResponse = await webRequest.GetResponseAsync().ConfigureAwait(false);
_stream = webResponse.GetResponseStream();
Expand All @@ -494,6 +499,7 @@ private async Task CopyStreamAsync(CancellationToken cancellationToken)

_streamData = new byte[BlockSize];

Debug.Assert(_stream != null);
int readBytes = await _stream.ReadAsync(_streamData.AsMemory(_currentPos, BlockSize), cancellationToken).ConfigureAwait(false);
int totalBytes = readBytes;

Expand Down Expand Up @@ -525,6 +531,7 @@ private async Task CopyStreamAsync(CancellationToken cancellationToken)
AsyncCompletedEventArgs ea = exception is OperationCanceledException ?
new AsyncCompletedEventArgs(null, cancelled: true, null) :
new AsyncCompletedEventArgs(exception, cancelled: false, null);
Debug.Assert(_asyncOperation != null);
_asyncOperation.PostOperationCompleted(_loadAsyncOperationCompleted, ea);
}
}
Expand All @@ -539,7 +546,7 @@ private unsafe void ValidateSoundFile(string fileName)

try
{
Interop.WinMM.WAVEFORMATEX waveFormat = null;
Interop.WinMM.WAVEFORMATEX? waveFormat = null;
var ckRIFF = new Interop.WinMM.MMCKINFO()
{
fccType = mmioFOURCC('W', 'A', 'V', 'E')
Expand Down
10 changes: 5 additions & 5 deletions src/libraries/System.Windows.Extensions/src/System/Media/SystemSounds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ namespace System.Media
{
public static class SystemSounds
{
private static volatile SystemSound s_asterisk;
private static volatile SystemSound s_beep;
private static volatile SystemSound s_exclamation;
private static volatile SystemSound s_hand;
private static volatile SystemSound s_question;
private static volatile SystemSound? s_asterisk;
private static volatile SystemSound? s_beep;
private static volatile SystemSound? s_exclamation;
private static volatile SystemSound? s_hand;
private static volatile SystemSound? s_question;

public static SystemSound Asterisk
{
Expand Down
8 changes: 4 additions & 4 deletions ...indows.Extensions/src/System/Security/Cryptography/X509Certificates/X509Certificate2UI.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ public static void DisplayCertificate(X509Certificate2 certificate, IntPtr hwndP
DisplayX509Certificate(certificate, hwndParent);
}

public static X509Certificate2Collection SelectFromCollection(X509Certificate2Collection certificates, string title, string message, X509SelectionFlag selectionFlag)
public static X509Certificate2Collection SelectFromCollection(X509Certificate2Collection certificates, string? title, string? message, X509SelectionFlag selectionFlag)
{
return SelectFromCollectionHelper(certificates, title, message, selectionFlag, IntPtr.Zero);
}

public static X509Certificate2Collection SelectFromCollection(X509Certificate2Collection certificates, string title, string message, X509SelectionFlag selectionFlag, IntPtr hwndParent)
public static X509Certificate2Collection SelectFromCollection(X509Certificate2Collection certificates, string? title, string? message, X509SelectionFlag selectionFlag, IntPtr hwndParent)
{
return SelectFromCollectionHelper(certificates, title, message, selectionFlag, hwndParent);
}
Expand Down Expand Up @@ -82,7 +82,7 @@ private static void DisplayX509Certificate(X509Certificate2 certificate, IntPtr
}
}

private static X509Certificate2Collection SelectFromCollectionHelper(X509Certificate2Collection certificates, string title, string message, X509SelectionFlag selectionFlag, IntPtr hwndParent)
private static X509Certificate2Collection SelectFromCollectionHelper(X509Certificate2Collection certificates, string? title, string? message, X509SelectionFlag selectionFlag, IntPtr hwndParent)
{
if (certificates == null)
throw new ArgumentNullException(nameof(certificates));
Expand All @@ -96,7 +96,7 @@ private static X509Certificate2Collection SelectFromCollectionHelper(X509Certifi
}
}

private static unsafe SafeCertStoreHandle SelectFromStore(SafeCertStoreHandle safeSourceStoreHandle, string title, string message, X509SelectionFlag selectionFlags, IntPtr hwndParent)
private static unsafe SafeCertStoreHandle SelectFromStore(SafeCertStoreHandle safeSourceStoreHandle, string? title, string? message, X509SelectionFlag selectionFlags, IntPtr hwndParent)
{
int dwErrorCode = ERROR_SUCCESS;

Expand Down
8 changes: 4 additions & 4 deletions src/libraries/System.Windows.Extensions/src/System/Xaml/Permissions/XamlAccessLevel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ namespace System.Xaml.Permissions
{
public class XamlAccessLevel
{
private XamlAccessLevel(string assemblyName, string typeName)
private XamlAccessLevel(string assemblyName, string? typeName)
{
AssemblyNameString = assemblyName;
PrivateAccessToTypeName = typeName;
}

public static XamlAccessLevel AssemblyAccessTo(Assembly assembly)
{
return new XamlAccessLevel(assembly.FullName, null);
return new XamlAccessLevel(assembly.FullName!, null);
}

public static XamlAccessLevel AssemblyAccessTo(AssemblyName assemblyName)
Expand All @@ -26,7 +26,7 @@ public static XamlAccessLevel AssemblyAccessTo(AssemblyName assemblyName)

public static XamlAccessLevel PrivateAccessTo(Type type)
{
return new XamlAccessLevel(type.Assembly.FullName, type.FullName);
return new XamlAccessLevel(type.Assembly.FullName!, type.FullName);
}

public static XamlAccessLevel PrivateAccessTo(string assemblyQualifiedTypeName)
Expand All @@ -43,7 +43,7 @@ public AssemblyName AssemblyAccessToAssemblyName
get { return new AssemblyName(AssemblyNameString); }
}

public string PrivateAccessToTypeName { get; private set; }
public string? PrivateAccessToTypeName { get; private set; }

internal string AssemblyNameString { get; private set; }
}
Expand Down