isCompatible.m

function compatibleStatus = isCompatible(solverName, printLevel, specificSolverVersion)
% determine the compatibility status of a solver based on the file compatMatrix.rst
%
% USAGE:
%    compatibleStatus = isCompatible(solverName, printLevel, specificSolverVersion)
%
% INPUT:
%    solverName:            Name of the solver
%    printLevel:            verbose level (default: 0)
%    specificSolverVersion: string with specific solver version (example: '12.7.1' or '6.5.1')
%
% OUTPUT:
%    compatibleStatus:      compatibility status
%
%                             * 0: not compatible with the COBRA Toolbox (tested)
%                             * 1: compatible with the COBRA Toolbox (tested)
%                             * 2: unverified compatibility with the COBRA Toolbox (not tested)
%
% .. Author: - Laurent Heirendt, August 2017
%

    global CBTDIR

    % define a default printLevel
    if nargin < 2
        printLevel = 1;
    end

    % determine specific version
    if nargin < 3
        specificSolverVersion = '';
    end

    % define the same interface for tomlab and quadMinos
    if strcmp(solverName, 'tomlab_snopt')
        solverName = 'tomlab_cplex';
    end

    if strcmp(solverName, 'quadMinos')
        solverName = 'dqqMinos';
    end

    if strcmp(solverName, 'lindo_old')
        solverName = 'lindo_legacy';
    end

    % default compatibility status (untested)
    compatibleStatus = 2;

    % check if the solver and the matlab version are compatible
    compatMatrixFile = [CBTDIR filesep 'docs' filesep 'source' filesep 'installation' filesep 'compatMatrix.rst'];

    % read in the file with the compatibility matrix
    persistent C;
    persistent compatMatrix;
    persistent testedOS;

    untestedFlag = false;
    if isempty(compatMatrix)
        C = {};
        compatMatrix = {};
        testedOS = {};
        fid = fopen(compatMatrixFile);
        lineCount = 0;
        while 1

            % save the previous line
            if lineCount > 0
                tline_prev = tline;
            end

            % read in a new line
            tline = fgetl(fid);

            if ~ischar(tline), break; end

            % skip a table line
            if ~isempty(strfind(tline, '+-------------------+')) || ~isempty(strfind(tline, '+====================+'))
                tline = '';
            end

            % if the line is not empty, read it in
            if length(tline) > 1
                if printLevel > 1
                    disp(tline);
                end

                % replace the markers
                tline = strrep(tline, '|x|', ':x:');
                tline = strrep(tline, '|white_check_mark|', ':white_check_mark:');
                tline = strrep(tline, '|warning|', ':warning:');

                if strcmp(tline(1), '|')
                    % split the line at the vertical bar
                    Cpart = strsplit(tline, '|');
                    Cpart = Cpart(2:end-1);

                    % convert incompatible flag
                    Cpart = strrep(Cpart, ':x:', '0');

                    % convert compatible flag
                    Cpart = strrep(Cpart, ':white_check_mark:', '1');

                    % convert untested flag
                    Cpart = strrep(Cpart, ':warning:', '2');

                    C{end+1} = strtrim(Cpart);
                else
                    if ~isempty(C)
                        compatMatrix{end+1} = C;
                        C = {};
                    end
                    if strcmp(tline(1:2), '~~')
                        testedOS{end+1} = strtrim(tline_prev);
                    end
                end
            end
            lineCount = lineCount + 1;
        end
        compatMatrix{end+1} = C;
    end
    % select the compatibility matrix based on the OS
    if isunix && ~ismac % linux
        tableNb = 1;
        resultVERS = system_dependent('getos');
        tmp = strsplit(testedOS{tableNb});
        if ~isempty(strfind(lower(resultVERS), lower(tmp{2})))
            cMatrix = compatMatrix{tableNb};
        else
            untestedFlag = true;
            if printLevel > 0
                fprintf([' > The compatibility can only be evaluated on Linux ', tmp{2}, '.\n']);
            end
        end
    elseif ismac % macOS
        macpos = find(strncmp(testedOS,'macOS',5));
        macOSFound = false;
        [~, resultVERS] = unix('sw_vers');
        for tableNb = macpos %
            tmp = strsplit(testedOS{tableNb});
            if ~isempty(strfind(resultVERS, tmp{2}))
                cMatrix = compatMatrix{tableNb};
                macOSFound = true;
            end
        end
        if ~macOSFound
            untestedFlag = true;
            if printLevel > 0
                fprintf([' > The compatibility can only be evaluated on the following mac OS versions: ', strjoin(testedOS(macpos),', '), '.\n']);
            end
        end
    else % Windows
        resultVERS = system_dependent('getos');
        for tableNb = length(testedOS)-1:length(testedOS) % loop through the last 2 tables
            tmp = strsplit(testedOS{tableNb});
            if ~isempty(strfind(resultVERS, tmp{2}))
                cMatrix = compatMatrix{tableNb};
                break;
            else
                untestedFlag = true;
                if printLevel > 0 && tableNb == length(testedOS)
                    fprintf([' > The compatibility can only be evaluated on Windows 7 and Windows 10.\n']);
                end
            end
        end
    end

    if untestedFlag
        cMatrix = {};
    end

    % determine the version of MATLAB and the corresponding column
    versionMatlab = ['R' version('-release')];
    if ~isempty(cMatrix)
        compatMatlabVersions = cMatrix{1}(2:end);
        colIndexVersion = strmatch(versionMatlab, compatMatlabVersions);
    else
        colIndexVersion = [];
    end

    % any MATLAB version that is not explicitly supported yields a compatibility status of 2
    if isempty(colIndexVersion)
        compatibleStatus = 2;
        if printLevel > 0
            fprintf([' > The solver compatibility is not tested with MATLAB ', versionMatlab, '.\n']);
        end
    else
        % replace any underscores in the solvername
        solverNameAlias = strrep(upper(solverName), '_', '');

        % set the solver version to be checked
        if exist('specificSolverVersion', 'var') && ~isempty(specificSolverVersion)
            solverVersion = strrep(specificSolverVersion, '.', '');
        else
            solverVersion = getCobraSolverVersion(solverName, 0);
        end

        % check compatibility of solver
        for i = 1:length(cMatrix)
            % save the row of the compatibilitx matrix
            row = cMatrix{i};

            % determine the name of the solver
            solverNameRow = row{1};
            solverNameRow = upper(solverNameRow);
            solverNameRow = regexprep(solverNameRow, {'\ ', '\.'}, '');

            % find the correct row
            if strcmpi([solverNameAlias, solverVersion], solverNameRow)
                % retrieve the compatibility status from the table
                compatibilityBoolean = row{colIndexVersion + 1};

                % define output of solverVersion
                if ~isempty(solverVersion),
                    txtSolverVersion = [' (version ', solverVersion, ')'];
                else
                    txtSolverVersion = '';
                end

                % determine the compatibility status
                if strcmpi(compatibilityBoolean, '1')
                    compatibleStatus = 1;
                    if printLevel > 0
                        fprintf([' > ', lower(solverName), txtSolverVersion, ' is compatible and fully tested with MATLAB ', versionMatlab, ' on your operating system.\n']);
                    end
                elseif strcmpi(compatibilityBoolean, '0')
                    compatibleStatus = 0;
                    if printLevel > 0
                        fprintf([' > ', lower(solverName), txtSolverVersion, ' is NOT compatible with MATLAB ', versionMatlab, ' on your operating system.\n']);
                    end
                else
                    compatibleStatus = 2;
                    if printLevel > 0
                        fprintf([' > The compatibility of ', upper(solverName), txtSolverVersion, ' is not fully tested and might not be compatible with MATLAB ', versionMatlab, ' on your operating system.\n']);
                    end
                end
            end
        end
    end

    % special case: cplex_direct
    if strcmp(solverName, 'cplex_direct') && ~verLessThan('matlab', '8.4')
        compatibleStatus = 0;
        if printLevel > 0
            fprintf([' > ', 'cplex_direct is NOT compatible with MATLAB ', versionMatlab, ' on your operating system. Try using the tomlab_cplex interface.\n']);
        end
    end
end