[Core.Design] Annotate elements with nullability attributes.

# Original commit: '5755478a1df64dc6bb91d1fb30c09bd6a37e0c70'

Author: Nicolas Musset

sources/common/core/SiliconStudio.Core.Design/Collections/HybridDictionary.cs

@@ -4,6 +4,8 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using SiliconStudio.Core.Annotations;
+using SiliconStudio.Core.Extensions;
 
 namespace SiliconStudio.Core.Collections
 {
@@ -29,7 +31,7 @@ public HybridDictionary(IEqualityComparer<TKey> comparer) : this(0, comparer)
         {
         }
 
-        public HybridDictionary(IDictionary<TKey, TValue> dictionary) : this(dictionary, null)
+        public HybridDictionary([NotNull] IDictionary<TKey, TValue> dictionary) : this(dictionary, null)
         {
         }
 
@@ -46,10 +48,10 @@ public HybridDictionary(int capacity, IEqualityComparer<TKey> comparer)
                 list = new List<KeyValuePair<TKey, TValue>>(capacity);
             }
         }
-        public HybridDictionary(IDictionary<TKey, TValue> dictionary, IEqualityComparer<TKey> comparer) : this(dictionary?.Count ?? 0, comparer)
+        public HybridDictionary([NotNull] IDictionary<TKey, TValue> dictionary, IEqualityComparer<TKey> comparer)
+            : this(dictionary.SafeArgument(nameof(dictionary)).Count, comparer)
         {
-            if (dictionary == null) throw new ArgumentNullException(nameof(dictionary));
-            foreach (KeyValuePair<TKey, TValue> keyValuePair in dictionary)
+            foreach (var keyValuePair in dictionary)
                 InternalAdd(keyValuePair);
         }
 
@@ -194,7 +196,7 @@ public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)
             }
         }
 
-        public bool ContainsKey(TKey key)
+        public bool ContainsKey([NotNull] TKey key)
         {
             if (key == null) throw new ArgumentNullException(nameof(key));
             if (list != null)
@@ -257,7 +259,7 @@ private void Update(TKey key, TValue value)
             valueCollection = null;
             if (list != null)
             {
-                for (int i = 0; i < list.Count; i++)
+                for (var i = 0; i < list.Count; i++)
                 {
                     var kvp = list[i];
                     if (keyComparer.Equals(kvp.Key, key))

sources/common/core/SiliconStudio.Core.Design/Extensions/AnonymousEqualityComparer.cs

@@ -28,7 +28,7 @@ public AnonymousEqualityComparer([NotNull] Func<T, T, bool> equals, [NotNull] Fu
             this.equals = equals;
             this.getHashCode = getHashCode;
         }
-        
+
         /// <summary>
         /// Initializes a new instance of the <see cref="AnonymousEqualityComparer{T}"/> class using the default <see cref="object.GetHashCode"/> method to get hash codes.
         /// </summary>

sources/common/core/SiliconStudio.Core.Design/Extensions/ExceptionExtensions.cs

@@ -106,7 +106,7 @@ private static void ExtractStackTrace([NotNull] StringBuilder sb, [NotNull] Exce
         {
             if (exception.StackTrace == null)
                 return;
-            
+
             var indentString = "".PadLeft(indent);
             var stackTraceArray = exception.StackTrace.Split("\r\n".ToCharArray(), StringSplitOptions.RemoveEmptyEntries);
             foreach (var line in maxLines > 0 ? stackTraceArray.Take(maxLines) : stackTraceArray)

sources/common/core/SiliconStudio.Core.Design/Extensions/ProcessExtensions.cs

@@ -1,10 +1,10 @@
-using System;
-using System.Collections.Generic;
+// Copyright (c) 2014-2017 Silicon Studio Corp. All rights reserved. (https://www.siliconstudio.co.jp)
+// See LICENSE.md for full license information.
+using System;
 using System.Diagnostics;
-using System.Linq;
-using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using SiliconStudio.Core.Annotations;
 
 namespace SiliconStudio.Core.Extensions
 {
@@ -17,7 +17,7 @@ public static class ProcessExtensions
         /// <param name="cancellationToken">A cancellation token. If invoked, the task will return
         /// immediately as cancelled.</param>
         /// <returns>A Task representing waiting for the process to end.</returns>
-        public static Task WaitForExitAsync(this Process process, CancellationToken cancellationToken = default(CancellationToken))
+        public static Task WaitForExitAsync([NotNull] this Process process, CancellationToken cancellationToken = default(CancellationToken))
         {
             // Source: https://stackoverflow.com/questions/139593/processstartinfo-hanging-on-waitforexit-why/39872058#39872058
             process.EnableRaisingEvents = true;

sources/common/core/SiliconStudio.Core.Design/IDestroyable.cs

@@ -8,7 +8,7 @@ namespace SiliconStudio.Core
     /// </summary>
     /// <remarks>
     /// Class implementing both <see cref="IDestroyable"/> and <see cref="System.IDisposable"/> should call <see cref="Destroy"/>
-    /// from the <see cref="System.IDisposable.Dispose"/> method when appropriate. 
+    /// from the <see cref="System.IDisposable.Dispose"/> method when appropriate.
     /// </remarks>
     public interface IDestroyable
     {

sources/common/core/SiliconStudio.Core.Design/IO/UDirectory.cs

@@ -2,6 +2,7 @@
 // See LICENSE.md for full license information.
 using System;
 using System.ComponentModel;
+using SiliconStudio.Core.Annotations;
 
 namespace SiliconStudio.Core.IO
 {
@@ -30,14 +31,15 @@ public UDirectory(string directoryPath) : base(directoryPath, true)
         {
         }
 
-        internal UDirectory(string fullPath, StringSpan driveSpan, StringSpan directorySpan) : base(fullPath, driveSpan, directorySpan)
+        internal UDirectory([NotNull] string fullPath, StringSpan driveSpan, StringSpan directorySpan) : base(fullPath, driveSpan, directorySpan)
         {
         }
 
         /// <summary>
         /// Gets the name of the directory.
         /// </summary>
         /// <returns>The name of the directory.</returns>
+        [NotNull]
         public string GetDirectoryName()
         {
             var index = FullPath.IndexOfReverse(DirectorySeparatorChar);
@@ -49,7 +51,7 @@ public string GetDirectoryName()
         /// </summary>
         /// <param name="anchorDirectory">The anchor directory.</param>
         /// <returns>A relative path of this instance to the anchor directory.</returns>
-        public new UDirectory MakeRelative(UDirectory anchorDirectory)
+        public new UDirectory MakeRelative([NotNull] UDirectory anchorDirectory)
         {
             return (UDirectory)base.MakeRelative(anchorDirectory);
         }
@@ -59,6 +61,7 @@ public string GetDirectoryName()
         /// </summary>
         /// <param name="fullPath">The full path.</param>
         /// <returns>The result of the conversion.</returns>
+        [CanBeNull]
         public static implicit operator UDirectory(string fullPath)
         {
             return fullPath != null ? new UDirectory(fullPath) : null;
@@ -70,7 +73,8 @@ public static implicit operator UDirectory(string fullPath)
         /// <param name="leftPath">The left path.</param>
         /// <param name="rightPath">The right path.</param>
         /// <returns>The combination of both paths.</returns>
-        public static UDirectory Combine(UDirectory leftPath, UDirectory rightPath)
+        [NotNull]
+        public static UDirectory Combine([NotNull] UDirectory leftPath, [NotNull] UDirectory rightPath)
         {
             return UPath.Combine(leftPath, rightPath);
         }
@@ -80,7 +84,7 @@ public static UDirectory Combine(UDirectory leftPath, UDirectory rightPath)
         /// </summary>
         /// <param name="path">The path.</param>
         /// <returns><c>true</c> if this directory contains the specified path; otherwise, <c>false</c>.</returns>
-        public bool Contains(UPath path)
+        public bool Contains([NotNull] UPath path)
         {
             if (path == null) throw new ArgumentNullException(nameof(path));
             return path.FullPath.StartsWith(FullPath, StringComparison.OrdinalIgnoreCase) && path.FullPath.Length > FullPath.Length && path.FullPath[FullPath.Length] == DirectorySeparatorChar;

sources/common/core/SiliconStudio.Core.Design/IO/UFile.cs

@@ -2,6 +2,7 @@
 // See LICENSE.md for full license information.
 using System;
 using System.ComponentModel;
+using SiliconStudio.Core.Annotations;
 
 namespace SiliconStudio.Core.IO
 {
@@ -25,6 +26,7 @@ public UFile(string filePath)
         /// Gets the name of the file with its extension. Can be null.
         /// </summary>
         /// <returns>The name.</returns>
+        [CanBeNull]
         public string GetFileName()
         {
             var span = NameSpan;
@@ -34,13 +36,14 @@ public string GetFileName()
             }
             return span.IsValid ? FullPath.Substring(span) : null;
 
-            
+
         }
 
         /// <summary>
         /// Gets the name of the file without its extension.
         /// </summary>
         /// <value>The name of file.</value>
+        [CanBeNull]
         public string GetFileNameWithoutExtension()
         {
             return NameSpan.IsValid ? FullPath.Substring(NameSpan) : null;
@@ -50,6 +53,7 @@ public string GetFileNameWithoutExtension()
         /// Gets the file path (<see cref="UPath.GetDirectory()"/> + '/' + <see cref="UFile.GetFileName()"/>) with the extension or drive. Can be an null if no filepath.
         /// </summary>
         /// <returns>The path.</returns>
+        [CanBeNull]
         public string GetDirectoryAndFileName()
         {
             var span = DirectorySpan;
@@ -68,6 +72,7 @@ public string GetDirectoryAndFileName()
         /// Gets the file path (<see cref="UPath.GetDirectory()"/> + '/' + <see cref="UFile.GetFileName()"/>) without the extension or drive. Can be an null if no filepath.
         /// </summary>
         /// <returns>The path.</returns>
+        [CanBeNull]
         public string GetDirectoryAndFileNameWithoutExtension()
         {
             var span = DirectorySpan;
@@ -82,6 +87,7 @@ public string GetDirectoryAndFileNameWithoutExtension()
         /// Gets the extension of the file. Can be null.
         /// </summary>
         /// <returns>The extension.</returns>
+        [CanBeNull]
         public string GetFileExtension()
         {
             return ExtensionSpan.IsValid ? FullPath.Substring(ExtensionSpan) : null;
@@ -91,6 +97,7 @@ public string GetFileExtension()
         /// Gets the name of the file with its extension.
         /// </summary>
         /// <value>The name of file.</value>
+        [CanBeNull]
         public string GetFullPathWithoutExtension()
         {
             var span = new StringSpan(0, FullPath.Length);
@@ -107,7 +114,8 @@ public string GetFullPathWithoutExtension()
         /// <param name="leftPath">The left path.</param>
         /// <param name="rightPath">The right path.</param>
         /// <returns>The combination of both paths.</returns>
-        public static UFile Combine(UDirectory leftPath, UFile rightPath)
+        [NotNull]
+        public static UFile Combine([NotNull] UDirectory leftPath, [NotNull] UFile rightPath)
         {
             return UPath.Combine(leftPath, rightPath);
         }
@@ -117,7 +125,7 @@ public static UFile Combine(UDirectory leftPath, UFile rightPath)
         /// </summary>
         /// <param name="anchorDirectory">The anchor directory.</param>
         /// <returns>A relative path of this instance to the anchor directory.</returns>
-        public new UFile MakeRelative(UDirectory anchorDirectory)
+        public new UFile MakeRelative([NotNull] UDirectory anchorDirectory)
         {
             return (UFile)base.MakeRelative(anchorDirectory);
         }
@@ -127,9 +135,9 @@ public static UFile Combine(UDirectory leftPath, UFile rightPath)
         /// </summary>
         /// <param name="path">The path.</param>
         /// <returns><c>true</c> if the specified path is a valid <see cref="UFile"/>; otherwise, <c>false</c>.</returns>
-        public new static bool IsValid(string path)
+        public new static bool IsValid([NotNull] string path)
         {
-            if (path == null) throw new ArgumentNullException("path");
+            if (path == null) throw new ArgumentNullException(nameof(path));
             if (!UPath.IsValid(path))
             {
                 return false;
@@ -146,6 +154,7 @@ public static UFile Combine(UDirectory leftPath, UFile rightPath)
         /// </summary>
         /// <param name="fullPath">The full path.</param>
         /// <returns>The result of the conversion.</returns>
+        [CanBeNull]
         public static implicit operator UFile(string fullPath)
         {
             return fullPath != null ? new UFile(fullPath) : null;

sources/common/core/SiliconStudio.Core.Design/IO/UPath.cs

@@ -87,7 +87,7 @@ protected UPath([NotNull] string fullPath, StringSpan driveSpan, StringSpan dire
         public string FullPath { get; }
 
         /// <summary>
-        /// Gets a value indicating whether this instance has a <see cref="Drive"/> != null.
+        /// Gets a value indicating whether this instance has a <see cref="GetDrive"/> != null.
         /// </summary>
         /// <value><c>true</c> if this instance has drive; otherwise, <c>false</c>.</value>
         public bool HasDrive => DriveSpan.IsValid;
@@ -136,6 +136,7 @@ public static bool IsNullOrEmpty(UPath path)
         /// Gets the drive (contains the ':' if any), can be null.
         /// </summary>
         /// <returns>The drive.</returns>
+        [CanBeNull]
         public string GetDrive()
         {
             return DriveSpan.IsValid ? FullPath.Substring(DriveSpan) : null;
@@ -145,6 +146,7 @@ public string GetDrive()
         /// Gets the directory. Can be null. It won't contain the drive if one is specified.
         /// </summary>
         /// <returns>The directory.</returns>
+        [CanBeNull]
         [Obsolete("This method is obsolete. Use GetFullDirectory")]
         public string GetDirectory()
         {
@@ -155,19 +157,13 @@ public string GetDirectory()
                 {
                     return FullPath.Substring(DirectorySpan);
                 }
-                else
-                {
-                    return FullPath.Substring(DirectorySpan.Start, DirectorySpan.Length - 1);
-                }
+                return FullPath.Substring(DirectorySpan.Start, DirectorySpan.Length - 1);
             }
-            else if (DriveSpan.IsValid & (NameSpan.IsValid || ExtensionSpan.IsValid))
+            if (DriveSpan.IsValid & (NameSpan.IsValid || ExtensionSpan.IsValid))
             {
                 return "/";
             }
-            else
-            {
-                return null;
-            }
+            return null;
         }
 
         /// <summary>
@@ -197,6 +193,7 @@ public UDirectory GetParent()
         /// the directories and the filename (including its extension).
         /// </summary>
         /// <returns>An IEnumerable of all the components of this instance.</returns>
+        [NotNull]
         public IReadOnlyCollection<string> GetComponents()
         {
             var list = new List<string>(FullPath.Count(pathItem => pathItem == DirectorySeparatorChar) + 1);
@@ -269,7 +266,7 @@ public override int GetHashCode()
             return hashCode;
         }
 
-        private static int ComputeStringHashCodeCaseInsensitive(string text)
+        private static int ComputeStringHashCodeCaseInsensitive([NotNull] string text)
         {
             return text.Aggregate(0, (current, t) => (current*397) ^ char.ToLowerInvariant(t));
         }
@@ -292,6 +289,7 @@ public override string ToString()
         /// Converts this path to a Windows path (/ replaced by \)
         /// </summary>
         /// <returns>A string representation of this path in windows form.</returns>
+        [NotNull]
         public string ToWindowsPath()
         {
             return FullPath.Replace('/', '\\');
@@ -347,7 +345,7 @@ public static T Combine<T>([NotNull] UDirectory leftPath, [NotNull] T rightPath)
         /// </summary>
         /// <param name="anchorDirectory">The anchor directory.</param>
         /// <returns>A relative path of this instance to the anchor directory.</returns>
-        public UPath MakeRelative(UDirectory anchorDirectory)
+        public UPath MakeRelative([NotNull] UDirectory anchorDirectory)
         {
             if (anchorDirectory == null) throw new ArgumentNullException(nameof(anchorDirectory));
 
@@ -433,6 +431,7 @@ public UPath MakeRelative(UDirectory anchorDirectory)
         /// </summary>
         /// <param name="url">The URL.</param>
         /// <returns>The result of the conversion.</returns>
+        [CanBeNull]
         public static implicit operator string(UPath url)
         {
             return url?.FullPath;
@@ -467,6 +466,7 @@ public static bool IsValid(string path)
         /// <returns>A normalized path.</returns>
         /// <exception cref="System.ArgumentException">If path is invalid</exception>
         /// <remarks>Unlike <see cref="System.IO.Path" /> , this doesn't make a path absolute to the actual file system.</remarks>
+        [NotNull]
         public static string Normalize(string pathToNormalize)
         {
             string error;
@@ -485,6 +485,7 @@ public static string Normalize(string pathToNormalize)
         /// <param name="error">The error or null if no errors.</param>
         /// <returns>A normalized path or null if there is an error.</returns>
         /// <remarks>Unlike <see cref="System.IO.Path" /> , this doesn't make a path absolute to the actual file system.</remarks>
+        [CanBeNull]
         public static StringBuilder Normalize(string pathToNormalize, out string error)
         {
             StringSpan drive;
@@ -515,6 +516,7 @@ private enum NormalizationState
         /// <param name="error">The error or null if no errors.</param>
         /// <returns>A normalized path or null if there is an error.</returns>
         /// <remarks>Unlike <see cref="System.IO.Path" /> , this doesn't make a path absolute to the actual file system.</remarks>
+        [CanBeNull]
         public static unsafe StringBuilder Normalize(string pathToNormalize, out StringSpan drive, out StringSpan directoryOrFileName, out StringSpan fileName, out string error)
         {
             drive = new StringSpan();
@@ -605,7 +607,7 @@ public static unsafe StringBuilder Normalize(string pathToNormalize, out StringS
                         error = @"Path must contain a separator '/' or '\' after the volume separator ':'";
                         return null;
                     }
-                    else if ((state == NormalizationState.StartComponent) || (state == NormalizationState.DirectorySeparator))
+                    if ((state == NormalizationState.StartComponent) || (state == NormalizationState.DirectorySeparator))
                     {
                         // We are starting a new component. Check if previous one is either '..' or '.', in which case
                         // we can simplify
@@ -768,6 +770,7 @@ private static unsafe void TrimParentAndSelfPath(StringBuilder builder, ref int
             }
         }
 
+        [NotNull]
         private static string Decode(string pathToNormalize, bool isPathDirectory, out StringSpan drive, out StringSpan directory, out StringSpan fileName, out StringSpan fileExtension)
         {
             drive = new StringSpan();