list.m

Go to the documentation of this file.

%>  \brief
%>  Return a cell vector of MATLAB string values each of which
%>  corresponds to one **non-default** file or folder path
%>  in the specified input directory path.<br>
%>
%>  \note
%>  The primary use of this function is to create a list of items
%>  in a given folder while excluding the default system items
%>  which includes the current and parent directories.<br>
%>
%>  \param[in]  path    :   The input scalar MATLAB string or character containing the path to an
%>                          existing directory whose file and folder contents should be listed,
%>                          excluding the default ``"."`` and ``".."`` system paths.<br>
%>                          (**optional**, default = ``"."``)
%>
%>  \return
%>  ``namelist``        :   A MATLAB cell vector, each element of which corresponds to an existing
%>                          non-default file or folder in the specified input directory path.<br>
%>                          If the input path contains a base directory name, the name will
%>                          be prefixed to each item in the output ``namelist``.<br>
%>                          If the input `path` is not a directory or is empty,
%>                          the output `namelist` will be empty.<br>
%>
%>  \interface{list}
%>  \code{.m}
%>
%>      namelist = pm.sys.path.list()
%>      namelist = pm.sys.path.list(path)
%>
%>  \endcode
%>
%>  \example{list}
%>  \include{lineno} example/sys/path/list/main.m
%>  \output{list}
%>  \include{lineno} example/sys/path/list/main.out.m
%>
%>  \final{list}
%>
%>  \author
%>  \JoshuaOsborne, May 21 2024, 5:26 AM, University of Texas at Arlington<br>
%>  \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
%>  \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
function namelist = list(path)
    if  nargin < 1
        path = ".";
    end
    namelist = [];
    if  isfolder(path)
        [dirname, ~, ~] = fileparts(path);
        fileSpecList = dir(path);
        namelistRaw = string({fileSpecList.name});
        namelistLen = length(namelistRaw);
        cleanListLen = namelistLen - (any(strcmp(namelistRaw, ".")) + any(strcmp(namelistRaw, "..")));
        if cleanListLen == namelistLen
            namelist = fullfile(dirname, namelistRaw);
        else
            namelist = strings([cleanListLen, 1]);
            counter = 0;
            for i = 1 : namelistLen
                if ~(strcmp(namelistRaw(i), ".") || strcmp(namelistRaw(i), ".."))
                    counter = counter + 1;
                    namelist(counter) = fullfile(dirname, namelistRaw(i));
                end
            end
        end
    end
end