mex.m

Go to the documentation of this file.

%>  \brief
%>  Return the vector of MATLAB strings containing the
%>  path(s) to the ParaMonte library MEX shared files.
%>
%>  \param[in]  mexname :   The input scalar MATLAB string containing
%>                          the (partial) name of a MEX file name without MEX extension.<br>
%>                          (**optional**. If missing, all detected paths will be returned.)
%>
%>  \param[in]  config  :   The input scalar (or vector of) MATLAB string(s) containing the
%>                          (set of) keyword(s) to match in the identified MEX files paths.<br>
%>                          (**optional**. If missing, all detected paths will be returned.)
%>
%>  \return
%>  ``mexpaths``        :   The output vector of MATLAB strings containing the
%>                          path(s) to the ParaMonte library MEX shared files.<br>
%>                          The output ``mexpaths`` will be an empty list
%>                          if no such paths are found.<br>
%>
%>  \interface{mex}
%>  \code{.m}
%>
%>      mexpaths = pm.lib.path.mex()
%>      mexpaths = pm.lib.path.mex([])
%>      mexpaths = pm.lib.path.mex([], [])
%>      mexpaths = pm.lib.path.mex(mexname)
%>      mexpaths = pm.lib.path.mex([], config)
%>      mexpaths = pm.lib.path.mex(mexname, [])
%>      mexpaths = pm.lib.path.mex(mexname, config)
%>
%>  \endcode
%>
%>  \example{mex}
%>  \include{lineno} example/lib/path/mex/main.m
%>  \output{mex}
%>  \include{lineno} example/lib/path/mex/main.out.m
%>
%>  \final{mex}
%>
%>  \author
%>  \JoshuaOsborne, May 21 2024, 7:41 PM, 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 mexpaths = mex(mexname, config)
    if  nargin < 2
        config = [];
    end
    if  nargin < 1
        mexname = [];
    end
    if ~isempty(config)
        pm.introspection.verify(config, "string", 255, "config");
        %configList = strsplit(config, ":");
        configList = string(config);
    else
        configList = [];
    end
    if ~isempty(mexname)
        pm.introspection.verify(mexname, "string", 1, "mexname");
    else
        mexname = "";
    end
    libdir = pm.lib.path.lib();
    mexpaths = pm.sys.path.glob(fullfile(libdir, "**" + mexname + "*" + mexext));
    if ~isempty(configList) && ~isempty(mexpaths)
        libdirlen = length(libdir{1});
        indices = [];
        for i = 1 : length(mexpaths)
            path = mexpaths{i};
            matching = true;
            for j = 1 : length(configList)
                key = configList{j};
                if ~contains(path(libdirlen + 1 : end), key)
                    matching = false;
                    break;
                end
            end
            if  matching
                indices = [indices, i];
            end
        end
        mexpaths = mexpaths(indices);
    end
end