parseparext.m

Go to the documentation of this file.

function [reg,isRegSpecVec,varargout]=parseparext(args,propNameValMat,varargin)
import mxberry.core.check.*;
import mxberry.core.checkvar;
import mxberry.core.ismembercellstr;
import mxberry.core.throwerror;
%
if ~isempty(propNameValMat)
    if ~(ischar(propNameValMat)&&lib.isrow(propNameValMat)||...
            iscell(propNameValMat)&&ismatrix(propNameValMat)&&...
            (size(propNameValMat,1)==1||size(propNameValMat,1)==2||...
            size(propNameValMat,1)==3&&...
            lib.iscellofstrorfunc(propNameValMat(3,:))&&...
            iscellstr(propNameValMat(1,:))))
        throwerror('wrongInput',...
            'propNameValMat is badly formed');
    end
    %
    propNameList=propNameValMat(1,:);
    if ischar(propNameList)
        propNameList={lower(propNameList)};
    else
        propNameList=lower(propNameList);
    end
    %
    isDefSpec=size(propNameValMat,1)>1;
    isCheckSpec=size(propNameValMat,1)>2;
    isPropNameSpec=true;
else
    isPropNameSpec=false;
    isDefSpec=false;
    propNameList=propNameValMat;
    isCheckSpec=false;
end
[inpReg,inpProp]=mxberry.core.parseparams(varargin,...
    {'regCheckList','regDefList','propRetMode','isObligatoryPropVec',...
    'isDefaultPropSpecVec'});
%
if ~isempty(inpReg)&&~isempty(inpReg{1})
    isNRegExpSpec=true;
    nRegExpVec=inpReg{1};
    if numel(nRegExpVec)==1
        nRegExpVec=[nRegExpVec,nRegExpVec];
    end
else
    isNRegExpSpec=false;
    nRegExpVec=[0,Inf];
end
[reg,prop]=mxberry.core.parseparams(args,propNameList,inpReg{:});
%
nRegs=length(reg);
isRegDefListSpec=false;
isPropRetModeSpec=false;
isObligatoryPropVecSpec=false;
isDefPropIndicatorSpec=false;
if ~isempty(inpProp)
    nInpProps=length(inpProp);
    for iInpProp=1:2:nInpProps-1
        switch lower(inpProp{iInpProp})
            case 'regchecklist'
                regCheckList=inpProp{iInpProp+1};
                checkvar(regCheckList,...
                    @(x)iscell(x)&&lib.isrow(x)&&...
                    (~isNRegExpSpec&&numel(x)>=nRegs||...
                    isNRegExpSpec&&numel(x)<=nRegExpVec(2)));
                %
                for iReg=1:nRegs
                    checkgen(reg{iReg},regCheckList{iReg},...
                        sprintf('regular arg #%d',iReg),'nCallerStackStepsUp',2);
                end
            case 'regdeflist'
                regDefList=inpProp{iInpProp+1};
                checkgen(regDefList,...
                    @(x)iscell(x)&&lib.isrow(x)&&...
                    (isNRegExpSpec&&...
                    numel(x)<=nRegExpVec(2)&&...
                    numel(x)>=nRegExpVec(1)||~isNRegExpSpec));
                isRegDefListSpec=true;
            case 'propretmode'
                propRetMode=inpProp{iInpProp+1};
                checkgen(propRetMode,...
                    @(x)lib.isstring(x)&&any(strcmpi(x,{'list','separate'})));
                propRetMode=lower(propRetMode);
                isPropRetModeSpec=true;
            case 'isobligatorypropvec'
                isObligatoryPropVec=inpProp{iInpProp+1};
                checkgen(isObligatoryPropVec,'islogical(x)&&isrow(x)');
                if ~isPropNameSpec
                    throwerror('wrongInput',...
                        ['isObligatoryPropVec property is allowed only ',...
                        'when property names are specified']);
                end
                isObligatoryPropVecSpec=true;
                %
            case 'isdefaultpropspecvec'
                isDefaultPropSpecVec=inpProp{iInpProp+1};
                checkgen(isDefaultPropSpecVec,'islogical(x)&&isrow(x)');
                if ~isDefSpec
                    throwerror('wrongInput:defPropSpecVecNoDefValues',...
                        ['isDefaultPropSpecVec property is allowed only ',...
                        'when default property values are specified']);
                end
                isDefPropIndicatorSpec=true;
            otherwise
                throwerror('wrongInput','Oops, we shouldn''t be here');
        end
    end
end
if ~isPropRetModeSpec
    if isPropNameSpec
        propRetMode='separate';
    else
        propRetMode='list';
    end
end
if isDefPropIndicatorSpec&&strcmp(propRetMode,'separate')
    throwerror('wrongInput:defPropSpecVecNotInListMode',...
        'isDefaultPropSpecVec is not supported when propRetMode=separate');
    
end
if ~isPropNameSpec&&strcmp(propRetMode,'separate')
    throwerror('wrongInput',...
        'propRetMode=separate is not supported for empty propNameValMat');
end
%
if isRegDefListSpec
    nRegDefs=length(regDefList);
    if nRegDefs>nRegs
        reg=[reg,cell(1,nRegDefs-nRegs)];
        isRegSpecVec=[true(1,nRegs),false(1,nRegDefs-nRegs)];
        for indArg=nRegs+1:nRegDefs
            reg{indArg}=regDefList{indArg};
        end
    else
        isRegSpecVec=true(1,nRegs);
    end
else
    isRegSpecVec=true(1,nRegs);
end
%
nElems=length(prop);
propResNameList=lower(prop(1:2:nElems-1));
propResValList=prop(2:2:nElems);
[isUnique,propUResNameList]=mxberry.core.isunique(propResNameList);
if ~isUnique
    nResProps=nElems*0.5;
    [~,indThereVec]=ismember(propResNameList,propUResNameList);
    nResPropSpecVec=accumarray(indThereVec.',ones(nResProps,1));
    isPropDupVec=nResPropSpecVec>1;
    dupPropListStr=mxberry.core.cell.cellstr2expression(...
        propUResNameList(isPropDupVec));
    throwerror('wrongInput:duplicatePropertiesSpec',...
        sprintf('properties %s are specified more than once',...
        dupPropListStr));
end
%
if isPropNameSpec
    [isPropSpecVec,indLocVec]=ismembercellstr(propNameList,propResNameList);
    propValList=cell(size(propNameList));
    propValList(isPropSpecVec)=propResValList(indLocVec(isPropSpecVec));
    if isDefSpec
        propValList(~isPropSpecVec)=propNameValMat(2,~isPropSpecVec);
    end
    if isCheckSpec&&any(isPropSpecVec)
        cellfun(@(x,y,z)checkgen(x,y,z,'nCallerStackStepsUp',2),...
            propValList(isPropSpecVec),...
            propNameValMat(3,isPropSpecVec),...
            strcat('property:',propNameList(isPropSpecVec)));
    end
    nProps=length(propNameList);
else
    isPropSpecVec=true(size(propResNameList));
    propValList=propResValList;
    nProps=length(propResValList);
end
if isObligatoryPropVecSpec
    isObligAndNotSpecVec=~isPropSpecVec&isObligatoryPropVec;
    if any(isObligAndNotSpecVec)
        throwerror('wrongInput',['property(es) %s are obligatory but ',...
            'were not specified'],...
            mxberry.core.cell.cell2tablestr([],...
            propNameList(isObligAndNotSpecVec),','));
    end
end
%
nOut=nargout-2;
switch propRetMode
    case 'list'
        if nOut>2
            throwerror('wrongInput',...
                ['retPropAsList=true so number of ',...
                'output arguments cannot exceed 4']);
        end
        if nOut>0
            if isPropNameSpec
                if isDefPropIndicatorSpec
                    isPropFilledVec=isPropSpecVec|...
                        isDefSpec&isDefaultPropSpecVec;
                else
                    isPropFilledVec=isPropSpecVec|...
                        isDefSpec;
                end
                %
                prop=[propNameList(isPropFilledVec);...
                    propValList(isPropFilledVec)];
                varargout{1}=transpose(prop(:));
            else
                varargout{1}=prop;
            end
            if nOut>1
                varargout{2}=isPropSpecVec;
            end
        end
    case 'separate'
        if nOut>2*nProps
            throwerror('wrongInput',...
                'number of output arguments cannot exceed 2+ 2*nProperties');
        end
        %
        varargout(1:min(nOut,nProps))=propValList(1:min(nOut,nProps));
        if nOut>nProps
            varargout((nProps+1):min(nOut,2*nProps))=...
                num2cell(isPropSpecVec(1:min(nOut-nProps,nProps)));
        end
    otherwise
        throwerror('wrongInput',...
            'Oops, we shouldn''t be here');
end