apply argument validation for clarity

time penalty is miniscule

Author: scivision

+stdlib/+dotnet/create_symlink.m

@@ -1,6 +1,10 @@
 %% DOTNET.CREATE_SYMLINK create symbolic link to target
 
 function ok = create_symlink(target, link)
+arguments
+  target (1,1) string
+  link (1,1) string
+end
 
 ok = false;
 

+stdlib/+dotnet/disk_available.m

@@ -1,11 +1,14 @@
 %% DOTNET.DISK_AVAILABLE find the disk space available to the user
 
-function f = disk_available(p)
+function f = disk_available(file)
+arguments
+  file (1,1) string
+end
 
 f = uint64([]);
 
-if ~stdlib.exists(p), return, end
+if ~stdlib.exists(file), return, end
 
-f = uint64(System.IO.DriveInfo(stdlib.absolute(p)).AvailableFreeSpace());
+f = uint64(System.IO.DriveInfo(stdlib.absolute(file)).AvailableFreeSpace());
 % https://learn.microsoft.com/en-us/dotnet/api/system.io.driveinfo.availablefreespace
 end

+stdlib/+dotnet/disk_capacity.m

@@ -1,12 +1,15 @@
 %% DOTNET.DISK_CAPACITY find the overall disk capacity visible to user
 
-function f = disk_capacity(d)
+function f = disk_capacity(file)
+arguments
+  file (1,1) string
+end
 
 f = uint64([]);
 
-if ~stdlib.exists(d), return, end
+if ~stdlib.exists(file), return, end
 
-f = uint64(System.IO.DriveInfo(stdlib.absolute(d)).TotalSize());
+f = uint64(System.IO.DriveInfo(stdlib.absolute(file)).TotalSize());
 % https://learn.microsoft.com/en-us/dotnet/api/system.io.driveinfo.totalsize
 
 end

+stdlib/+dotnet/file_checksum.m

@@ -3,6 +3,10 @@
 % Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/security/MessageDigest.html#getInstance(java.lang.String)
 
 function hash = file_checksum(file, hash_method)
+arguments
+  file (1,1) string
+  hash_method (1,1) string
+end
 
 if any(strcmp(hash_method, {'sha256', 'SHA256'}))
   hash_method = "SHA-256";

+stdlib/+dotnet/filesystem_type.m

@@ -1,6 +1,9 @@
 %% DOTNET.FILESYSTEM_TYPE type of the partition e.g. NTFS, ext4, ...
 
 function t = filesystem_type(file)
+arguments
+  file (1,1) string
+end
 
 if stdlib.exists(file)
   t = char(System.IO.DriveInfo(stdlib.absolute(file)).DriveFormat);

+stdlib/+dotnet/get_owner.m

@@ -1,6 +1,9 @@
 %% DOTNET.GET_OWNER get the owner of a filepath
 
-function o = get_owner(p)
+function o = get_owner(file)
+arguments
+  file (1,1) string
+end
 
 % This is not yet possible with .NET on Unix, even with .NET 10.
 % It would require Pinvoke or external Mono.Unix
@@ -12,10 +15,10 @@
   return
 end
 
-if isfolder(p)
-  fsec = System.IO.Directory.GetAccessControl(p);
-elseif isfile(p)
-  fsec = System.IO.File.GetAccessControl(p);
+if isfolder(file)
+  fsec = System.IO.Directory.GetAccessControl(file);
+elseif isfile(file)
+  fsec = System.IO.File.GetAccessControl(file);
 else
   o = "";
   return

+stdlib/+dotnet/is_removable.m

@@ -3,6 +3,9 @@
 % Ref: https://learn.microsoft.com/en-us/dotnet/api/system.io.drivetype
 
 function y = is_removable(filepath)
+arguments
+  filepath (1,1) string
+end
 
 if stdlib.exists(filepath)
   fmt = System.IO.DriveInfo(stdlib.absolute(filepath)).DriveType;

+stdlib/+dotnet/is_symlink.m

@@ -1,12 +1,15 @@
 %% DOTNET.IS_SYMLINK check if a file is a symbolic link
 
-function y = is_symlink(p)
+function y = is_symlink(file)
+arguments
+  file (1,1) string
+end
 
 try
   if stdlib.dotnet_api() >= 6
-    y = ~isempty(System.IO.FileInfo(p).LinkTarget);
+    y = ~isempty(System.IO.FileInfo(file).LinkTarget);
   else
-    attr = string(System.IO.File.GetAttributes(p).ToString());
+    attr = string(System.IO.File.GetAttributes(file).ToString());
     % https://learn.microsoft.com/en-us/dotnet/api/system.io.fileattributes
     % ReparsePoint is for Linux, macOS, and Windows
     y = contains(attr, 'ReparsePoint');

+stdlib/+dotnet/read_symlink.m

@@ -1,6 +1,9 @@
 %% DOTNET.READ_SYMLINK resolve the symbolic links of a filepath
 
 function r = read_symlink(file)
+arguments
+  file (1,1) string
+end
 
 try
   h = System.IO.FileInfo(file);

+stdlib/+java/device.m

@@ -1,4 +1,7 @@
 function i = device(file)
+arguments
+  file (1,1) string
+end
 
 i = uint64([]);
 if ~stdlib.exists(file), return, end