Merge pull request #12 from arduino-libraries/refactorings

Refactor variable names and remove unused code

Author: cristidragomir97

examples/BackupInternalPartitions/BackupInternalPartitions.ino

@@ -38,11 +38,11 @@ USBStorage thumbDrive = USBStorage();
 
 
 void addSomeFakeFiles(Folder * folder){
-    Serial.println("* adding some fake files to: " + String(folder -> getPathString()));
+    Serial.println("* adding some fake files to: " + String(folder -> getPathAsString()));
 
     for (int i = 0; i < random(0, 9); i++){
         UFile thisFile = folder -> createFile("File_"+ String(random(999)), FileMode::WRITE);
-        Serial.println("\t * " + thisFile.getPathString());
+        Serial.println("\t * " + thisFile.getPathAsString());
         thisFile.write("writing stuff to the file");
         thisFile.close();
     }
@@ -51,20 +51,20 @@ void addSomeFakeFiles(Folder * folder){
     Folder subfolder = folder -> createSubfolder("ChildFolder_"+ String(random(999)));
     for (int i = 0; i < random(0, 9); i++){
         UFile thisFile = subfolder.createFile("File_"+ String(random(999)), FileMode::WRITE);
-        Serial.println("\t * " + thisFile.getPathString());
+        Serial.println("\t * " + thisFile.getPathAsString());
         thisFile.write("writing stuff to the file");
         thisFile.close();
     }
 }
 
 void move(Folder * source, Folder * dest){
     for(Folder f: source -> getFolders()){
-        Serial.println("* copying folder :" + String(f.getPathString()));
+        Serial.println("* copying folder :" + String(f.getPathAsString()));
         f.moveTo(*dest);
     }
 
     for(UFile f: source -> getFiles()){
-        Serial.println("* copying file :" + String(f.getPathString()));
+        Serial.println("* copying file :" + String(f.getPathAsString()));
         f.moveTo(*dest);
     }
 }
@@ -73,7 +73,7 @@ void move(Folder * source, Folder * dest){
 #if defined(ARDUINO_PORTENTA_C33)
 void backupPartitionsC33(Folder * backupFolder){
 
-    Serial.println("* backup location: " + String(backupFolder -> getPathString()));
+    Serial.println("* backup location: " + String(backupFolder -> getPathAsString()));
 
     int otaMounted = ota.begin(FS_FAT);
     Serial.println("* ota partition mount: " + String(otaMounted));
@@ -108,7 +108,7 @@ void backupPartitionsC33(Folder * backupFolder){
 
 #if defined(ARDUINO_PORTENTA_H7_M7)
 void backupPartitionsH7(Folder * backupFolder){
-    Serial.println("* backup location: " + String(backupFolder -> getPathString()));
+    Serial.println("* backup location: " + String(backupFolder -> getPathAsString()));
 
     int wifiMounted = wifi.begin(FS_FAT);
     Serial.println("* wifi partition mount: " + String(wifiMounted));

extras/tests/TestExisting/TestExisting.ino

@@ -19,7 +19,7 @@ void setup() {
 
 
     Folder root = internalStorage.getRootFolder();
-    Serial.println(root.getPathString());
+    Serial.println(root.getPathAsString());
 
     // Test copyTo
     Serial.println("Testing copyTo...");
@@ -35,8 +35,8 @@ void setup() {
     Folder destinationFolder2 = root.createSubfolder("destination_folder");
     Serial.println("Folder 2 created");
 
-    Serial.println(sourceFolder2.getPathString());
-    Serial.println(destinationFolder2.getPathString());
+    Serial.println(sourceFolder2.getPathAsString());
+    Serial.println(destinationFolder2.getPathAsString());
 
         Serial.println();
             Serial.println();

extras/tests/TestFileOperations/TestFileOperations.ino

@@ -20,7 +20,7 @@ InternalStorage internal = InternalStorage();
 
 bool testFileCreationWithOpen(Folder root) {
   UFile file = UFile();
-  String path = root.getPathString() + "/test_open.txt";
+  String path = root.getPathAsString() + "/test_open.txt";
   Serial.println(path);
   if (file.open(path, FileMode::WRITE)) {
     Serial.println("\n--- Test creating file using file.open ---");
@@ -104,7 +104,7 @@ bool testReadingAll(Folder root) {
     file.write(reinterpret_cast<const uint8_t*>("Hello, World!"), 13);
     file.close();
 
-    if (file.open(root.getPathString() + "/test_read.txt", FileMode::READ)) {
+    if (file.open(root.getPathAsString() + "/test_read.txt", FileMode::READ)) {
       char buffer[file.available()];
       size_t bytesRead = file.read(reinterpret_cast<uint8_t*>(buffer), sizeof(buffer));
       buffer[bytesRead] = '\0'; // Null-terminate the string
@@ -136,7 +136,7 @@ bool testSeeking(Folder root) {
     file.close();
 
 
-    if (file.open(root.getPathString() + "/test_seek.txt", FileMode::READ)) {
+    if (file.open(root.getPathAsString() + "/test_seek.txt", FileMode::READ)) {
       Serial.println("\n--- Test seeking file ---");
       file.seek(7);
       char buffer[20];
@@ -163,7 +163,7 @@ bool testAvailableData(Folder root) {
     file.write(reinterpret_cast<const uint8_t*>("Hello, World!"), 13);
     file.close();
 
-    if (file.open(root.getPathString() + "/test_available.txt", FileMode::READ)) {
+    if (file.open(root.getPathAsString() + "/test_available.txt", FileMode::READ)) {
       Serial.println("\n--- Test available data ---");
       int availableBytes = file.available();
       Serial.println("Available bytes in file (test_available.txt): " + String(availableBytes));
@@ -193,7 +193,7 @@ bool testCopyingFile(Folder root) {
 
     if (destinationFolder.exists()) {
         Serial.println("\n--- Test copying a file ---");
-        Serial.println("Source file name: " + String(sourceFile.getPathString()));
+        Serial.println("Source file name: " + String(sourceFile.getPathAsString()));
 
         if (sourceFile.copyTo(destinationFolder)) {
           Serial.println("File copied successfully!");
@@ -227,8 +227,8 @@ bool testMovingFile(Folder root) {
       UFile movedFile = sourceFileMove;
       if (movedFile.exists()) {
         Serial.println("\n--- Test moving a file ---");
-        Serial.println("Source file name: " + String(sourceFileMove.getPathString()));
-        Serial.println("Destination file name: " + String(destinationFolder.getPathString()) + "/test_source_move.txt");
+        Serial.println("Source file name: " + String(sourceFileMove.getPathAsString()));
+        Serial.println("Destination file name: " + String(destinationFolder.getPathAsString()) + "/test_source_move.txt");
         if (sourceFileMove.moveTo(destinationFolder)) {
           Serial.println("File moved successfully!");
           sourceFileMove.close();

extras/tests/TestFolderOperations/TestFolderOperations.ino

@@ -58,9 +58,9 @@ bool testFolderRenaming(Folder root) {
   Folder sourceFolder = root.createSubfolder("source_folder");
   if (sourceFolder.exists()) {
     Serial.println("\n--- Test renaming folder ---");
-    Serial.println("Source folder name: " + String(sourceFolder.getPathString()));
+    Serial.println("Source folder name: " + String(sourceFolder.getPathAsString()));
     if (sourceFolder.rename("renamed_folder")) {
-      Serial.println("Folder renamed to: " + String(sourceFolder.getPathString()));
+      Serial.println("Folder renamed to: " + String(sourceFolder.getPathAsString()));
       sourceFolder.remove();
       return true;
     } else {
@@ -79,8 +79,8 @@ bool testCopyingFolder(Folder root) {
 
   if (sourceFolder.exists()) {
     Serial.println("\n--- Test copying a folder ---");
-    Serial.println("Source folder name: " + String(sourceFolder.getPathString()));
-    Serial.println("Destination folder name: " + String(copyDestination.getPathString()));
+    Serial.println("Source folder name: " + String(sourceFolder.getPathAsString()));
+    Serial.println("Destination folder name: " + String(copyDestination.getPathAsString()));
 
 
 
@@ -108,8 +108,8 @@ bool testMovingFolder(Folder root) {
 
   if (sourceFolderMove.exists()) {
     Serial.println("\n--- Test moving a folder ---");
-    Serial.println("Source folder name: " + String(sourceFolderMove.getPathString()));
-    Serial.println("Destination folder name: " + String(moveDestination.getPathString()));
+    Serial.println("Source folder name: " + String(sourceFolderMove.getPathAsString()));
+    Serial.println("Destination folder name: " + String(moveDestination.getPathAsString()));
     if (sourceFolderMove.moveTo(moveDestination)) {
       Serial.println("Folder moved successfully!");
       sourceFolderMove.remove();

keywords.txt

@@ -45,7 +45,7 @@ copyTo                      KEYWORD2
 moveTo                      KEYWORD2
 getParentFolder             KEYWORD2
 getPath                     KEYWORD2
-getPathString               KEYWORD2
+getPathAsString             KEYWORD2
 
 isConnected                 KEYWORD2
 isAvailable                 KEYWORD2

src/Folder.cpp

@@ -100,7 +100,7 @@ const char* Folder::getPath() {
     return this->path.c_str();
 }
 
-String Folder::getPathString() {
+String Folder::getPathAsString() {
     return String(this->getPath());
 }
 

src/Folder.h

@@ -82,7 +82,7 @@ class Folder {
      * @brief Returns the path of the file.
      * @return The path of the file as an Arduino String
     */
-    String getPathString();
+    String getPathAsString();
 
     /**
      * @brief Creates a subfolder in the directory.
@@ -160,10 +160,7 @@ class Folder {
     bool moveTo(String destination, bool overwrite = false);
 
   private: 
-  
-    std::string dirname;
     std::string path;
-    DIR * dir;
 };
 
 #endif

src/InternalStorage.cpp

@@ -1,7 +1,6 @@
 #include "Arduino_UnifiedStorage.h"
 
 InternalStorage::InternalStorage(){
-    this -> fs = FS_FAT;
 
     #if defined(ARDUINO_PORTENTA_C33)
         this -> setQSPIPartition(2);
@@ -41,21 +40,17 @@ int InternalStorage::begin(){
 
             if(this -> userDataFileSystem != nullptr){
                 delete(this -> userDataFileSystem);
-
             } 
             this -> userDataFileSystem = new mbed::FATFileSystem(this->partitionName);
         } else {
 
-                 if(this -> userDataFileSystem != nullptr){
-             delete(this -> userDataFileSystem);
-
+            if(this -> userDataFileSystem != nullptr){
+                delete(this -> userDataFileSystem);
             } 
 
-
             this -> userDataFileSystem = new mbed::LittleFileSystem(this->partitionName);
         }
         int err = this -> userDataFileSystem -> mount(this -> userData);
-  
         if(err == 0) return 1;
     #endif
 }
@@ -69,13 +64,11 @@ Folder InternalStorage::getRootFolder(){
     return Folder(String("/" + String(this->partitionName)).c_str());
 }
 
-
 void InternalStorage::setQSPIPartition(int partition){
     this -> partitionNumber = partition;
 }
 
 void InternalStorage::setQSPIPartitionName(const char * name){
-
     this -> partitionName = (char *)name;
 }
 
@@ -113,8 +106,8 @@ BlockDevice * InternalStorage::getBlockDevice(){
 
 
 #if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_OPTA) 
-              mbed::BlockDevice *  InternalStorage::getBlockDevice(){
-                return this -> blockDevice;
-              }
+mbed::BlockDevice *  InternalStorage::getBlockDevice(){
+    return this -> blockDevice;
+}
 
 #endif

src/InternalStorage.h

@@ -106,7 +106,6 @@ class InternalStorage : public Arduino_UnifiedStorage {
         int partitionNumber = 3;
         #endif
 
-
         char * partitionName = "user";
         FileSystems fs = FS_FAT;
 };

src/Types.h

@@ -9,9 +9,6 @@
 #include <iostream>
 #include <vector>
 
-
-
-
 static bool copyFolder(const char* source, const char* destination) {
     DIR* dir = opendir(source);
     if (dir == nullptr) {