update setDefaultsPTB to new cfg

Author: Remi-Gau

setDefaultsPTB.m

@@ -1,5 +1,8 @@
 function cfg = setDefaultsPTB(cfg)
-
+    % cfg = setDefaultsPTB(cfg)
+    %  
+    % Set some defaults values if none have been set before.
+    
     if nargin < 1
         cfg = struct;
     end
@@ -13,21 +16,21 @@
     fieldsToSet.keyboard.responseKey = {};
     fieldsToSet.keyboard.escapeKey = 'ESCAPE';
 
-    fieldsToSet.debug = true;
-    fieldsToSet.testingTranspScreen = true;
-    fieldsToSet.testingSmallScreen = true;
+    fieldsToSet.debug.do = true;
+    fieldsToSet.debug.transpWin = true;
+    fieldsToSet.debug.smallWin = true;
 
-    fieldsToSet.backgroundColor = [0 0 0];
+    fieldsToSet.color.background = [0 0 0];
 
     % text defaults
     fieldsToSet.text.font = 'Courier New';
     fieldsToSet.text.size = 18;
     fieldsToSet.text.style = 1;
 
-    fieldsToSet.monitorWidth = 42;
-    fieldsToSet.screenDistance = 134;
+    fieldsToSet.screen.monitorWidth = 42;
+    fieldsToSet.screen.monitorDistance = 134;
 
-    if isfield(cfg, 'initAudio') && cfg.initAudio
+    if isfield(cfg, 'audio') && cfg.audio.do
 
         fieldsToSet.audio.fs = 44800;
         fieldsToSet.audio.channels = 2;
@@ -47,7 +50,7 @@
     end
 
     if isfield(cfg, 'testingDevice') && strcmpi(cfg.testingDevice, 'mri')
-        fieldsToSet.bids.MRI.RepetitionTime = [];
+        fieldsToSet.bids.mri.RepetitionTime = [];
     end
 
     cfg = setDefaults(cfg, fieldsToSet);
@@ -58,20 +61,36 @@
 end
 
 function structure = setDefaults(structure, fieldsToSet)
-    % loop through the defaults fiels to set and update if they don't exist
+    % structure = setDefaultFields(structure, fieldsToSet)
+    %
+    % recursively loop through the fields of a structure and sets a value if they don't exist
+    %
+
+    fieldsToSet = orderfields(fieldsToSet);
 
     names = fieldnames(fieldsToSet);
 
     for i = 1:numel(names)
 
         thisField = fieldsToSet.(names{i});
-        structure = setFieldToIfNotPresent( ...
-            structure, ...
-            names{i}, ...
-            thisField);
+
+        if isfield(structure, names{i}) && isstruct(structure.(names{i}))
+
+            structure.(names{i}) = ...
+                setDefaultFields(structure.(names{i}), fieldsToSet.(names{i}));
+
+        else
+
+            structure = setFieldToIfNotPresent( ...
+                structure, ...
+                names{i}, ...
+                thisField);
+        end
 
     end
 
+    structure = orderfields(structure);
+
 end
 
 function structure = setFieldToIfNotPresent(structure, fieldName, value)

tests/test_setDefaultsPTB.m

@@ -1,56 +1,101 @@
-%% test basic cfg creation
-
-% set up
-cfgToTest =  struct( ...
-    'testingDevice', 'pc', ...
-    'debug',  true, ...
-    'testingTranspScreen',  true, ...
-    'testingSmallScreen',  true, ...
-    'backgroundColor',  [0 0 0], ...
-    'text', struct('font', 'Courier New', 'size', 18, 'style', 1),  ...
-    'monitorWidth', 42, ...
-    'screenDistance', 134);
-
-cfgToTest.keyboard.keyboard = [];
-cfgToTest.keyboard.responseBox = [];
-cfgToTest.keyboard.responseKey = {};
-cfgToTest.keyboard.escapeKey = 'ESCAPE';
-
-cfgToTest = orderfields(cfgToTest);
-
-% test
-cfg = setDefaultsPTB;
-assert(isequal(cfg, cfgToTest));
-
-%% test that values are not overwritten
-clear cfg;
-cfg = struct('monitorWidth', 36);
-
-cfgToTest.monitorWidth = 36;
-
-cfg = setDefaultsPTB(cfg);
-assert(isequal(cfg, cfgToTest));
-
-cfgToTest.monitorWidth = 42;
-
-%% test with audio init
-
-% set up
-cfgToTest.initAudio = 1;
-cfgToTest.audio = struct( ...
-    'fs', 44800, ...
-    'channels', 2, ...
-    'initVolume', 1, ...
-    'requestedLatency', 3, ...
-    'repeat', 1, ...
-    'startCue', 0, ...
-    'waitForDevice', 1);
-
-cfgToTest = orderfields(cfgToTest);
-
-clear cfg;
-cfg.initAudio = 1;
-
-% test
-cfg = setDefaultsPTB(cfg);
-assert(isequal(cfg, cfgToTest));
+function test_setDefaultsPTB()
+    
+    %% test basic cfg creation
+    
+    % test data
+    expectedCFG = returnExpectedCFG();
+    
+    % test
+    cfg = setDefaultsPTB;
+    testSubFields(expectedCFG, cfg)
+    
+    %% test that values are not overwritten
+    
+    clear cfg
+    
+    % test data
+    expectedCFG = returnExpectedCFG();
+    expectedCFG.screen.monitorWidth = 36;
+    
+    % set up
+    cfg.screen.monitorWidth = 36;
+    
+    % test
+    cfg = setDefaultsPTB(cfg);
+    testSubFields(expectedCFG, cfg)
+    
+    %% test with audio init
+    
+    clear cfg
+    
+    % test data
+    expectedCFG = returnExpectedCFG();
+    expectedCFG.audio = struct( ...
+        'do', true, ...
+        'fs', 44800, ...
+        'channels', 2, ...
+        'initVolume', 1, ...
+        'requestedLatency', 3, ...
+        'repeat', 1, ...
+        'startCue', 0, ...
+        'waitForDevice', 1);
+    
+    % set up
+    cfg.audio.do = 1;
+    
+    % test
+    cfg = setDefaultsPTB(cfg);
+    testSubFields(expectedCFG, cfg)
+    
+    
+end
+
+
+function expectedCFG = returnExpectedCFG()
+    
+    expectedCFG =  struct( ...
+        'testingDevice', 'pc', ...
+        'debug',  struct('do', true, 'transpWin',  true, 'smallWin',  true), ...
+        'color',  struct( ...
+        'background', [0 0 0]), ...
+        'text', struct('font', 'Courier New', 'size', 18, 'style', 1),  ...
+        'screen', struct( ...
+        'monitorWidth', 42, ...
+        'monitorDistance', 134));
+    
+    expectedCFG.keyboard.keyboard = [];
+    expectedCFG.keyboard.responseBox = [];
+    expectedCFG.keyboard.responseKey = {};
+    expectedCFG.keyboard.escapeKey = 'ESCAPE';
+    
+end
+
+function testSubFields(expectedStructure, cfg)
+    % check that that the structures match
+    % if it fails it check from which subfield the error comes from
+
+    try
+
+        assert(isequal(expectedStructure, cfg));
+
+    catch ME
+
+        if isstruct(expectedStructure)
+
+            names = fieldnames(expectedStructure);
+
+            for i = 1:numel(names)
+
+                disp(names{i});
+                testSubFields(expectedStructure.(names{i}), cfg.(names{i}));
+
+            end
+
+        end
+
+        expectedStructure;
+        cfg;
+
+        rethrow(ME);
+    end
+end