Merge pull request #64900 from raulsntos/dotnet/fix-exceptions

Fix various C# exceptions

modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/MarshalUtils.cs

@@ -16,7 +16,7 @@ public TypeCache(Compilation compilation)
                 INamedTypeSymbol GetTypeByMetadataNameOrThrow(string fullyQualifiedMetadataName)
                 {
                     return compilation.GetTypeByMetadataName(fullyQualifiedMetadataName) ??
-                           throw new InvalidOperationException("Type not found: " + fullyQualifiedMetadataName);
+                           throw new InvalidOperationException($"Type not found: '{fullyQualifiedMetadataName}'.");
                 }
 
                 GodotObjectType = GetTypeByMetadataNameOrThrow("Godot.Object");

modules/mono/editor/GodotTools/GodotTools.IdeMessaging/Utils/NotifyAwaiter.cs

@@ -21,14 +21,14 @@ public T GetResult()
         public void OnCompleted(Action continuation)
         {
             if (this.continuation != null)
-                throw new InvalidOperationException("This awaiter has already been listened");
+                throw new InvalidOperationException("This awaiter already has a continuation.");
             this.continuation = continuation;
         }
 
         public void SetResult(T result)
         {
             if (IsCompleted)
-                throw new InvalidOperationException("This awaiter is already completed");
+                throw new InvalidOperationException("This awaiter is already completed.");
 
             IsCompleted = true;
             this.result = result;
@@ -39,7 +39,7 @@ public void SetResult(T result)
         public void SetException(Exception exception)
         {
             if (IsCompleted)
-                throw new InvalidOperationException("This awaiter is already completed");
+                throw new InvalidOperationException("This awaiter is already completed.");
 
             IsCompleted = true;
             this.exception = exception;

modules/mono/editor/GodotTools/GodotTools.ProjectEditor/ProjectGenerator.cs

@@ -15,7 +15,7 @@ public static class ProjectGenerator
         public static ProjectRootElement GenGameProject(string name)
         {
             if (name.Length == 0)
-                throw new ArgumentException("Project name is empty", nameof(name));
+                throw new ArgumentException("Project name is empty.", nameof(name));
 
             var root = ProjectRootElement.Create(NewProjectFileOptions.None);
 
@@ -37,7 +37,7 @@ public static ProjectRootElement GenGameProject(string name)
         public static string GenAndSaveGameProject(string dir, string name)
         {
             if (name.Length == 0)
-                throw new ArgumentException("Project name is empty", nameof(name));
+                throw new ArgumentException("Project name is empty.", nameof(name));
 
             string path = Path.Combine(dir, name + ".csproj");
 

modules/mono/editor/GodotTools/GodotTools/Build/BuildManager.cs

@@ -62,7 +62,7 @@ private static void PrintVerbose(string text)
         private static bool Build(BuildInfo buildInfo)
         {
             if (_buildInProgress != null)
-                throw new InvalidOperationException("A build is already in progress");
+                throw new InvalidOperationException("A build is already in progress.");
 
             _buildInProgress = buildInfo;
 
@@ -111,7 +111,7 @@ private static bool Build(BuildInfo buildInfo)
         public static async Task<bool> BuildAsync(BuildInfo buildInfo)
         {
             if (_buildInProgress != null)
-                throw new InvalidOperationException("A build is already in progress");
+                throw new InvalidOperationException("A build is already in progress.");
 
             _buildInProgress = buildInfo;
 
@@ -157,7 +157,7 @@ public static async Task<bool> BuildAsync(BuildInfo buildInfo)
         private static bool Publish(BuildInfo buildInfo)
         {
             if (_buildInProgress != null)
-                throw new InvalidOperationException("A build is already in progress");
+                throw new InvalidOperationException("A build is already in progress.");
 
             _buildInProgress = buildInfo;
 

modules/mono/editor/GodotTools/GodotTools/Build/BuildOutputView.cs

@@ -120,13 +120,13 @@ private void LoadIssuesFromFile(string csvFile)
         private void IssueActivated(int idx)
         {
             if (idx < 0 || idx >= _issuesList.ItemCount)
-                throw new IndexOutOfRangeException("Item list index out of range");
+                throw new ArgumentOutOfRangeException(nameof(idx), "Item list index out of range.");
 
             // Get correct issue idx from issue list
             int issueIndex = (int)_issuesList.GetItemMetadata(idx);
 
             if (issueIndex < 0 || issueIndex >= _issues.Count)
-                throw new IndexOutOfRangeException("Issue index out of range");
+                throw new InvalidOperationException("Issue index out of range.");
 
             BuildIssue issue = _issues[issueIndex];
 
@@ -293,15 +293,15 @@ private void ScrollToLastNonEmptyLogLine()
         public void RestartBuild()
         {
             if (!HasBuildExited)
-                throw new InvalidOperationException("Build already started");
+                throw new InvalidOperationException("Build already started.");
 
             BuildManager.RestartBuild(this);
         }
 
         public void StopBuild()
         {
             if (!HasBuildExited)
-                throw new InvalidOperationException("Build is not in progress");
+                throw new InvalidOperationException("Build is not in progress.");
 
             BuildManager.StopBuild(this);
         }

modules/mono/editor/GodotTools/GodotTools/Build/NuGetUtils.cs

@@ -49,7 +49,7 @@ private static void AddFallbackFolderToNuGetConfig(string nuGetConfigPath, strin
             {
                 // Check that the root node is the expected one
                 if (rootNode.Name != nuGetConfigRootName)
-                    throw new Exception("Invalid root Xml node for NuGet.Config. " +
+                    throw new FormatException("Invalid root Xml node for NuGet.Config. " +
                                         $"Expected '{nuGetConfigRootName}' got '{rootNode.Name}'.");
             }
 

modules/mono/editor/GodotTools/GodotTools/Export/AotBuilder.cs

@@ -212,7 +212,7 @@ public static void CompileAssembliesForiOS(ExportPlugin exporter, bool isDebug,
 
                     int clangExitCode = OS.ExecuteCommand(XcodeHelper.FindXcodeTool("clang"), clangArgs);
                     if (clangExitCode != 0)
-                        throw new Exception($"Command 'clang' exited with code: {clangExitCode}");
+                        throw new InvalidOperationException($"Command 'clang' exited with code: {clangExitCode}.");
 
                     objFilePathsForiOSArch[arch].Add(objFilePath);
                 }
@@ -318,7 +318,7 @@ typedef enum {
 
                 int arExitCode = OS.ExecuteCommand(XcodeHelper.FindXcodeTool("ar"), arArgs);
                 if (arExitCode != 0)
-                    throw new Exception($"Command 'ar' exited with code: {arExitCode}");
+                    throw new InvalidOperationException($"Command 'ar' exited with code: {arExitCode}.");
 
                 arFilePathsForAllArchs.Add(arOutputFilePath);
             }
@@ -336,7 +336,7 @@ typedef enum {
 
             int lipoExitCode = OS.ExecuteCommand(XcodeHelper.FindXcodeTool("lipo"), lipoArgs);
             if (lipoExitCode != 0)
-                throw new Exception($"Command 'lipo' exited with code: {lipoExitCode}");
+                throw new InvalidOperationException($"Command 'lipo' exited with code: {lipoExitCode}.");
 
             // TODO: Add the AOT lib and interpreter libs as device only to suppress warnings when targeting the simulator
 
@@ -436,7 +436,7 @@ private static IEnumerable<string> GetAotCompilerArgs(string platform, bool isDe
                 }
                 else if (!Directory.Exists(androidToolchain))
                 {
-                    throw new FileNotFoundException("Android toolchain not found: " + androidToolchain);
+                    throw new FileNotFoundException($"Android toolchain not found: '{androidToolchain}'.");
                 }
 
                 var androidToolPrefixes = new Dictionary<string, string>
@@ -533,12 +533,12 @@ string CmdLineArgsToString(IEnumerable<string> args)
                 Console.WriteLine($"Running: \"{process.StartInfo.FileName}\" {process.StartInfo.Arguments}");
 
                 if (!process.Start())
-                    throw new Exception("Failed to start process for Mono AOT compiler");
+                    throw new InvalidOperationException("Failed to start process for Mono AOT compiler.");
 
                 process.WaitForExit();
 
                 if (process.ExitCode != 0)
-                    throw new Exception($"Mono AOT compiler exited with code: {process.ExitCode}");
+                    throw new InvalidOperationException($"Mono AOT compiler exited with code: {process.ExitCode}.");
             }
         }
 

modules/mono/editor/GodotTools/GodotTools/Export/ExportPlugin.cs

@@ -98,16 +98,16 @@ private void _ExportBeginImpl(string[] features, bool isDebug, string path, int
                 return;
 
             if (!DeterminePlatformFromFeatures(features, out string platform))
-                throw new NotSupportedException("Target platform not supported");
+                throw new NotSupportedException("Target platform not supported.");
 
             if (!new[] { OS.Platforms.Windows, OS.Platforms.LinuxBSD, OS.Platforms.MacOS }
                     .Contains(platform))
             {
-                throw new NotImplementedException("Target platform not yet implemented");
+                throw new NotImplementedException("Target platform not yet implemented.");
             }
 
             string outputDir = new FileInfo(path).Directory?.FullName ??
-                               throw new FileNotFoundException("Output base directory not found");
+                               throw new FileNotFoundException("Output base directory not found.");
 
             string buildConfig = isDebug ? "ExportDebug" : "ExportRelease";
 
@@ -131,7 +131,7 @@ private void _ExportBeginImpl(string[] features, bool isDebug, string path, int
             if (!BuildManager.PublishProjectBlocking(buildConfig, platform,
                     runtimeIdentifier, publishOutputTempDir))
             {
-                throw new Exception("Failed to build project");
+                throw new InvalidOperationException("Failed to build project.");
             }
 
             string soExt = ridOS switch

modules/mono/editor/GodotTools/GodotTools/Export/XcodeHelper.cs

@@ -16,7 +16,7 @@ public static string XcodePath
                     _XcodePath = FindXcode();
 
                     if (_XcodePath == null)
-                        throw new Exception("Could not find Xcode");
+                        throw new FileNotFoundException("Could not find Xcode.");
                 }
 
                 return _XcodePath;

modules/mono/editor/GodotTools/GodotTools/GodotSharpEditor.cs

@@ -342,7 +342,7 @@ private void ApplyNecessaryChangesToSolution()
                 DotNetSolution.MigrateFromOldConfigNames(GodotSharpDirs.ProjectSlnPath);
 
                 var msbuildProject = ProjectUtils.Open(GodotSharpDirs.ProjectCsProjPath)
-                                     ?? throw new Exception("Cannot open C# project");
+                                     ?? throw new InvalidOperationException("Cannot open C# project.");
 
                 // NOTE: The order in which changes are made to the project is important
 

modules/mono/editor/GodotTools/GodotTools/Ides/GodotIdeManager.cs

@@ -153,7 +153,7 @@ MonoDevelop.Instance GetMonoDevelopInstance(string solutionPath)
                 }
 
                 default:
-                    throw new ArgumentOutOfRangeException();
+                    throw new ArgumentOutOfRangeException(nameof(editorId));
             }
         }
 

modules/mono/editor/GodotTools/GodotTools/Ides/Rider/RiderPathLocator.cs

@@ -42,7 +42,7 @@ public static RiderInfo[] GetAllRiderPaths()
                 {
                     return CollectAllRiderPathsLinux();
                 }
-                throw new Exception("Unexpected OS.");
+                throw new InvalidOperationException("Unexpected OS.");
             }
             catch (Exception e)
             {
@@ -216,7 +216,7 @@ private static string GetRelativePathToBuildTxt()
                 return "../../build.txt";
             if (OS.IsMacOS)
                 return "Contents/Resources/build.txt";
-            throw new Exception("Unknown OS.");
+            throw new InvalidOperationException("Unknown OS.");
         }
 
         [SupportedOSPlatform("windows")]

modules/mono/editor/GodotTools/GodotTools/Internals/Internal.cs

@@ -74,11 +74,11 @@ public static string[] CodeCompletionRequest(CodeCompletionRequest.CompletionKin
         internal static unsafe void Initialize(IntPtr unmanagedCallbacks, int unmanagedCallbacksSize)
         {
             if (initialized)
-                throw new InvalidOperationException("Already initialized");
+                throw new InvalidOperationException("Already initialized.");
             initialized = true;
 
             if (unmanagedCallbacksSize != sizeof(InternalUnmanagedCallbacks))
-                throw new ArgumentException("Unmanaged callbacks size mismatch");
+                throw new ArgumentException("Unmanaged callbacks size mismatch.", nameof(unmanagedCallbacksSize));
 
             _unmanagedCallbacks = Unsafe.AsRef<InternalUnmanagedCallbacks>((void*)unmanagedCallbacks);
         }

modules/mono/editor/GodotTools/GodotTools/Utils/OS.cs

@@ -257,7 +257,7 @@ public static void RunProcess(string command, IEnumerable<string> arguments)
             using Process process = Process.Start(startInfo);
 
             if (process == null)
-                throw new Exception("No process was started");
+                throw new InvalidOperationException("No process was started.");
 
             process.BeginOutputReadLine();
             process.BeginErrorReadLine();

modules/mono/glue/GodotSharp/GodotPlugins/Main.cs

@@ -153,7 +153,7 @@ private static unsafe IntPtr LoadToolsAssembly(char* nAssemblyPath,
                 string assemblyPath = new(nAssemblyPath);
 
                 if (_editorApiAssembly == null)
-                    throw new InvalidOperationException("The Godot editor API assembly is not loaded");
+                    throw new InvalidOperationException("The Godot editor API assembly is not loaded.");
 
                 var (assembly, _) = LoadPlugin(assemblyPath);
 

modules/mono/glue/GodotSharp/GodotSharp/Core/AABB.cs

@@ -145,6 +145,9 @@ public real_t GetArea()
         /// Gets the position of one of the 8 endpoints of the <see cref="AABB"/>.
         /// </summary>
         /// <param name="idx">Which endpoint to get.</param>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// <paramref name="idx"/> is less than 0 or greater than 7.
+        /// </exception>
         /// <returns>An endpoint of the <see cref="AABB"/>.</returns>
         public Vector3 GetEndpoint(int idx)
         {

modules/mono/glue/GodotSharp/GodotSharp/Core/Array.cs

@@ -510,7 +510,7 @@ private static unsafe void ValidateVariantConversionCallbacks()
             if (_convertToVariantCallback == null || _convertToManagedCallback == null)
             {
                 throw new InvalidOperationException(
-                    $"The array element type is not supported for conversion to Variant: '{typeof(T).FullName}'");
+                    $"The array element type is not supported for conversion to Variant: '{typeof(T).FullName}'.");
             }
         }
 

modules/mono/glue/GodotSharp/GodotSharp/Core/Basis.cs

@@ -148,6 +148,9 @@ public Vector3 Scale
         /// Access whole columns in the form of <see cref="Vector3"/>.
         /// </summary>
         /// <param name="column">Which column vector.</param>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// <paramref name="column"/> is not 0, 1, 2 or 3.
+        /// </exception>
         /// <value>The basis column.</value>
         public Vector3 this[int column]
         {
@@ -366,8 +369,8 @@ public Quaternion GetRotationQuaternion()
         /// but are more efficient for some internal calculations.
         /// </summary>
         /// <param name="index">Which row.</param>
-        /// <exception cref="IndexOutOfRangeException">
-        /// Thrown when the <paramref name="index"/> is not 0, 1 or 2.
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// <paramref name="index"/> is not 0, 1 or 2.
         /// </exception>
         /// <returns>One of <c>Row0</c>, <c>Row1</c>, or <c>Row2</c>.</returns>
         public Vector3 GetRow(int index)
@@ -391,8 +394,8 @@ public Vector3 GetRow(int index)
         /// </summary>
         /// <param name="index">Which row.</param>
         /// <param name="value">The vector to set the row to.</param>
-        /// <exception cref="IndexOutOfRangeException">
-        /// Thrown when the <paramref name="index"/> is not 0, 1 or 2.
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// <paramref name="index"/> is not 0, 1 or 2.
         /// </exception>
         public void SetRow(int index, Vector3 value)
         {

modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs

@@ -595,7 +595,7 @@ public Color(string code, float alpha)
         /// </summary>
         /// <param name="rgba">A string for the HTML hexadecimal representation of this color.</param>
         /// <exception name="ArgumentOutOfRangeException">
-        /// Thrown when the given <paramref name="rgba"/> color code is invalid.
+        /// <paramref name="rgba"/> color code is invalid.
         /// </exception>
         private static Color FromHTML(string rgba)
         {

modules/mono/glue/GodotSharp/GodotSharp/Core/Dictionary.cs

@@ -171,7 +171,7 @@ public void Add(Variant key, Variant value)
             var self = (godot_dictionary)NativeValue;
 
             if (NativeFuncs.godotsharp_dictionary_contains_key(ref self, variantKey).ToBool())
-                throw new ArgumentException("An element with the same key already exists", nameof(key));
+                throw new ArgumentException("An element with the same key already exists.", nameof(key));
 
             godot_variant variantValue = (godot_variant)value.NativeVar;
             NativeFuncs.godotsharp_dictionary_add(ref self, variantKey, variantValue);
@@ -381,13 +381,13 @@ private static unsafe void ValidateVariantConversionCallbacks()
             if (_convertKeyToVariantCallback == null || _convertKeyToManagedCallback == null)
             {
                 throw new InvalidOperationException(
-                    $"The dictionary key type is not supported for conversion to Variant: '{typeof(TKey).FullName}'");
+                    $"The dictionary key type is not supported for conversion to Variant: '{typeof(TKey).FullName}'.");
             }
 
             if (_convertValueToVariantCallback == null || _convertValueToManagedCallback == null)
             {
                 throw new InvalidOperationException(
-                    $"The dictionary value type is not supported for conversion to Variant: '{typeof(TValue).FullName}'");
+                    $"The dictionary value type is not supported for conversion to Variant: '{typeof(TValue).FullName}'.");
             }
         }
 
@@ -556,7 +556,7 @@ public unsafe void Add(TKey key, TValue value)
             var self = (godot_dictionary)_underlyingDict.NativeValue;
 
             if (NativeFuncs.godotsharp_dictionary_contains_key(ref self, variantKey).ToBool())
-                throw new ArgumentException("An element with the same key already exists", nameof(key));
+                throw new ArgumentException("An element with the same key already exists.", nameof(key));
 
             using var variantValue = _convertValueToVariantCallback(value);
             NativeFuncs.godotsharp_dictionary_add(ref self, variantKey, variantValue);

modules/mono/glue/GodotSharp/GodotSharp/Core/DisposablesTracker.cs

@@ -83,13 +83,13 @@ public static WeakReference<IDisposable> RegisterDisposable(IDisposable disposab
         public static void UnregisterGodotObject(Object godotObject, WeakReference<Object> weakReferenceToSelf)
         {
             if (!GodotObjectInstances.TryRemove(weakReferenceToSelf, out _))
-                throw new ArgumentException("Godot Object not registered", nameof(weakReferenceToSelf));
+                throw new ArgumentException("Godot Object not registered.", nameof(weakReferenceToSelf));
         }
 
         public static void UnregisterDisposable(WeakReference<IDisposable> weakReference)
         {
             if (!OtherInstances.TryRemove(weakReference, out _))
-                throw new ArgumentException("Disposable not registered", nameof(weakReference));
+                throw new ArgumentException("Disposable not registered.", nameof(weakReference));
         }
     }
 }