Rename variables

Author: sebromero

src/UFile.cpp

@@ -2,9 +2,9 @@
 
 #include <cstdio>
 
-UFile::UFile() : fp(nullptr) {}
+UFile::UFile() : filePointer(nullptr) {}
 
-UFile::UFile(const char* path) : fp(nullptr), path(path) {}
+UFile::UFile(const char* path) : filePointer(nullptr), path(path) {}
 
 UFile::~UFile() {
     close();
@@ -36,10 +36,10 @@ bool UFile::open(const char* filename, FileMode fileMode) {
     }
 
     // Open the file
-    fp = fopen(filename, mode);
-    fm = fileMode;
+    filePointer = fopen(filename, mode);
+    this -> fileMode = fileMode;
 
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // Failed to open the file
         return false;
     }
@@ -53,61 +53,61 @@ bool UFile::open(String filename, FileMode mode) {
 
 void UFile::close() {
     // Close the file
-    if (fp != nullptr) {
-        fclose(fp);
+    if (filePointer != nullptr) {
+        fclose(filePointer);
     }
 }
 
 bool UFile::seek(size_t offset) {
     // Seek to a specific position in the file
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return false;
     }
 
-    int result = fseek(fp, offset, SEEK_SET);
+    int result = fseek(filePointer, offset, SEEK_SET);
     return (result == 0);
 }
 
 int UFile::available() {
     // Check the available data in the file
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return 0;
     }
 
-    int currentPosition = ftell(fp);
-    fseek(fp, 0, SEEK_END);
-    int fileSize = ftell(fp);
-    fseek(fp, currentPosition, SEEK_SET);
+    int currentPosition = ftell(filePointer);
+    fseek(filePointer, 0, SEEK_END);
+    int fileSize = ftell(filePointer);
+    fseek(filePointer, currentPosition, SEEK_SET);
 
     return (fileSize - currentPosition);
 }
 
 int UFile::read() {
     // Read a single byte from the file
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return 0;
     }
 
-    int value = fgetc(fp);
+    int value = fgetc(filePointer);
     return value;
 }
 
 size_t UFile::read(uint8_t* buffer, size_t size) {
     // Read data from the file into the buffer
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return 0;
     }
 
-    size_t bytesRead = fread(buffer, sizeof(uint8_t), size, fp);
+    size_t bytesRead = fread(buffer, sizeof(uint8_t), size, filePointer);
     return bytesRead;
 }
 
 String UFile::readAsString() {
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         return String("");
     }
 
@@ -128,33 +128,33 @@ String UFile::readAsString() {
 
 size_t UFile::write(uint8_t value) {
     // Write a single byte to the file
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return 0;
     }
 
-    int result = fputc(value, fp);
+    int result = fputc(value, filePointer);
     return (result != EOF) ? 1 : 0;
 }
 
 size_t UFile::write(String data) {
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return 0;
     }
 
     // Write data to the file
-    size_t bytesWritten = fwrite(data.c_str(), sizeof(char), data.length(), fp);
+    size_t bytesWritten = fwrite(data.c_str(), sizeof(char), data.length(), filePointer);
     return bytesWritten;
 }
 
 size_t UFile::write(const uint8_t* buffer, size_t size) {
-    if (fp == nullptr) {
+    if (filePointer == nullptr) {
         // File pointer is not valid
         return 0;
     }
 
-    size_t bytesWritten = fwrite(buffer, sizeof(uint8_t), size, fp);
+    size_t bytesWritten = fwrite(buffer, sizeof(uint8_t), size, filePointer);
     return bytesWritten;
 }
 
@@ -271,7 +271,7 @@ bool UFile::moveTo(const char* destinationPath, bool overwrite){
 
     FILE* destinationFile = fopen(newPath.c_str(), "r");
 
-    fclose(fp);
+    fclose(filePointer);
     if (!copyTo(destinationPath, overwrite)) {
         return false; // Return false if the copy operation fails
     }
@@ -281,7 +281,7 @@ bool UFile::moveTo(const char* destinationPath, bool overwrite){
         return false;
     }
 
-    open(newPath.c_str(), fm); // sure about that ?
+    open(newPath.c_str(), fileMode); // sure about that ?
     path = newPath;
 
     return true;

src/UFile.h

@@ -199,9 +199,9 @@ class UFile{
 
 
 private:
-  FILE* fp;
+  FILE* filePointer;
   uint8_t* readBuffer;
   std::string path;
-  FileMode fm;
+  FileMode fileMode;
 };
 #endif

src/USBStorage.cpp

@@ -4,30 +4,31 @@
     #include <Arduino_USBHostMbed5.h>
 #endif
 
-#define MAX_TRIES 10
+// The maximum number of attempts to mount the USB drive
+constexpr auto MAX_MOUNT_ATTEMPTS = 10;
 
-bool USBStorage::usb_available = false;
+bool USBStorage::usbAvailable = false;
 
 USBStorage::USBStorage(){
 #if defined(ARDUINO_PORTENTA_C33)
     register_hotplug_callback(DEV_USB,  [](){
-        usb_available = !usb_available;
+        usbAvailable = !usbAvailable;
     });
 #endif
 }
 
 int USBStorage::begin(FileSystems fs){
-  this -> fs = fs;
+  this -> fileSystem = fs;
   this -> begin();
 }
 
 int USBStorage::begin(){
     int attempts = 0;
-    int err = mount(DEV_USB, this->fs, MNT_DEFAULT);
+    int err = mount(DEV_USB, this->fileSystem, MNT_DEFAULT);
 
-    while (0 != err && attempts < MAX_TRIES) {
+    while (0 != err && attempts < MAX_MOUNT_ATTEMPTS) {
         attempts +=1;
-        err = mount(DEV_USB, this->fs, MNT_DEFAULT);
+        err = mount(DEV_USB, this->fileSystem, MNT_DEFAULT);
         delay(1000);
     }
 
@@ -56,7 +57,7 @@ Folder USBStorage::getRootFolder(){
 }
 
 bool USBStorage::isAvailable(){
-    return usb_available;
+    return usbAvailable;
 }
 
 bool USBStorage::isConnected(){
@@ -75,10 +76,10 @@ void USBStorage::checkConnection(){
       host = USBHost::getHostInst();
 
       if ((dev = host->getDevice(0)) != NULL){
-          usb_available = true;
+          usbAvailable = true;
           found = true;
       } else{
-          usb_available = false;
+          usbAvailable = false;
       }
     }
 #endif
@@ -87,13 +88,13 @@ void USBStorage::checkConnection(){
 int USBStorage::formatFAT(){
     this -> begin();
     this -> unmount();
-    this -> fs = FS_FAT;
+    this -> fileSystem = FS_FAT;
     return mkfs(DEV_USB, FS_FAT);
 }
 
 int USBStorage::formatLittleFS(){
     this -> begin();
     this -> unmount();
-    this -> fs = FS_LITTLEFS;
+    this -> fileSystem = FS_LITTLEFS;
     return mkfs(DEV_USB, FS_LITTLEFS);
 }

src/USBStorage.h

@@ -77,11 +77,11 @@ class USBStorage : public Arduino_UnifiedStorage {
     void checkConnection();
 
 private:
-    FileSystems fs = FS_FAT;
+    FileSystems fileSystem = FS_FAT;
     bool connected = false;
     unsigned long previousMillis; 
     unsigned int interval = 500;
-    static bool usb_available;
+    static bool usbAvailable;
 };
 
 #endif