% UTP_PLIST_PARSE a set of UTPs for the plist/parse method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_parse.m,v 1.3 2009/07/22 14:02:26 ingo Exp $
%

% <MethodDescription>
%
% The append method of the plist class parse a plist for strings which can
% be converted into numbers depending on the default plist.
%
% </MethodDescription>

function results = utp_plist_parse(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'plist';
    mthd    = 'parse';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    % Exception list for the UTPs:
    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();

    % Run the tests
    results = [results utp_01];    % getInfo call
    results = [results utp_02];    % Vector input
    results = [results utp_03];    % Matrix input
    results = [results utp_04];    % List input
    results = [results utp_05];    % Test with mixed input
    results = [results utp_06];    % Test non-dependent elements
    results = [results utp_07];    % Test dependent elements
    results = [results utp_08];    % Test upper/lower case doesn't matter
    
    disp('Done.');
    disp('******************************************************');
    
  elseif nargin == 1 % Check for UTP functions
    if strcmp(varargin{1}, 'isutp')
      results = 1;
    else
      results = 0;
    end
  else
    error('### Incorrect inputs')
  end
  
  %% UTP_01
  
  % <TestDescription>
  %
  % Tests that the getInfo call works for this method.
  %
  % </TestDescription>
  function result = utp_01
    
    
    % <SyntaxDescription>
    %
    % Test that the getInfo call works for no sets, all sets, and each set
    % individually.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Call for no sets
      io(1) = eval([class '.getInfo(''' mthd ''', ''None'')']);
      % Call for all sets
      io(2) = eval([class '.getInfo(''' mthd ''')']);
      % Call for each set
      for kk=1:numel(io(2).sets)
        io(kk+2) = eval([class '.getInfo(''' mthd ''', ''' io(2).sets{kk} ''')']);
      end
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that getInfo call returned an minfo object in all cases.
    % 2) Check that all plists have the correct parameters.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % check we have minfo objects
      if isa(io, 'minfo')
        % SET 'None'
        if ~isempty(io(1).sets), atest = false; end
        if ~isempty(io(1).plists), atest = false; end
        % Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
        % SET 'Default'
        if io(3).plists.nparams ~= 0, atest = false; end
        % Check key
        % Check default value
        % Check options
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_01
  
  %% UTP_02
  
  % <TestDescription>
  %
  % Tests that the parse method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % The parse method is an internal method and it doesn't work for vector
    % of PLIST objects as an input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_02
  
  %% UTP_03
  
  % <TestDescription>
  %
  % Tests that the parse method works with a matrix of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % The parse method is an internal method and it doesn't work for matrix
    % of PLIST objects as an input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to test
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_03
  
  %% UTP_04
  
  % <TestDescription>
  %
  % Tests that the parse method works with a list of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % The parse method is an internal method and it doesn't work for list
    % of PLIST objects as an input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to check.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_04
  
  %% UTP_05
  
  % <TestDescription>
  %
  % Tests that the parse method works with a mix of different shaped PLIST
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % The parse method is an internal method and it doesn't work for
    % different shaped PLIST objects as input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_05
  
  %% UTP_06
  
  % <TestDescription>
  %
  % Tests that the parse method with non-dependent elements.
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the parse method can convert non-dependent elements.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl  = plist('convert pi', 'pi', ...
                  'equation', 'sin(pi/2)', ...
                  'convert not pi', 'pi', ...
                  'randn', 'randn(12,1)');
      pld = plist('convert pi', [], ...
                  'equation', [], ...
                  'randn', [], ...
                  'other param in def. pl', 'yes');
      out = parse(pl, pld);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the right number of parameter in out.
    % 2) Check that the correct values are converted.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % The output must have all parameter in the parse-PLIST (here: 3)
      % plus all parameter which are in the in the default plist and not in
      % the parse-PLIST (here: 1).
      if out.nparams ~= 5, atest = false; end
      if ~out.isparam('convert pi'), atest = false; end
      if ~out.isparam('equation'), atest = false; end
      if ~out.isparam('convert not pi'), atest = false; end
      if ~out.isparam('other param in def. pl'), atest = false; end
      if ~out.isparam('randn'), atest = false; end
      % Check the parsed elements.
      if ~isequal(out.find('convert pi'), pi), atest = false; end
      if ~isequal(out.find('equation'), sin(pi/2)), atest = false; end
      if ~isequal(out.find('convert not pi'), 'pi'), atest = false; end
      if ~isequal(out.find('other param in def. pl'), 'yes'), atest = false; end
      if numel(out.find('randn')) ~= 12, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06
  
  %% UTP_07
  
  % <TestDescription>
  %
  % Tests that the parse method with dependent elements.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Test that the parse method can convert dependent elements.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl1  = plist('a', '1+d', 'b', 2, 'c', 'a+b', 'd', 'b+c');
      pl2  = plist('a', '1+d', 'b', 2, 'c', 'a+b', 'd', 'b');
      pld = plist('a', [], 'b', [], 'c', [], 'd', []);
      out1 = parse(pl1, pld);
      out2 = parse(pl2, pld);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the right number of parameter in out.
    % 2) Check that the correct values are converted.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % All parameters in the first plist are dependent to each other. It
      % is not possible to solve this equations.
      if ~isequal(out1.find('a'), '1+d'), atest = false; end
      if ~isequal(out1.find('b'), 2), atest = false; end
      if ~isequal(out1.find('c'), 'a+b'), atest = false; end
      if ~isequal(out1.find('d'), 'b+c'), atest = false; end
      % It should be possible to solve the dependent in the second plist.
      if ~isequal(out2.find('a'), 3), atest = false; end
      if ~isequal(out2.find('b'), 2), atest = false; end
      if ~isequal(out2.find('c'), 5), atest = false; end
      if ~isequal(out2.find('d'), 2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07
  
  %% UTP_08
  
  % <TestDescription>
  %
  % Tests that upper/lower case doesn't matter in the parse method.
  %
  % </TestDescription>
  function result = utp_08
    
    % <SyntaxDescription>
    %
    % Tests that upper/lower case doesn't matter in the parse method.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl  = plist('FirsT', '1', 'SecoNd', 2, 'Third', 'Fourth + SECond + First', 'fourth', 'SECOND');
      pld = plist('first', [], 'second', [], 'third', [], 'fourth', []);
      out = parse(pl, pld);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the right number of parameter in out.
    % 2) Check that the correct values are converted.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check the converted values.
      if ~isequal(out.find('first'),  1), atest = false; end
      if ~isequal(out.find('second'), 2), atest = false; end
      if ~isequal(out.find('third'),  5), atest = false; end
      if ~isequal(out.find('fourth'), 2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_08
  
end
