Merge pull request #1 from cristidragomir97/refactorings

cristidragomir97 · web-flow · commit 38f181db7d30 · 2023-10-23T15:53:45.000+03:00
Refactorings
diff --git a/Arduino_UnifiedStorage_WorkInProgress.ino.elf b/Arduino_UnifiedStorage_WorkInProgress.ino.elf
diff --git a/examples/AdvancedInternalStorage/AdvancedInternalStorage.ino b/examples/AdvancedInternalStorage/AdvancedInternalStorage.ino
@@ -1,4 +1,3 @@
-#include <Arduino.h>
 #include <Arduino_UnifiedStorage.h>
 #include <vector>
 
diff --git a/src/Arduino_UnifiedStorage.h b/src/Arduino_UnifiedStorage.h
@@ -5,9 +5,16 @@
 
 #include "Arduino.h"
 #include "Arduino_POSIXStorage.h"
+#include "Boards.h"
+#include "Utils.h"
+#include "Types.h"
+#include "Partitioning.h"
+
 #include "Folder.h"
 #include "UFile.h"
-#include "Utils.h"
+
+
+
 
 
 
@@ -52,15 +59,17 @@ class Arduino_UnifiedStorage {
 };
 
 
-#if defined(ARDUINO_PORTENTA_C33) || defined(ARDUINO_PORTENTA_H7_M7)
-    #include "USBStorage.h"
-    #include "SDStorage.h"
-    #include "InternalStorage.h"
-#elif defined(ARDUINO_OPTA)
-    #include "USBStorage.h"
-    #include "InternalStorage.h"
-#endif
+    #if defined(HAS_USB)
+        #include "USBStorage.h"
+    #endif
+
+    #if defined(HAS_SD)
+        #include "SDStorage.h"
+    #endif
 
+    #if defined(HAS_QSPI)
+        #include "InternalStorage.h"
+    #endif
 
 #endif
 
diff --git a/src/Boards.h b/src/Boards.h
@@ -0,0 +1,29 @@
+#if defined(ARDUINO_PORTENTA_C33)
+    #define HAS_SD
+    #define HAS_USB
+    #define HAS_QSPI
+    #define USES_RENESAS_CORE
+#endif 
+
+#if defined(ARDUINO_PORTENTA_H7_M7)
+    #define HAS_SD
+    #define HAS_USB
+    #define HAS_QSPI
+    #define USES_MBED_CORE
+#endif 
+
+#if defined(ARDUINO_OPTA)
+    #define HAS_USB
+    #define HAS_QSPI
+    #define USES_MBED_CORE
+#endif 
+
+#if defined(ARDUINO_NICLA_VISION)
+    #define HAS_QSPI
+    #define USES_MBED_CORE
+#endif 
+
+
+
+
+
diff --git a/src/Folder.h b/src/Folder.h
@@ -1,10 +1,10 @@
 #ifndef Folder_H
 #define Folder_H
 
+
 #include "Utils.h"
 #include "UFile.h"
-
-
+#include <vector>
 
 class UFile;
 /**
diff --git a/src/InternalStorage.cpp b/src/InternalStorage.cpp
@@ -20,6 +20,8 @@ bool InternalStorage::partition(std::vector<Partition> partitions){
     Partitioning::partitionDrive(QSPIFBlockDeviceType::get_default_instance(), partitions);
 }
 
+
+
 bool InternalStorage::begin(){
         this -> blockDevice = BlockDeviceType::get_default_instance();
         this -> userData = new MBRBlockDeviceType(this->blockDevice, this->partitionNumber);
diff --git a/src/InternalStorage.h b/src/InternalStorage.h
@@ -2,8 +2,9 @@
 #define InternalStorage_H
 
 #include "Arduino_UnifiedStorage.h"
-#include "Partitioning.h"
 #include "Types.h"
+
+
 /**
  * Represents internal storage using the Arduino Unified Storage library.
  */
@@ -83,6 +84,8 @@ class InternalStorage : public Arduino_UnifiedStorage {
     BlockDeviceType *getBlockDevice();
 
     static bool partition(std::vector<Partition> partitions);
+    // partition() -> one Partition
+    // restoreDefaultPartitions();
 
 
     private:
diff --git a/src/Partitioning.cpp b/src/Partitioning.cpp
@@ -19,7 +19,7 @@
 }
 
  bool Partitioning::isPartitionSchemeValid(BlockDeviceType * bd, std::vector<Partition> partitions){
-    size_t driveSize = bd -> size() / 1024;
+    size_t driveSize = bd -> size() / 1024; // 
     int totalSize = 0;
 
     for (size_t i = 1; i < partitions.size() + 1; ++i) {
diff --git a/src/Partitioning.h b/src/Partitioning.h
@@ -1,7 +1,7 @@
 
 #include "Arduino.h"
-#include "Arduino_POSIXStorage.h"
 #include "Types.h"
+#include "Arduino_POSIXStorage.h"
 #include <vector>
 
 struct Partition {
@@ -17,6 +17,5 @@ class Partitioning{
         static bool isPartitionSchemeValid(BlockDeviceType * bd, std::vector<Partition> partitions);
         static bool formatPartition(BlockDeviceType * bd, int partitionNumber, FileSystems fs);
         static bool createAndFormatPartitions(BlockDeviceType * bd, std::vector<Partition> partitions);
-
-        
+       
 };
diff --git a/src/SDStorage.h b/src/SDStorage.h
@@ -5,7 +5,6 @@
 
 #include "Arduino_UnifiedStorage.h"
 
-#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_C33) || !defined(ARDUINO_OPTA)
 
 /**
  * Represents an SD card storage using the Arduino Unified Storage library.
@@ -59,5 +58,3 @@ class SDStorage: public Arduino_UnifiedStorage  {
 };
 
 #endif
-
-#endif
diff --git a/src/Types.h b/src/Types.h
@@ -1,4 +1,7 @@
-#if defined(ARDUINO_PORTENTA_C33)
+
+#include "Boards.h"
+
+#if defined(USES_RENESAS_CORE)
     #include "BlockDevice.h"
     #include "MBRBlockDevice.h"
     #include "LittleFileSystem.h"
@@ -11,9 +14,10 @@
     typedef LittleFileSystem LittleFileSystemType;
     typedef FileSystem FileSystemType;
 
-#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_OPTA)
+#elif defined(USES_MBED_CORE)
     #include "QSPIFBlockDevice.h"
     #include "MBRBlockDevice.h"
+    #include "LittleFileSystem.h"
     #include "FATFileSystem.h"
 
     typedef QSPIFBlockDevice QSPIFBlockDeviceType;
@@ -22,5 +26,4 @@
     typedef mbed::FATFileSystem FATFileSystemType;
     typedef mbed::LittleFileSystem LittleFileSystemType;
     typedef mbed::FileSystem FileSystemType;
-
 #endif 
diff --git a/src/UFile.h b/src/UFile.h
@@ -3,6 +3,7 @@
 
 #include <Arduino.h>
 #include <string.h>
+#include <vector>
 #include "Utils.h"
 
 class Folder;
diff --git a/src/USBStorage.cpp b/src/USBStorage.cpp
@@ -20,15 +20,15 @@ void USBStorage::onConnect(void (* const callbackFunction)()){
     register_hotplug_callback(DEV_USB, callbackFunction);
 }
 
-void USBStorage::removeConnectCallback(){
+void USBStorage::removeOnConnectCallback(){
     deregister_hotplug_callback(DEV_USB);
 }
 
 void USBStorage::onDisconnect(void (* const callbackFunction)()){
     register_unplug_callback(DEV_USB, callbackFunction);
 }
 
-void USBStorage::removeDisconnectCallback(){
+void USBStorage::removeOnDisconnectCallback(){
     deregister_unplug_callback(DEV_USB);
 }
 
diff --git a/src/USBStorage.h b/src/USBStorage.h
@@ -1,8 +1,9 @@
-#include "Arduino_UnifiedStorage.h"
+
 
 #ifndef USBStorage_H
 #define USBStorage_H
 
+#include "Arduino_UnifiedStorage.h"
 /**
  * Represents a USB storage using the Arduino Unified Storage library.
  */
@@ -59,19 +60,18 @@ class USBStorage : public Arduino_UnifiedStorage {
 
     void onConnect(void (* const callbackFunction)());
 
-    void removeConnectCallback();
+    void removeOnConnectCallback();
 
     void onDisconnect(void (* const callbackFunction)());
 
-    void removeDisconnectCallback();
+    void removeOnDisconnectCallback();
 
 
 private:
     FileSystems fileSystem = FS_FAT;
     bool mounted = false;
     unsigned long previousMillis; 
-    unsigned int interval = 500;
-
+    unsigned int interval = 500; // document what this does too, make it constexp (mountRetryInterval)
 };
 
 #endif
diff --git a/src/Utils.h b/src/Utils.h
@@ -7,7 +7,6 @@
 #include "Arduino.h"
 #include "Arduino_POSIXStorage.h"
 #include <iostream>
-#include <vector>
 
    
 
diff --git a/start.cmm b/start.cmm

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-#include <Arduino.h>`
`2`	`1`	`#include <Arduino_UnifiedStorage.h>`
`3`	`2`	`#include <vector>`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@ bool InternalStorage::partition(std::vector<Partition> partitions){`
`20`	`20`	`Partitioning::partitionDrive(QSPIFBlockDeviceType::get_default_instance(), partitions);`
`21`	`21`	`}`
`22`	`22`
	`23`	`+`
	`24`	`+`
`23`	`25`	`bool InternalStorage::begin(){`
`24`	`26`	`this -> blockDevice = BlockDeviceType::get_default_instance();`
`25`	`27`	`this -> userData = new MBRBlockDeviceType(this->blockDevice, this->partitionNumber);`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`bool Partitioning::isPartitionSchemeValid(BlockDeviceType * bd, std::vector<Partition> partitions){`
`22`		`- size_t driveSize = bd -> size() / 1024;`
	`22`	`+ size_t driveSize = bd -> size() / 1024; //`
`23`	`23`	`int totalSize = 0;`
`24`	`24`
`25`	`25`	`for (size_t i = 1; i < partitions.size() + 1; ++i) {`