Cleanup in the VB code (#12730)

Author: paul1956

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/SingleInstanceHelpers.vb

@@ -21,17 +21,16 @@ Namespace Microsoft.VisualBasic.ApplicationServices
             Using stream As New MemoryStream
                 While True
                     Dim buffer As Byte() = New Byte(bufferLength - 1) {}
-                    Dim bytesRead As Integer = Await pipeServer.ReadAsync(
-                        buffer:=buffer.AsMemory(start:=0, length:=bufferLength),
-                        cancellationToken) _
-                            .ConfigureAwait(continueOnCapturedContext:=False)
+                    Dim bytesRead As Integer =
+                        Await pipeServer.ReadAsync(
+                            buffer:=buffer.AsMemory(start:=0, length:=bufferLength),
+                            cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
                     If bytesRead = 0 Then
                         Exit While
                     End If
                     Await stream.WriteAsync(
                         buffer:=buffer.AsMemory(start:=0, length:=bytesRead),
-                        cancellationToken) _
-                            .ConfigureAwait(continueOnCapturedContext:=False)
+                        cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
                 End While
                 stream.Seek(0, SeekOrigin.Begin)
                 Dim serializer As New DataContractSerializer(GetType(String()))
@@ -55,8 +54,8 @@ Namespace Microsoft.VisualBasic.ApplicationServices
                 content = stream.ToArray()
             End Using
             Await pipeClient.WriteAsync(
-                buffer:=content.AsMemory(start:=0, length:=content.Length), cancellationToken) _
-                    .ConfigureAwait(continueOnCapturedContext:=False)
+                buffer:=content.AsMemory(start:=0, length:=content.Length),
+                cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
         End Function
 
         Friend Async Function SendSecondInstanceArgsAsync(
@@ -70,10 +69,8 @@ Namespace Microsoft.VisualBasic.ApplicationServices
                 direction:=PipeDirection.Out,
                 options:=NamedPipeOptions)
 
-                Await pipeClient.ConnectAsync(cancellationToken) _
-                    .ConfigureAwait(continueOnCapturedContext:=False)
-                Await WriteArgsAsync(pipeClient, args, cancellationToken) _
-                    .ConfigureAwait(continueOnCapturedContext:=False)
+                Await pipeClient.ConnectAsync(cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
+                Await WriteArgsAsync(pipeClient, args, cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
             End Using
         End Function
 
@@ -102,11 +99,10 @@ Namespace Microsoft.VisualBasic.ApplicationServices
 
             While True
                 cancellationToken.ThrowIfCancellationRequested()
-                Await pipeServer.WaitForConnectionAsync(cancellationToken) _
-                    .ConfigureAwait(continueOnCapturedContext:=False)
+                Await pipeServer.WaitForConnectionAsync(cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
                 Try
-                    Dim args() As String = Await ReadArgsAsync(pipeServer, cancellationToken) _
-                        .ConfigureAwait(continueOnCapturedContext:=False)
+                    Dim args() As String =
+                        Await ReadArgsAsync(pipeServer, cancellationToken).ConfigureAwait(continueOnCapturedContext:=False)
                     If args IsNot Nothing Then
                         callback(args)
                     End If

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

@@ -1082,8 +1082,7 @@ Namespace Microsoft.VisualBasic.ApplicationServices
                         Dim awaitable As ConfiguredTaskAwaitable = SendSecondInstanceArgsAsync(
                             pipeName:=applicationInstanceID,
                             args:=commandLine,
-                            cancellationToken:=tokenSource.Token) _
-                                .ConfigureAwait(continueOnCapturedContext:=False)
+                            cancellationToken:=tokenSource.Token).ConfigureAwait(continueOnCapturedContext:=False)
 
                         awaitable.GetAwaiter().GetResult()
                     Catch ex As Exception

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/Devices/Network.DownloadFile.vb

@@ -286,7 +286,6 @@ Namespace Microsoft.VisualBasic.Devices
                 connectionTimeout,
                 overwrite,
                 UICancelOption.ThrowException)
-
         End Sub
 
         ''' <summary>
@@ -328,7 +327,7 @@ Namespace Microsoft.VisualBasic.Devices
                 ' Don't use passive mode if we're showing UI
                 client.UseNonPassiveFtp = showUI
 
-                'Construct the local file. This will validate the full name and path
+                ' Construct the local file. This will validate the full name and path
                 Dim fullFilename As String = FileSystemUtils.NormalizeFilePath(destinationFileName, NameOf(destinationFileName))
 
                 ' Sometime a path that can't be parsed is normalized to the current directory. This makes sure we really
@@ -337,7 +336,7 @@ Namespace Microsoft.VisualBasic.Devices
                     Throw VbUtils.GetInvalidOperationException(SR.Network_DownloadNeedsFilename)
                 End If
 
-                'Throw if the file exists and the user doesn't want to overwrite
+                ' Throw if the file exists and the user doesn't want to overwrite
                 If IO.File.Exists(fullFilename) And Not overwrite Then
                     Throw New IO.IOException(VbUtils.GetResourceString(SR.IO_FileExists_Path, destinationFileName))
                 End If
@@ -349,7 +348,7 @@ Namespace Microsoft.VisualBasic.Devices
 
                 Dim dialog As ProgressDialog = GetProgressDialog(address.AbsolutePath, fullFilename, showUI)
 
-                'Check to see if the target directory exists. If it doesn't, create it
+                ' Check to see if the target directory exists. If it doesn't, create it
                 Dim targetDirectory As String = IO.Path.GetDirectoryName(fullFilename)
 
                 ' Make sure we have a meaningful directory. If we don't, the destinationFileName is suspect
@@ -361,21 +360,20 @@ Namespace Microsoft.VisualBasic.Devices
                     IO.Directory.CreateDirectory(targetDirectory)
                 End If
 
-                'Create the copier
+                ' Create the copier
                 Dim copier As New WebClientCopy(client, dialog)
 
-                'Download the file
+                ' Download the file
                 copier.DownloadFile(address, fullFilename)
 
-                'Handle a dialog cancel
-                If showUI AndAlso Environment.UserInteractive Then
-                    If onUserCancel = UICancelOption.ThrowException And dialog.UserCanceledTheDialog Then
-                        Throw New OperationCanceledException()
-                    End If
+                ' Handle a dialog cancel
+                If showUI _
+                   AndAlso Environment.UserInteractive _
+                   AndAlso onUserCancel = UICancelOption.ThrowException _
+                   AndAlso dialog.UserCanceledTheDialog Then
+                    Throw New OperationCanceledException()
                 End If
-
             End Using
-
         End Sub
 
     End Class

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/Devices/Network.UploadFile.vb

@@ -289,7 +289,7 @@ Namespace Microsoft.VisualBasic.Devices
                 End If
 
                 Dim dialog As ProgressDialog = Nothing
-                If showUI AndAlso Environment.UserInteractive Then
+                If InteractiveEnvironment(showUI) Then
                     dialog = New ProgressDialog With {
                         .Text = GetResourceString(SR.ProgressDialogUploadingTitle, sourceFileName),
                         .LabelText = GetResourceString(
@@ -306,7 +306,7 @@ Namespace Microsoft.VisualBasic.Devices
                 copier.UploadFile(sourceFileName, address)
 
                 ' Handle a dialog cancel
-                If showUI AndAlso Environment.UserInteractive Then
+                If InteractiveEnvironment(showUI) Then
                     If onUserCancel = UICancelOption.ThrowException And dialog.UserCanceledTheDialog Then
                         Throw New OperationCanceledException()
                     End If

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/Devices/NetworkUtilities.vb

@@ -56,13 +56,16 @@ Namespace Microsoft.VisualBasic.Devices
         ''' <param name="address">Address to the remote file, http, ftp etc...</param>
         ''' <param name="destinationFileName">Name and path of file where download is saved.</param>
         ''' <param name="showUI">Indicates whether or not to show a progress bar.</param>
-        ''' <returns><see langword="New"/> <see cref="ProgressDialog"/>.</returns>
+        ''' <returns>
+        '''  <see langword="New"/> <see cref="ProgressDialog"/> if InteractiveEnvironment <see langword="True"/>
+        '''  otherwise return <see langword="Nothing"/>.
+        ''' </returns>
         Friend Function GetProgressDialog(
             address As String,
             destinationFileName As String,
             showUI As Boolean) As ProgressDialog
 
-            If showUI AndAlso Environment.UserInteractive Then
+            If InteractiveEnvironment(showUI) Then
                 'Construct the local file. This will validate the full name and path
                 Dim fullFilename As String = FileSystemUtils.NormalizeFilePath(
                     path:=destinationFileName,
@@ -98,5 +101,9 @@ Namespace Microsoft.VisualBasic.Devices
             End Try
         End Function
 
+        Friend Function InteractiveEnvironment(showUI As Boolean) As Boolean
+            Return showUI AndAlso Environment.UserInteractive
+        End Function
+
     End Module
 End Namespace

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/Interaction.vb

@@ -250,7 +250,8 @@ Namespace Microsoft.VisualBasic
             'Low-order 4 bits (0x000f), legal values: 0, 1, 2, 3, 4, 5
             '     next 4 bits (0x00f0), legal values: 0, &H10, &H20, &H30, &H40
             '     next 4 bits (0x0f00), legal values: 0, &H100, &H200
-            If ((Buttons And &HFI) > MsgBoxStyle.RetryCancel) OrElse ((Buttons And &HF0I) > MsgBoxStyle.Information) _
+            If ((Buttons And &HFI) > MsgBoxStyle.RetryCancel) _
+                OrElse ((Buttons And &HF0I) > MsgBoxStyle.Information) _
                 OrElse ((Buttons And &HF00I) > MsgBoxStyle.DefaultButton3) Then
                 Buttons = MsgBoxStyle.OkOnly
             End If

Diff for: src/Microsoft.VisualBasic.Forms/src/Microsoft/VisualBasic/MyServices/ClipboardProxy.vb

@@ -12,7 +12,7 @@ Imports System.Runtime.InteropServices
 Namespace Microsoft.VisualBasic.MyServices
 
     ''' <summary>
-    '''  A class that wraps System.Windows.Forms.Clipboard so that
+    '''  A class that wraps <see cref="Clipboard"/> so that
     '''  a clipboard can be instanced.
     ''' </summary>
     <EditorBrowsable(EditorBrowsableState.Never)>
@@ -25,22 +25,23 @@ Namespace Microsoft.VisualBasic.MyServices
         End Sub
 
         ''' <summary>
-        '''  Removes everything from the clipboard.
+        '''  Removes everything from the <see cref="Clipboard"/>.
         ''' </summary>
         Public Sub Clear()
             Clipboard.Clear()
         End Sub
 
         ''' <summary>
-        '''  Indicates whether or not there's an audio stream saved to the clipboard.
+        '''  Indicates whether or not there's an audio stream saved to the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <returns><see langword="True"/> if an audio stream is available, otherwise <see langword="False"/>.</returns>
         Public Function ContainsAudio() As Boolean
             Return Clipboard.ContainsAudio()
         End Function
 
         ''' <summary>
-        '''  Indicates whether or not there is data on the clipboard in the passed in format.
+        '''  Indicates whether or not there is data on the <see cref="Clipboard"/> in the passed in format.
+        '''  or can be converted to that format.
         ''' </summary>
         ''' <param name="format"></param>
         ''' <returns><see langword="True"/> if there's data in the passed in format, otherwise <see langword="False"/>.</returns>
@@ -57,23 +58,23 @@ Namespace Microsoft.VisualBasic.MyServices
         End Function
 
         ''' <summary>
-        '''  Indicate whether or not an image has been saved to the clipboard.
+        '''  Indicate whether or not an image has been saved to the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <returns><see langword="True"/> if an image is available, otherwise <see langword="False"/>.</returns>
         Public Function ContainsImage() As Boolean
             Return Clipboard.ContainsImage()
         End Function
 
         ''' <summary>
-        '''  Indicates whether or not text is available on the clipboard.
+        '''  Indicates whether or not text is available on the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <returns><see langword="True"/> if text is available, otherwise <see langword="False"/>.</returns>
         Public Function ContainsText() As Boolean
             Return Clipboard.ContainsText
         End Function
 
         ''' <summary>
-        '''  Indicates whether or not text is available on the clipboard in
+        '''  Indicates whether or not text is available on the <see cref="Clipboard"/> in
         '''  the passed in format.
         ''' </summary>
         ''' <param name="format">The type of text being checked for.</param>
@@ -83,15 +84,15 @@ Namespace Microsoft.VisualBasic.MyServices
         End Function
 
         ''' <summary>
-        '''  Gets an audio stream from the clipboard.
+        '''  Gets an audio stream from the <see cref="Clipboard"/>.
         ''' </summary>
-        ''' <returns>The audio stream as a Stream.</returns>
+        ''' <returns>The audio stream as a <see cref="Stream"/>.</returns>
         Public Function GetAudioStream() As Stream
             Return Clipboard.GetAudioStream()
         End Function
 
         ''' <summary>
-        '''  Gets data from the clipboard that's been saved in the passed in format.
+        '''  Gets data from the <see cref="Clipboard"/> that's been saved in the passed in format.
         ''' </summary>
         ''' <param name="format">The type of data being sought.</param>
         ''' <returns>The data.</returns>
@@ -125,15 +126,15 @@ Namespace Microsoft.VisualBasic.MyServices
         End Function
 
         ''' <summary>
-        '''  Gets an Image from the clipboard.
+        '''  Retrieves an <see cref="Image"/> from the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <returns>The image.</returns>
         Public Function GetImage() As Image
             Return Clipboard.GetImage()
         End Function
 
         ''' <summary>
-        '''  Gets text from the clipboard.
+        '''  Gets text from the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <returns>The text as a String.</returns>
         Public Function GetText() As String
@@ -150,23 +151,23 @@ Namespace Microsoft.VisualBasic.MyServices
         End Function
 
         ''' <summary>
-        '''  Saves the passed in audio byte array to the clipboard.
+        '''  Saves the passed in audio byte array to the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <param name="audioBytes">The byte array to be saved.</param>
         Public Sub SetAudio(audioBytes As Byte())
             Clipboard.SetAudio(audioBytes)
         End Sub
 
         ''' <summary>
-        '''  Saves the passed in audio stream to the clipboard.
+        '''  Saves the passed in audio stream to the <see cref="Clipboard"/>.
         ''' </summary>
-        ''' <param name="audioStream">The stream to be saved.</param>
+        ''' <param name="audioStream">The <see cref="Stream"/> to be saved.</param>
         Public Sub SetAudio(audioStream As Stream)
             Clipboard.SetAudio(audioStream)
         End Sub
 
         ''' <summary>
-        '''  Saves the passed in data to the clipboard in the passed in format.
+        '''  Saves the passed in data to the <see cref="Clipboard"/> in the passed in format.
         ''' </summary>
         ''' <param name="format">The format in which to save the data.</param>
         ''' <param name="data">The data to be saved.</param>
@@ -185,7 +186,7 @@ Namespace Microsoft.VisualBasic.MyServices
         End Sub
 
         ''' <summary>
-        '''  Saves the passed in file drop list to the clipboard.
+        '''  Saves the passed in file drop list to the <see cref="Clipboard"/>.
         ''' </summary>
         ''' <param name="filePaths">The file drop list as a <see cref="StringCollection"/>.</param>
         Public Sub SetFileDropList(filePaths As StringCollection)

Diff for: src/Microsoft.VisualBasic.Forms/tests/UnitTests/System/Windows/Forms/TestUtilitiesTests.vb

@@ -23,6 +23,13 @@ Namespace Microsoft.VisualBasic.Forms.Tests
             testClass.Any.Should.BeTrue()
         End Sub
 
+        <WinFormsFact>
+        Public Sub PathSeparatorDataIteratorTests()
+            Dim testClass As New PathSeparatorTestData
+            testClass.IEnumerable_GetEnumerator.Should.NotBeNull()
+            testClass.Any.Should.BeTrue()
+        End Sub
+
         <WinFormsFact>
         Public Sub TimeTestDataIteratorTests()
             Dim testClass As New TimeTestData

Diff for: src/Microsoft.VisualBasic.Forms/tests/UnitTests/System/Windows/TestUtilities/TestData/PathSeparatorTestData.vb

@@ -0,0 +1,19 @@
+' Licensed to the .NET Foundation under one or more agreements.
+' The .NET Foundation licenses this file to you under the MIT license.
+
+Namespace Microsoft.VisualBasic.Forms.Tests
+
+    Public Class PathSeparatorTestData
+        Implements IEnumerable(Of Object())
+
+        Public Iterator Function GetEnumerator() As IEnumerator(Of Object()) Implements IEnumerable(Of Object()).GetEnumerator
+            Yield {IO.Path.DirectorySeparatorChar}
+            Yield {IO.Path.AltDirectorySeparatorChar}
+        End Function
+
+        Public Function IEnumerable_GetEnumerator() As IEnumerator Implements IEnumerable.GetEnumerator
+            Return GetEnumerator()
+        End Function
+
+    End Class
+End Namespace