Merge pull request #17 from arduino-libraries/clean-up

sebromero · web-flow · commit 3abc601b9ebc · 2023-09-07T10:06:39.000+02:00
Clean up Code
diff --git a/src/Arduino_UnifiedStorage.h b/src/Arduino_UnifiedStorage.h
@@ -34,20 +34,20 @@ class Arduino_UnifiedStorage {
         /**
          * Initializes the storage.
          * 
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         virtual bool begin() = 0;
 
         /**
           * Initializes the  storage with the specified file system.
           * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
-          * @return 1 if successful, 0 if failed.
+          * @return true if successful, false if failed.
           */
         virtual bool begin(FileSystems fs) = 0;
 
         /**
          * Unmounts the storage.
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         virtual bool unmount() = 0;
 
@@ -59,7 +59,7 @@ class Arduino_UnifiedStorage {
 
         /**
          * Formats the storage with the selected file system.
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         virtual bool format(FileSystems fs) = 0;
 
diff --git a/src/InternalStorage.cpp b/src/InternalStorage.cpp
@@ -14,29 +14,29 @@ InternalStorage::InternalStorage(){
 InternalStorage::InternalStorage(int partition, const char * name, FileSystems fs){
     this -> setQSPIPartition(partition);
     this -> setQSPIPartitionName(name);
-    this -> fs = fs;
+    this -> fileSystem = fs;
 }
 
 bool InternalStorage::begin(FileSystems fs){
-  this -> fs = fs;
+  this -> fileSystem = fs;
   return this -> begin();
 }
 
 bool InternalStorage::begin(){
     #if defined(ARDUINO_PORTENTA_C33)
         this -> blockDevice = BlockDevice::get_default_instance();
         this -> userData = new MBRBlockDevice(this->blockDevice, this->partitionNumber);
-        if(this -> fs == FS_FAT){
+        if(this -> fileSystem == FS_FAT){
             this -> userDataFileSystem = new FATFileSystem(this->partitionName);
         } else {
             this -> userDataFileSystem = new LittleFileSystem(this->partitionName);
         }
         int err = this -> userDataFileSystem -> mount(userData);
-        return err == 0 ? true : false;
+        return err == 0;
     #elif defined(ARDUINO_PORTENTA_H7_M7) ||  defined(ARDUINO_OPTA) 
         this -> blockDevice = QSPIFBlockDevice::get_default_instance();
         this -> userData = new mbed::MBRBlockDevice(this->blockDevice, this->partitionNumber);
-        if(this -> fs == FS_FAT){
+        if(this -> fileSystem == FS_FAT){
             
             if(this -> userDataFileSystem != nullptr){
                 delete(this -> userDataFileSystem);
@@ -51,13 +51,15 @@ bool InternalStorage::begin(){
             this -> userDataFileSystem = new mbed::LittleFileSystem(this->partitionName);
         }
         int err = this -> userDataFileSystem -> mount(this -> userData);
-        return err == 0 ? true : false;
+        return err == 0;
+    #else
+        return false; // Unsupported board
     #endif
 }
 
 bool InternalStorage::unmount(){
     int err = this -> userDataFileSystem -> unmount();
-    return err == 0 ? true : false;
+    return err == 0;
 }
 
 Folder InternalStorage::getRootFolder(){
@@ -75,24 +77,24 @@ void InternalStorage::setQSPIPartitionName(const char * name){
 bool InternalStorage::format(FileSystems fs){
     this -> begin();
     this -> unmount();
-    this -> fs = fs;
+    this -> fileSystem = fs;
 
 
     if(fs == FS_FAT){
         #if defined(ARDUINO_PORTENTA_C33)
             this -> userDataFileSystem = new FATFileSystem(this->partitionName);
-            return this -> userDataFileSystem -> reformat(this-> userData)  == 0 ? true : false;
+            return this -> userDataFileSystem -> reformat(this-> userData)  == 0;
         #elif defined(ARDUINO_PORTENTA_H7_M7) ||  defined(ARDUINO_OPTA) 
             this -> userDataFileSystem =  new mbed::FATFileSystem(this->partitionName);
-            return this -> userDataFileSystem -> reformat(this-> userData)  == 0 ? true : false;
+            return this -> userDataFileSystem -> reformat(this-> userData)  == 0;
         #endif
     } if (fs == FS_LITTLEFS) {
         #if defined(ARDUINO_PORTENTA_C33)
             this -> userDataFileSystem = new LittleFileSystem(this->partitionName);
-            return this -> userDataFileSystem -> reformat(this-> userData)  == 0 ? true : false;
+            return this -> userDataFileSystem -> reformat(this-> userData)  == 0;
         #elif defined(ARDUINO_PORTENTA_H7_M7) ||  defined(ARDUINO_OPTA) 
             this -> userDataFileSystem =  new mbed::LittleFileSystem(this->partitionName);
-            return this -> userDataFileSystem -> reformat(this-> userData)  == 0 ? true : false;
+            return this -> userDataFileSystem -> reformat(this-> userData)  == 0;
         #endif
     }
 
diff --git a/src/InternalStorage.h b/src/InternalStorage.h
@@ -25,22 +25,22 @@ class InternalStorage : public Arduino_UnifiedStorage {
     /**
      * Initializes the internal storage.
      * 
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool begin() override;
 
     /**
      * Initializes the internal storage with the specified file system.
      * 
      * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool begin(FileSystems fs) override;
 
     /**
      * Unmounts the internal storage.
      * 
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool unmount() override;
 
@@ -68,7 +68,7 @@ class InternalStorage : public Arduino_UnifiedStorage {
     /**
      * Formats the internal storage with the selceted file system.
      * 
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool format(FileSystems fs) override;
 
@@ -101,7 +101,7 @@ class InternalStorage : public Arduino_UnifiedStorage {
         #endif
 
         char * partitionName;
-        FileSystems fs;
+        FileSystems fileSystem;
 };
 
 #endif
diff --git a/src/SDStorage.cpp b/src/SDStorage.cpp
@@ -9,7 +9,7 @@ SDStorage::SDStorage(){
 }
 
 bool SDStorage::begin(){
-  return mount(DEV_SDCARD, this->fileSystem, MNT_DEFAULT) == 0 ? true : false;
+  return mount(DEV_SDCARD, this->fileSystem, MNT_DEFAULT) == 0;
 }
 
 bool SDStorage::begin(FileSystems fs){
@@ -18,7 +18,7 @@ bool SDStorage::begin(FileSystems fs){
 }
 
 bool SDStorage::unmount(){
-    return umount(DEV_SDCARD) == 0 ? true : false;
+    return umount(DEV_SDCARD) == 0;
 }
 
 Folder SDStorage::getRootFolder(){
@@ -39,7 +39,7 @@ bool SDStorage::format(FileSystems fs){
         err =  mkfs(DEV_SDCARD, FS_LITTLEFS);
     }
 
-    return err == 0 ? true : false;
+    return err == 0;
 }
 
 
diff --git a/src/SDStorage.h b/src/SDStorage.h
@@ -20,22 +20,22 @@ class SDStorage: public Arduino_UnifiedStorage  {
         /**
          * Initializes the SD card storage.
          * 
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         bool begin() override ;
 
         /**
          * Initializes the SD card storage with the specified file system.
          * 
          * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         bool begin(FileSystems fs) override;
 
         /**
          * Unmounts the SD card storage.
          * 
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         bool unmount() override;
 
@@ -49,7 +49,7 @@ class SDStorage: public Arduino_UnifiedStorage  {
         /**
          * Formats the SD card storage with the selected file system.
          * 
-         * @return 1 if successful, 0 if failed.
+         * @return true if successful, false if failed.
          */
         bool format(FileSystems fs) override;
         
diff --git a/src/USBStorage.cpp b/src/USBStorage.cpp
@@ -38,7 +38,7 @@ bool USBStorage::begin(){
         this -> connected = false;
     }
 
-    return err == 0 ? true : false;
+    return err == 0;
 }
 
 bool USBStorage::unmount(){
@@ -49,7 +49,7 @@ bool USBStorage::unmount(){
       this -> connected = false;
   }
 
-    return unmountResult == 0 ? true : false;
+    return unmountResult == 0;
 }
 
 Folder USBStorage::getRootFolder(){
@@ -90,12 +90,12 @@ bool  USBStorage::format(FileSystems fs){
         this -> begin();
         this -> unmount();
         this -> fileSystem = FS_FAT;
-        return mkfs(DEV_USB, FS_FAT) == 0 ? true : false;
+        return mkfs(DEV_USB, FS_FAT) == 0;
     } else if(FS_LITTLEFS) {
         this -> begin();
         this -> unmount();
         this -> fileSystem = FS_LITTLEFS;
-        return mkfs(DEV_USB, FS_LITTLEFS) == 0 ? true : false;
+        return mkfs(DEV_USB, FS_LITTLEFS) == 0;
     }
 
 }
diff --git a/src/USBStorage.h b/src/USBStorage.h
@@ -17,22 +17,22 @@ class USBStorage : public Arduino_UnifiedStorage {
     /**
      * Initializes the USB storage.
      * 
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool begin() override;
 
     /**
      * Initializes the USB storage with the specified file system.
      * 
      * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool begin(FileSystems fs) override;
 
     /**
      * Unmounts the USB storage.
      * 
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool unmount() override;
 
@@ -46,7 +46,7 @@ class USBStorage : public Arduino_UnifiedStorage {
     /**
      * Formats the USB storage with the selected file system.
      * 
-     * @return 1 if successful, 0 if failed.
+     * @return true if successful, false if failed.
      */
     bool format(FileSystems fs) override;
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ SDStorage::SDStorage(){`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`bool SDStorage::begin(){`
`12`		`- return mount(DEV_SDCARD, this->fileSystem, MNT_DEFAULT) == 0 ? true : false;`
	`12`	`+ return mount(DEV_SDCARD, this->fileSystem, MNT_DEFAULT) == 0;`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`bool SDStorage::begin(FileSystems fs){`
`@@ -18,7 +18,7 @@ bool SDStorage::begin(FileSystems fs){`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`bool SDStorage::unmount(){`
`21`		`- return umount(DEV_SDCARD) == 0 ? true : false;`
	`21`	`+ return umount(DEV_SDCARD) == 0;`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`Folder SDStorage::getRootFolder(){`
`@@ -39,7 +39,7 @@ bool SDStorage::format(FileSystems fs){`
`39`	`39`	`err = mkfs(DEV_SDCARD, FS_LITTLEFS);`
`40`	`40`	`}`
`41`	`41`
`42`		`- return err == 0 ? true : false;`
	`42`	`+ return err == 0;`
`43`	`43`	`}`
`44`	`44`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ bool USBStorage::begin(){`
`38`	`38`	`this -> connected = false;`
`39`	`39`	`}`
`40`	`40`
`41`		`- return err == 0 ? true : false;`
	`41`	`+ return err == 0;`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`bool USBStorage::unmount(){`
`@@ -49,7 +49,7 @@ bool USBStorage::unmount(){`
`49`	`49`	`this -> connected = false;`
`50`	`50`	`}`
`51`	`51`
`52`		`- return unmountResult == 0 ? true : false;`
	`52`	`+ return unmountResult == 0;`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`Folder USBStorage::getRootFolder(){`
`@@ -90,12 +90,12 @@ bool USBStorage::format(FileSystems fs){`
`90`	`90`	`this -> begin();`
`91`	`91`	`this -> unmount();`
`92`	`92`	`this -> fileSystem = FS_FAT;`
`93`		`- return mkfs(DEV_USB, FS_FAT) == 0 ? true : false;`
	`93`	`+ return mkfs(DEV_USB, FS_FAT) == 0;`
`94`	`94`	`} else if(FS_LITTLEFS) {`
`95`	`95`	`this -> begin();`
`96`	`96`	`this -> unmount();`
`97`	`97`	`this -> fileSystem = FS_LITTLEFS;`
`98`		`- return mkfs(DEV_USB, FS_LITTLEFS) == 0 ? true : false;`
	`98`	`+ return mkfs(DEV_USB, FS_LITTLEFS) == 0;`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`}`