add more input checks and error handling to saveEvents

Author: Remi-Gau

saveEventsFile.m

@@ -47,8 +47,7 @@
     end
 
     if nargin < 3 || isempty(logFile)
-        logFile = struct('filename', [], 'extraColumns', cell(1));
-        logFile(1).filename = '';
+        logFile = checklLogFile('init');
     end
 
     switch action
@@ -67,9 +66,8 @@
 
         case 'save'
 
-            if ~isstruct(logFile) || size(logFile, 2) > 1
-                error('The variable containing the n events to save must be a nx1 structure.');
-            end
+            checklLogFile('checkID', logFile);
+            checklLogFile('type&size', logFile);
 
             % appends to the logfile all the data stored in the structure
             % first with the standard BIDS data and then any extra things
@@ -103,6 +101,8 @@
 
         case 'close'
 
+            checklLogFile('checkID', logFile);
+
             % close txt log file
             fclose(logFile(1).fileID);
 
@@ -113,16 +113,40 @@
                 logFile.filename));
 
         otherwise
-            errorStruct.message = 'unknown action for saveEventsFile';
-            errorStruct.identifier = 'saveEventsFile:unknownActionType';
-            error(errorStruct);
+
+            errorSaveEventsFile('unknownActionType');
 
     end
 
     logFile = resetLogFileVar(logFile);
 
 end
 
+function logFile = checklLogFile(action, logFile)
+
+    switch action
+
+        case 'init'
+
+            logFile = struct('filename', [], 'extraColumns', cell(1));
+            logFile(1).filename = '';
+
+        case 'checkID'
+
+            if ~isfield(logFile(1), 'fileID') || isempty(logFile(1).fileID)
+                errorSaveEventsFile('missingFileID');
+            end
+
+        case 'type&size'
+
+            if ~isstruct(logFile) || size(logFile, 2) > 1
+                errorSaveEventsFile('wrongFileID');
+            end
+
+    end
+
+end
+
 function logFile = initializeFile(expParameters, logFile)
 
     % Initialize txt logfiles and empty fields for the standard BIDS
@@ -285,3 +309,21 @@ function printExtraColumns(logFile, iEvent)
     end
 
 end
+
+function errorSaveEventsFile(identifier)
+
+    switch identifier
+        case 'unknownActionType'
+            errorStruct.message = 'unknown action for saveEventsFile';
+
+        case 'missingFileID'
+            errorStruct.message = 'logFile must contain a valid fileID field';
+
+        case 'wrongFileID'
+            errorStruct.message = 'logFile must be a nx1 structure';
+
+    end
+
+    errorStruct.identifier = ['saveEventsFile:' unknownActionType];
+    error(errorStruct);
+end

tests/miss_hit.cfg

@@ -1,3 +1,3 @@
 line_length: 100
-regex_function_name: "((test_[a-z]+)|[a-z]+)(([A-Z]|[0-9]){1}[a-z]+)*"
+regex_function_name: "((test_[a-z]+)|[a-z]+)(([A-Z]){1}[A-Za-z]+)*"
 suppress_rule: "copyright_notice"

tests/test_saveEventsFileOpen.m

@@ -44,9 +44,7 @@ function test_saveEventsFileOpen()
     assert(isequal(C{1}{1}, 'onset'));
     assert(isequal(C{2}{1}, 'trial_type'));
     assert(isequal(C{3}{1}, 'duration'));
-    
-    
-    
+
     %% check header writing with extra columns
     fprintf('\n\n--------------------------------------------------------------------\n\n');