optional tell backend

Author: scivision

+stdlib/canonical.m

@@ -11,8 +11,9 @@
 % * strict: if true, only return canonical path if it exists. If false, return normalized path if path does not exist.
 %%% Outputs
 % * c: canonical path, if determined
+% * b: backend used
 
-function c = canonical(p, strict, backend)
+function [c, b] = canonical(p, strict, backend)
 arguments
   p string
   strict (1,1) logical = false

+stdlib/is_exe.m

@@ -1,8 +1,13 @@
 %% IS_EXE is file executable
+% does not check if the file is actually a binary executable
 %
-% false if not a file
+%% Inputs
+% file: path to check
+%% Outputs
+% ok: true if path is a file and has executable permissions
+% b: backend used
 
-function y = is_exe(file, backend)
+function [ok, b] = is_exe(file, backend)
 arguments
   file string
   backend (1,:) string = ["java", "python", "native", "legacy"]
@@ -12,9 +17,9 @@
 [fun, b] = hbackend(backend, "is_exe", 'R2025a');
 
 if isscalar(file) || b == "native"
-  y = fun(file);
+  ok = fun(file);
 else
-  y = arrayfun(fun, file);
+  ok = arrayfun(fun, file);
 end
 
 end

+stdlib/is_readable.m

@@ -4,8 +4,9 @@
 % file: single path string
 %% Outputs
 % ok: true if file is readable
+% b: backend used
 
-function y = is_readable(file, backend)
+function [ok, b] = is_readable(file, backend)
 arguments
   file string
   backend (1,:) string = ["java", "native", "legacy"]
@@ -14,9 +15,9 @@
 [fun, b] = hbackend(backend, "is_readable", 'R2025a');
 
 if isscalar(file) || b == "native"
-  y = fun(file);
+  ok = fun(file);
 else
-  y = arrayfun(fun, file);
+  ok = arrayfun(fun, file);
 end
 
 end

+stdlib/is_symlink.m

@@ -1,6 +1,12 @@
 %% IS_SYMLINK is path a symbolic link
+%
+%% Inputs
+% file: path to check
+%% Outputs
+% ok: true if path is a symbolic link
+% b: backend used
 
-function ok = is_symlink(file, backend)
+function [ok, b] = is_symlink(file, backend)
 arguments
   file string
   backend (1,:) string = ["native", "java", "dotnet", "python", "sys"]

+stdlib/is_writable.m

@@ -4,8 +4,9 @@
 % file: path to file or folder
 %% Outputs
 % ok: true if file is writable
+% b: backend used
 
-function y = is_writable(file, backend)
+function [ok, b] = is_writable(file, backend)
 arguments
   file string
   backend (1,:) string = ["java", "native", "legacy"]
@@ -14,9 +15,9 @@
 [fun, b] = hbackend(backend, "is_writable", 'R2025a');
 
 if isscalar(file) || b == "native"
-  y = fun(file);
+  ok = fun(file);
 else
-  y = arrayfun(fun, file);
+  ok = arrayfun(fun, file);
 end
 
 end

+stdlib/read_symlink.m

@@ -2,8 +2,14 @@
 %
 % empty string if path is not a symlink
 % always of string class in Matlab
+%
+%% Inputs
+% file: path to symbolic link
+%% Outputs
+% r: target of symbolic link
+% b: backend used
 
-function r = read_symlink(file, backend)
+function [r, b] = read_symlink(file, backend)
 arguments
   file string
   backend (1,:) string = ["native", "java", "dotnet", "python", "sys"]

+stdlib/samepath.m

@@ -9,10 +9,13 @@
 %
 % Ref: https://devblogs.microsoft.com/oldnewthing/20220128-00/?p=106201
 %
-%%% Inputs
+%% Inputs
 % * path1, path2: paths to compare
+%% Outputs
+% * ok: true if paths are the same
+% * b: backend used
 
-function y = samepath(path1, path2, backend)
+function [ok, b] = samepath(path1, path2, backend)
 arguments
   path1 string
   path2 string
@@ -24,9 +27,9 @@
 [fun, b] = hbackend(backend, "samepath");
 
 if (isscalar(path1) && isscalar(path2)) || b == "native"
-  y = fun(path1, path2);
+  ok = fun(path1, path2);
 else
-  y = arrayfun(fun, path1, path2);
+  ok = arrayfun(fun, path1, path2);
 end
 
 end