Add functionality for MR metadata reading from SAV (#313)

WizardMac · Sep 22, 2024 · ba4392e · ba4392e
1 parent a5df9b8
commit ba4392e
Show file tree

Hide file tree

Showing 11 changed files with 800 additions and 2 deletions.
diff --git a/Makefile.am b/Makefile.am
@@ -33,6 +33,7 @@ libreadstat_la_SOURCES = \
 	src/spss/readstat_sav_compress.c \
 	src/spss/readstat_sav_parse.c \
 	src/spss/readstat_sav_parse_timestamp.c \
+	src/spss/readstat_sav_parse_mr_name.c \
 	src/spss/readstat_sav_read.c \
 	src/spss/readstat_sav_write.c \
 	src/spss/readstat_spss.c \
@@ -103,6 +104,7 @@ noinst_HEADERS = \
        src/spss/readstat_sav_compress.h \
        src/spss/readstat_sav_parse.h \
        src/spss/readstat_sav_parse_timestamp.h \
+       src/spss/readstat_sav_parse_mr_name.h \
        src/spss/readstat_spss.h \
        src/spss/readstat_spss_parse.h \
        src/spss/readstat_zsav_compress.h \

diff --git a/VS17/ReadStat.vcxproj b/VS17/ReadStat.vcxproj
@@ -215,6 +215,7 @@
     <ClCompile Include="..\src\spss\readstat_sav_compress.c" />
     <ClCompile Include="..\src\spss\readstat_sav_parse.c" />
     <ClCompile Include="..\src\spss\readstat_sav_parse_timestamp.c" />
+    <ClCompile Include="..\src\spss\readstat_sav_parse_mr_name.c" />
     <ClCompile Include="..\src\spss\readstat_sav_read.c" />
     <ClCompile Include="..\src\spss\readstat_sav_write.c" />
     <ClCompile Include="..\src\spss\readstat_spss.c" />
@@ -251,6 +252,7 @@
     <ClInclude Include="..\src\spss\readstat_sav_compress.h" />
     <ClInclude Include="..\src\spss\readstat_sav_parse.h" />
     <ClInclude Include="..\src\spss\readstat_sav_parse_timestamp.h" />
+    <ClInclude Include="..\src\spss\readstat_sav_parse_mr_name.h" />
     <ClInclude Include="..\src\spss\readstat_spss.h" />
     <ClInclude Include="..\src\spss\readstat_spss_parse.h" />
     <ClInclude Include="..\src\spss\readstat_zsav_compress.h" />

diff --git a/VS17/ReadStat.vcxproj.filters b/VS17/ReadStat.vcxproj.filters
@@ -123,6 +123,9 @@
     <ClCompile Include="..\src\spss\readstat_sav_parse_timestamp.c">
       <Filter>Source Files\spss</Filter>
     </ClCompile>
+    <ClCompile Include="..\src\spss\readstat_sav_parse_mr_name.c">
+      <Filter>Source Files\spss</Filter>
+    </ClCompile>
     <ClCompile Include="..\src\spss\readstat_sav_read.c">
       <Filter>Source Files\spss</Filter>
     </ClCompile>
@@ -218,6 +221,9 @@
     <ClInclude Include="..\src\spss\readstat_sav_parse_timestamp.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\src\spss\readstat_sav_parse_mr_name.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
     <ClInclude Include="..\src\spss\readstat_spss.h">
       <Filter>Header Files</Filter>
     </ClInclude>

diff --git a/src/readstat.h b/src/readstat.h
@@ -104,11 +104,22 @@ typedef enum readstat_error_e {
     READSTAT_ERROR_TOO_FEW_COLUMNS,
     READSTAT_ERROR_TOO_MANY_COLUMNS,
     READSTAT_ERROR_NAME_IS_ZERO_LENGTH,
-    READSTAT_ERROR_BAD_TIMESTAMP_VALUE
+    READSTAT_ERROR_BAD_TIMESTAMP_VALUE,
+    READSTAT_ERROR_BAD_MR_STRING
 } readstat_error_t;
 
 const char *readstat_error_message(readstat_error_t error_code);
 
+typedef struct mr_set_s {
+    char   type;
+    char  *name;
+    char  *label;
+    int    is_dichotomy;
+    int    counted_value;
+    char **subvariables;
+    int    num_subvars;
+} mr_set_t;
+
 typedef struct readstat_metadata_s {
     int64_t     row_count;
     int64_t     var_count;
@@ -121,6 +132,8 @@ typedef struct readstat_metadata_s {
     const char *file_label;
     const char *file_encoding;
     unsigned int is64bit:1;
+    size_t multiple_response_sets_length;
+    mr_set_t *mr_sets;
 } readstat_metadata_t;
 
 /* If the row count is unknown (e.g. it's an XPORT or POR file, or an SAV
@@ -138,6 +151,8 @@ readstat_endian_t readstat_get_endianness(readstat_metadata_t *metadata);
 const char *readstat_get_table_name(readstat_metadata_t *metadata);
 const char *readstat_get_file_label(readstat_metadata_t *metadata);
 const char *readstat_get_file_encoding(readstat_metadata_t *metadata);
+const mr_set_t *readstat_get_multiple_response_sets(readstat_metadata_t *metadata);
+size_t readstat_get_multiple_response_sets_length(readstat_metadata_t *metadata);
 
 typedef struct readstat_value_s {
     union {

diff --git a/src/readstat_metadata.c b/src/readstat_metadata.c
@@ -43,3 +43,11 @@ const char *readstat_get_file_encoding(readstat_metadata_t *metadata) {
 const char *readstat_get_table_name(readstat_metadata_t *metadata) {
     return metadata->table_name;
 }
+
+size_t readstat_get_multiple_response_sets_length(readstat_metadata_t *metadata) {
+    return metadata->multiple_response_sets_length;
+}
+
+const mr_set_t *readstat_get_multiple_response_sets(readstat_metadata_t *metadata) {
+    return metadata->mr_sets;
+}
diff --git a/src/spss/readstat_sav.c b/src/spss/readstat_sav.c
@@ -59,6 +59,8 @@ sav_ctx_t *sav_ctx_init(sav_file_header_record_t *header, readstat_io_t *io) {
         return NULL;
     }
 
+    ctx->mr_sets = NULL;
+
     ctx->io = io;
 
     return ctx;
@@ -89,6 +91,25 @@ void sav_ctx_free(sav_ctx_t *ctx) {
     if (ctx->variable_display_values) {
         free(ctx->variable_display_values);
     }
+    if (ctx->mr_sets) {
+        for (size_t i = 0; i < ctx->multiple_response_sets_length; i++) {
+            if (ctx->mr_sets[i].name) {
+                free(ctx->mr_sets[i].name);
+            }
+            if (ctx->mr_sets[i].label) {
+                free(ctx->mr_sets[i].label);
+            }
+            if (ctx->mr_sets[i].subvariables) {
+                for (size_t j = 0; j < ctx->mr_sets[i].num_subvars; j++) {
+                    if (ctx->mr_sets[i].subvariables[j]) {
+                        free(ctx->mr_sets[i].subvariables[j]);
+                    }
+                }
+                free(ctx->mr_sets[i].subvariables);
+            }
+        }
+        free(ctx->mr_sets);
+    }
     free(ctx);
 }
 
diff --git a/src/spss/readstat_sav.h b/src/spss/readstat_sav.h
@@ -3,6 +3,7 @@
 //
 
 #include "readstat_spss.h"
+#include "../readstat.h"
 
 #pragma pack(push, 1)
 
@@ -100,6 +101,9 @@ typedef struct sav_ctx_s {
     uint64_t       lowest_double;
     uint64_t       highest_double;
 
+    size_t         multiple_response_sets_length;
+    mr_set_t      *mr_sets;
+
     double         bias;
     int            format_version;
 
@@ -117,6 +121,7 @@ typedef struct sav_ctx_s {
 
 #define SAV_RECORD_SUBTYPE_INTEGER_INFO       3
 #define SAV_RECORD_SUBTYPE_FP_INFO            4
+#define SAV_RECORD_SUBTYPE_MULTIPLE_RESPONSE_SETS 7
 #define SAV_RECORD_SUBTYPE_PRODUCT_INFO      10
 #define SAV_RECORD_SUBTYPE_VAR_DISPLAY       11
 #define SAV_RECORD_SUBTYPE_LONG_VAR_NAME     13