Merge pull request #82 from TREX-CoE/fix-text-compatibility

refactor `trexio_text_read_group` set of functions to read data in an arbitrary order

ChangeLog

@@ -4,6 +4,7 @@ CHANGES
 2.2
 ---
 
+- Fixed backwards incompatibility of the `TREXIO_TEXT` back end in #82
 - Added `TREXIO_AUTO` back end for read-only mode (`r`) in PR #80
 - Added unsafe mode (`u`) to `trexio_open`. When enabled, data can be
 overwritten (using conventional `trexio_write`) and groups can be deleted
@@ -59,4 +60,3 @@ access to both local and non-local quantities
 
 - Using libtool/automake
 - Rewrote generator
-

src/templates_text/templator_text.org

@@ -80,12 +80,12 @@
     #+begin_src c :tangle struct_text_group_dset.h
 typedef struct $group$_s {
   $group_num_dtype_double$ $group_num$;
-  bool $group_num$_isSet;
   $group_dset_dtype$*  $group_dset$;
-  uint32_t rank_$group_dset$;
-  uint32_t to_flush;
   uint64_t dims_$group_dset$[16];
   uint64_t len_$group_str$;
+  uint32_t rank_$group_dset$;
+  uint32_t to_flush;
+  bool $group_num$_isSet;
   char*    $group_str$;
   char     file_name[TREXIO_MAX_FILENAME_LENGTH];
 } $group$_t;
@@ -318,38 +318,45 @@ trexio_text_read_$group$ (trexio_text_t* const file)
       return NULL;
     }
 
- /* Read the dimensioning variables */
     int rc = 0;
+    trexio_exit_code rc_free = TREXIO_FAILURE;
+
+ /* workaround for the case of missing blocks in the file */
     // START REPEAT GROUP_DSET_ALL
-    rc = fscanf(f, "%1023s", buffer);
+    uint64_t size_$group_dset$ = 0;
-    if ((rc != 1) || (strcmp(buffer, "rank_$group_dset$") != 0)) {
+    // END REPEAT GROUP_DSET_ALL
-      FREE(buffer);
+
-      fclose(f);
+    while(fscanf(f, "%1023s", buffer) != EOF) {
-      FREE($group$);
+
-      return NULL;
+      if (strcmp(buffer, "EXIT") == 0) {
-    }
+        break;
+      // START REPEAT GROUP_DSET_ALL
+      } else if (strcmp(buffer, "rank_$group_dset$") == 0) {
 
         rc = fscanf(f, "%u", &($group$->rank_$group_dset$));
         if (rc != 1) {
           FREE(buffer);
           fclose(f);
-      FREE($group$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+          file->$group$ = $group$;
+          rc_free = trexio_text_free_$group$(file);
+          assert(rc_free == TREXIO_SUCCESS);
           return NULL;
         }
 
- /* workaround for the case of missing blocks in the file */
+        if ($group$->rank_$group_dset$ != 0) size_$group_dset$ = 1UL;
-    uint64_t size_$group_dset$ = 0;
-    if ($group$->rank_$group_dset$ != 0) size_$group_dset$ = 1;
 
         for (uint32_t i=0; i<$group$->rank_$group_dset$; ++i){
 
           uint32_t j=0;
-
           rc = fscanf(f, "%1023s %u", buffer, &j);
           if ((rc != 2) || (strcmp(buffer, "dims_$group_dset$") != 0) || (j!=i)) {
             FREE(buffer);
             fclose(f);
-        FREE($group$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
             return NULL;
           }
 
@@ -358,165 +365,58 @@ trexio_text_read_$group$ (trexio_text_t* const file)
           if (rc != 1) {
             FREE(buffer);
             fclose(f);
-        FREE($group$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
             return NULL;
           }
 
           size_$group_dset$ *= $group$->dims_$group_dset$[i];
         }
       // END REPEAT GROUP_DSET_ALL
-
-    // START REPEAT GROUP_NUM
- /* Read data */
-    unsigned int $group_num$_isSet;
-    rc = fscanf(f, "%1023s", buffer);
-    assert(!((rc != 1) || (strcmp(buffer, "$group_num$_isSet") != 0)));
-    if ((rc != 1) || (strcmp(buffer, "$group_num$_isSet") != 0)) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$);
-      return NULL;
-    }
-
- /* additional parameter $group_num$_isSet is needed to suppress warning when fscanf into bool variable using %u or %d */
-    rc = fscanf(f, "%u", &($group_num$_isSet));
-    $group$->$group_num$_isSet = (bool) $group_num$_isSet;
-    assert(!(rc != 1));
-    if (rc != 1) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$);
-      return NULL;
-    }
-
-    if ($group$->$group_num$_isSet == true) {
-      rc = fscanf(f, "%1023s", buffer);
-      assert(!((rc != 1) || (strcmp(buffer, "$group_num$") != 0)));
-      if ((rc != 1) || (strcmp(buffer, "$group_num$") != 0)) {
-        FREE(buffer);
-        fclose(f);
-        FREE($group$);
-        return NULL;
-      }
-
-      rc = fscanf(f, "%$group_num_format_scanf$", &($group$->$group_num$));
-      assert(!(rc != 1));
-      if (rc != 1) {
-        FREE(buffer);
-        fclose(f);
-        FREE($group$);
-        return NULL;
-      }
-    }
-    // END REPEAT GROUP_NUM
-
-    // START REPEAT GROUP_ATTR_STR
-    rc = fscanf(f, "%1023s", buffer);
-    assert(!((rc != 1) || (strcmp(buffer, "len_$group_str$") != 0)));
-    if ((rc != 1) || (strcmp(buffer, "len_$group_str$") != 0)) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$);
-      return NULL;
-    }
-
-    rc = fscanf(f, "%" SCNu64 "", &($group$->len_$group_str$));
-    assert(!(rc != 1));
-    if (rc != 1) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$);
-      return NULL;
-    }
-
-    rc = fscanf(f, "%1023s", buffer);
-    assert(!((rc != 1) || (strcmp(buffer, "$group_str$") != 0)));
-    if ((rc != 1) || (strcmp(buffer, "$group_str$") != 0)) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$->$group_str$);
-      FREE($group$);
-      return NULL;
-    }
-
-    if ($group$->len_$group_str$ != 0) {
-
-      $group$->$group_str$ = CALLOC($group$->len_$group_str$, char);
-      assert (!($group$->$group_str$ == NULL));
-      if ($group$->$group_str$ == NULL) {
-        FREE(buffer);
-        fclose(f);
-        FREE($group$->$group_str$);
-        FREE($group$);
-        return NULL;
-      }
-
-      rc = fscanf(f, " %1023[^\n]", $group$->$group_str$);
-      assert(!(rc != 1));
-      if (rc != 1) {
-        FREE(buffer);
-        fclose(f);
-        FREE($group$->$group_str$);
-        FREE($group$);
-        return NULL;
-      }
-
-    }
-    // END REPEAT GROUP_ATTR_STR
-
       // START REPEAT GROUP_DSET_NUM
+      } else if (strcmp(buffer, "$group_dset$") == 0) {
+
  /* Allocate arrays */
         $group$->$group_dset$ = CALLOC(size_$group_dset$, $group_dset_dtype$);
-    assert (!($group$->$group_dset$ == NULL));
         if ($group$->$group_dset$ == NULL) {
           FREE(buffer);
           fclose(f);
-      FREE($group$->$group_dset$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
-      FREE($group$);
+          file->$group$ = $group$;
-      return NULL;
+          rc_free = trexio_text_free_$group$(file);
-    }
+          assert(rc_free == TREXIO_SUCCESS);
-
-    rc = fscanf(f, "%1023s", buffer);
-    assert(!((rc != 1) || (strcmp(buffer, "$group_dset$") != 0)));
-    if ((rc != 1) || (strcmp(buffer, "$group_dset$") != 0)) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$->$group_dset$);
-      FREE($group$);
           return NULL;
         }
 
         for (uint64_t i=0 ; i<size_$group_dset$ ; ++i) {
           rc = fscanf(f, "%$group_dset_format_scanf$", &($group$->$group_dset$[i]));
-      assert(!(rc != 1));
           if (rc != 1) {
             FREE(buffer);
             fclose(f);
-        FREE($group$->$group_dset$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
-        FREE($group$);
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
             return NULL;
           }
         }
+
       // END REPEAT GROUP_DSET_NUM
-
       // START REPEAT GROUP_DSET_STR
-    rc = fscanf(f, "%1023s", buffer);
+      } else if (strcmp(buffer, "$group_dset$") == 0) {
-    assert(!((rc != 1) || (strcmp(buffer, "$group_dset$") != 0)));
-    if ((rc != 1) || (strcmp(buffer, "$group_dset$") != 0)) {
-      FREE(buffer);
-      fclose(f);
-      FREE($group$);
-      return NULL;
-    }
 
- /* Allocate arrays */
         if(size_$group_dset$ != 0) {
+ /* Allocate arrays */
           $group$->$group_dset$ = CALLOC(size_$group_dset$, $group_dset_dtype$);
           if ($group$->$group_dset$ == NULL) {
             FREE(buffer);
             fclose(f);
-        FREE($group$->$group_dset$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
-        FREE($group$);
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
             return NULL;
           }
 
@@ -536,8 +436,10 @@ trexio_text_read_$group$ (trexio_text_t* const file)
             if (rc != 1) {
               FREE(buffer);
               fclose(f);
-          FREE($group$->$group_dset$);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
-          FREE($group$);
+              file->$group$ = $group$;
+              rc_free = trexio_text_free_$group$(file);
+              assert(rc_free == TREXIO_SUCCESS);
               return NULL;
             }
 
@@ -545,7 +447,114 @@ trexio_text_read_$group$ (trexio_text_t* const file)
             tmp_$group_dset$ += tmp_$group_dset$_len + 1;
           }
         }
+
       // END REPEAT GROUP_DSET_STR
+      // START REPEAT GROUP_NUM
+      } else if (strcmp(buffer, "$group_num$_isSet") == 0) {
+
+        unsigned int $group_num$_isSet;
+ /* additional parameter $group_num$_isSet is needed to suppress warning when fscanf into bool variable using %u or %d */
+        rc = fscanf(f, "%u", &($group_num$_isSet));
+        $group$->$group_num$_isSet = (bool) $group_num$_isSet;
+        assert(!(rc != 1));
+        if (rc != 1) {
+          FREE(buffer);
+          fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+          file->$group$ = $group$;
+          rc_free = trexio_text_free_$group$(file);
+          assert(rc_free == TREXIO_SUCCESS);
+          return NULL;
+        }
+
+        if ($group$->$group_num$_isSet == true) {
+          rc = fscanf(f, "%1023s", buffer);
+          assert(!((rc != 1) || (strcmp(buffer, "$group_num$") != 0)));
+          if ((rc != 1) || (strcmp(buffer, "$group_num$") != 0)) {
+            FREE(buffer);
+            fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
+            return NULL;
+          }
+
+          rc = fscanf(f, "%$group_num_format_scanf$", &($group$->$group_num$));
+          assert(!(rc != 1));
+          if (rc != 1) {
+            FREE(buffer);
+            fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
+            return NULL;
+          }
+        }
+
+      // END REPEAT GROUP_NUM
+      // START REPEAT GROUP_ATTR_STR
+      } else if (strcmp(buffer, "len_$group_str$") == 0) {
+
+        rc = fscanf(f, "%" SCNu64 "", &($group$->len_$group_str$));
+        assert(!(rc != 1));
+        if (rc != 1) {
+          FREE(buffer);
+          fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+          file->$group$ = $group$;
+          rc_free = trexio_text_free_$group$(file);
+          assert(rc_free == TREXIO_SUCCESS);
+          return NULL;
+        }
+
+        rc = fscanf(f, "%1023s", buffer);
+        assert(!((rc != 1) || (strcmp(buffer, "$group_str$") != 0)));
+        if ((rc != 1) || (strcmp(buffer, "$group_str$") != 0)) {
+          FREE(buffer);
+          fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+          file->$group$ = $group$;
+          rc_free = trexio_text_free_$group$(file);
+          assert(rc_free == TREXIO_SUCCESS);
+          return NULL;
+        }
+
+        if ($group$->len_$group_str$ != 0) {
+
+          $group$->$group_str$ = CALLOC($group$->len_$group_str$, char);
+          assert (!($group$->$group_str$ == NULL));
+          if ($group$->$group_str$ == NULL) {
+            FREE(buffer);
+            fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
+            return NULL;
+          }
+
+          rc = fscanf(f, " %1023[^\n]", $group$->$group_str$);
+          assert(!(rc != 1));
+          if (rc != 1) {
+            FREE(buffer);
+            fclose(f);
+ /* Set pointer to the struct so that the garbage collector can do the job on file handle */
+            file->$group$ = $group$;
+            rc_free = trexio_text_free_$group$(file);
+            assert(rc_free == TREXIO_SUCCESS);
+            return NULL;
+          }
+
+        }
+
+      // END REPEAT GROUP_ATTR_STR
+      } else {
+        continue;
+      }
+
+    }
 
     FREE(buffer);
     fclose(f);

tools/generator_tools.py

@@ -311,8 +311,6 @@ def special_populate_text_group(fname: str, paths: dict, group_dict: dict, detai
                 subloop_dset = False
                 subloop_num = False
                 loop_body = ''
-                dset_allocated = []
-                str_allocated = []
 
                 for line in f_in :
 
@@ -335,25 +333,12 @@ def special_populate_text_group(fname: str, paths: dict, group_dict: dict, detai
                             if ('REPEAT GROUP_DSET_NUM' in line) and (detailed_dset[dset]['group_dset_dtype'] == 'char*'):
                                 continue
 
-                            dset_allocated.append(dset)
-
-                            if 'FREE($group$->$group_dset$)' in loop_body:
-                                tmp_string = ''
-                                for dset_alloc in dset_allocated:
-                                    tmp_string += f'FREE({group}->{dset_alloc});\n        '
-
-                                tmp_body = loop_body.replace('FREE($group$->$group_dset$);', tmp_string)
-
-                                populated_body = recursive_replace_line(tmp_body, triggers, detailed_dset[dset])
-                                f_out.write(populated_body)
-                            else:
                             save_body = loop_body
                             populated_body = recursive_replace_line(save_body, triggers, detailed_dset[dset])
                             f_out.write(populated_body)
 
                         subloop_dset = False
                         loop_body = ''
-                        dset_allocated = []
                         continue
 
                     elif 'END REPEAT GROUP_NUM' in line:
@@ -374,26 +359,12 @@ def special_populate_text_group(fname: str, paths: dict, group_dict: dict, detai
                             if group != detailed_strings[str]['group']:
                                 continue
 
-                            str_allocated.append(str)
-
-                            if 'FREE($group$->$group_str$)' in loop_body:
-                                tmp_string = ''
-                                for str_alloc in str_allocated:
-                                    tmp_string += f'FREE({group}->{str_alloc});\n        '
-
-                                tmp_body = loop_body.replace('FREE($group$->$group_str$);', tmp_string)
-
-                                populated_body = recursive_replace_line(tmp_body, triggers, detailed_strings[str])
-                                f_out.write(populated_body)
-                            else:
                             save_body = loop_body
                             populated_body = recursive_replace_line(save_body, triggers, detailed_strings[str])
                             f_out.write(populated_body)
 
                         subloop_num = False
                         loop_body = ''
-                        str_allocated = []
-
                         continue
 
                     if not subloop_num and not subloop_dset: