Added format reader interface.

Author: Milo-D

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# Unreleased
+
+- added format reader interface (reader/reader.c)
+  - reader for different file formats can be now added to reader/format/
+    - for example reader/format/ihex.c to read the intel hex format
+
 # v.0.8.12 - 2021-08-10
 
 - reduction of heap usage and overall memory usage

engine/include/reader/fmt.h

@@ -0,0 +1,12 @@
+/* File Format Enumeration Header */
+
+#ifndef VMCU_FMT_H
+#define VMCU_FMT_H
+
+typedef enum {
+
+    VMCU_FMT_IHEX
+
+} VMCU_FMT;
+
+#endif

engine/include/reader/ihex_reader.h engine/include/reader/format/ihex.hengine/include/reader/ihex_reader.h renamed to engine/include/reader/format/ihex.h

@@ -1,7 +1,7 @@
 /* Intel Hex Reader Header */
 
-#ifndef VMCU_IHEX_READER_H
-#define VMCU_IHEX_READER_H
+#ifndef VMCU_IHEX_H
+#define VMCU_IHEX_H
 
 // C Headers
 #include <inttypes.h>

engine/include/reader/reader.h

@@ -0,0 +1,16 @@
+/* Format Reader Header */
+
+#ifndef VMCU_READER_H
+#define VMCU_READER_H
+
+// C Headers
+#include <inttypes.h>
+
+// Project Headers
+#include "engine/include/reader/fmt.h"
+
+typedef struct vmcu_binary_buffer vmcu_binary_buffer_t;
+
+extern vmcu_binary_buffer_t* vmcu_read_format(const VMCU_FMT fmt, const char *file, uint32_t *size);
+
+#endif

engine/src/decoder/decoder.c

@@ -12,7 +12,7 @@
 
 // Project Headers (engine, readers)
 #include "engine/include/reader/binary_buffer.h"
-#include "engine/include/reader/ihex_reader.h"
+#include "engine/include/reader/reader.h"
 
 // Project Headers (engine utilities)
 #include "engine/include/misc/bitmanip.h"
@@ -62,7 +62,7 @@ vmcu_instr_t* vmcu_decode_ihex(const char *hex_file, uint32_t *size, vmcu_model_
     vmcu_instr_t *result;
     vmcu_binary_buffer_t *bb;
 
-    if((bb = vmcu_read_ihex(hex_file, size)) == NULL)
+    if((bb = vmcu_read_format(VMCU_FMT_IHEX, hex_file, size)) == NULL)
         return NULL;
 
     if((result = decode_binary_buffer(bb, size)) == NULL)

engine/src/reader/ihex_reader.c engine/src/reader/format/ihex.cengine/src/reader/ihex_reader.c renamed to engine/src/reader/format/ihex.c

@@ -7,12 +7,11 @@
 #include <stdbool.h>
 
 // Project Headers (engine, readers)
-#include "engine/include/reader/ihex_reader.h"
+#include "engine/include/reader/format/ihex.h"
 #include "engine/include/reader/binary_buffer.h"
 
 // Project Headers (engine utilities)
 #include "engine/include/misc/filemanip.h"
-#include "engine/include/misc/bitmanip.h"
 #include "engine/include/misc/stringmanip.h"
 
 #define RECORD 8

engine/src/reader/reader.c

@@ -0,0 +1,23 @@
+/* Format Reader Implementation */
+
+// C Headers
+#include <stddef.h>
+
+// Project Headers (engine)
+#include "engine/include/reader/reader.h"
+
+// Project Headers (engine, formats)
+#include "engine/include/reader/format/ihex.h"
+
+vmcu_binary_buffer_t* vmcu_read_format(const VMCU_FMT fmt, const char *file, uint32_t *size) {
+
+    vmcu_binary_buffer_t *bb;
+
+    switch(fmt) {
+
+        case VMCU_FMT_IHEX: bb = vmcu_read_ihex(file, size); break;
+        default:            bb = NULL;                       break;
+    }
+
+    return bb;
+}