Use bool type instead of uint8_t

Signed-off-by: Frederic.Pillon <[email protected]>

Author: fpistm

examples/Datalogger/Datalogger.ino

@@ -30,7 +30,7 @@ void setup()
 
   Serial.print("Initializing SD card...");
   // see if the card is present and can be initialized:
-  while (SD.begin(SD_DETECT_PIN) != TRUE)
+  while (!SD.begin(SD_DETECT_PIN))
   {
     delay(10);
   }

examples/DumpFile/DumpFile.ino

@@ -30,7 +30,7 @@ void setup()
 
   Serial.print("Initializing SD card...");
   // see if the card is present and can be initialized:
-  while (SD.begin(SD_DETECT_PIN) != TRUE)
+  while (!SD.begin(SD_DETECT_PIN))
   {
     delay(10);
   }

examples/Files/Files.ino

@@ -29,7 +29,7 @@ void setup()
 
   Serial.print("Initializing SD card...");
 
-  while (SD.begin(SD_DETECT_PIN) != TRUE)
+  while (!SD.begin(SD_DETECT_PIN))
   {
     delay(10);
   }

examples/Full/Full.ino

@@ -9,14 +9,14 @@
 #define COUNTOF(__BUFFER__)   (sizeof(__BUFFER__) / sizeof(*(__BUFFER__)))
 #define BUFFERSIZE                       (COUNTOF(wtext) -1)
 
-uint32_t file_size = 0, seek_val = FALSE, peek_val = 0;
+uint32_t file_size = 0, seek_val = false, peek_val = 0;
 uint32_t byteswritten, bytesread = 0;
 /* File write buffer */
 uint8_t wtext[] =  "This is the Arduino SD Test working with FatFs.";
 /* File read buffer */
 uint8_t rtext[BUFFERSIZE];
 uint32_t i = 0;
-uint8_t isdir = FALSE;
+bool isdir = false;
 File MyFile;
 
 void setup()
@@ -25,27 +25,27 @@ void setup()
   while (!Serial);
 
   /* Test begin() method */
-  while (SD.begin(SD_DETECT_PIN) != TRUE)
+  while (!SD.begin(SD_DETECT_PIN))
   {
     delay(10);
   }
   delay(100);
 
   /* Test mkdir() method */
   Serial.print("Creating 'STM32' directory...");
-  if (SD.mkdir("STM32") == TRUE) {
+  if (SD.mkdir("STM32")) {
     Serial.println("OK");
   } else {
     Serial.println("KO");
   }
   Serial.print("Creating 'ARDUINO' directory...");
-  if (SD.mkdir("ARDUINO") == TRUE) {
+  if (SD.mkdir("ARDUINO")) {
     Serial.println("OK");
   } else {
     Serial.println("KO");
   }
   Serial.print("Creating 'ARDUINO/SD' directory...");
-  if (SD.mkdir("ARDUINO/SD") == TRUE) {
+  if (SD.mkdir("ARDUINO/SD")) {
     Serial.println("OK");
   } else {
     Serial.println("KO");
@@ -224,14 +224,14 @@ void setup()
   }
   /* Test exists(), remove() and rmdir() methods */
   Serial.print("Removing 'STM32/Toremove.txt' file...");
-  while (SD.exists("STM32/Toremove.txt") == TRUE)
+  while (SD.exists("STM32/Toremove.txt") == true)
   {
     SD.remove("STM32/Toremove.txt");
   }
   Serial.println("OK");
 
   Serial.print("Removing 'STM32' dir...");
-  while (SD.exists("STM32") == TRUE)
+  while (SD.exists("STM32") == true)
   {
     SD.rmdir("STM32");
   }

examples/ReadWrite/ReadWrite.ino

@@ -29,7 +29,7 @@ void setup()
 
 
   Serial.print("Initializing SD card...");
-  while (SD.begin(SD_DETECT_PIN) != TRUE)
+  while (!SD.begin(SD_DETECT_PIN))
   {
     delay(10);
   }

examples/listfiles/listfiles.ino

@@ -29,7 +29,7 @@ void setup()
   }
 
   Serial.print("Initializing SD card...");
-  while (SD.begin(SD_DETECT_PIN) != TRUE)
+  while (!SD.begin(SD_DETECT_PIN))
   {
     delay(10);
   }

src/SD.cpp

@@ -60,59 +60,59 @@ SDClass SD;
   * @brief  Link SD, register the file system object to the FatFs mode and configure
   *         relatives SD IOs including SD Detect Pin if any
   * @param  None
-  * @retval TRUE or FALSE
+  * @retval true or false
   */
-uint8_t SDClass::begin(uint32_t detectpin)
+bool SDClass::begin(uint32_t detectpin)
 {
   /*##-1- Initializes SD IOs #############################################*/
   if (_card.init(detectpin)) {
     return _fatFs.init();
   }
-  return FALSE;
+  return false;
 }
 
 /**
   * @brief  Check if a file or folder exist on the SD disk
   * @param  filename: File name
-  * @retval TRUE or FALSE
+  * @retval true or false
   */
-uint8_t SDClass::exists(const char *filepath)
+bool SDClass::exists(const char *filepath)
 {
   FILINFO fno;
 
   if (f_stat(filepath, &fno) != FR_OK) {
-    return FALSE;
+    return false;
   } else {
-    return TRUE;
+    return true;
   }
 }
 
 /**
   * @brief  Create directory on the SD disk
   * @param  filename: File name
-  * @retval TRUE if created or existing else FALSE
+  * @retval true if created or existing else false
   */
-uint8_t SDClass::mkdir(const char *filepath)
+bool SDClass::mkdir(const char *filepath)
 {
   FRESULT res = f_mkdir(filepath);
   if ((res != FR_OK) && (res != FR_EXIST)) {
-    return FALSE;
+    return false;
   } else {
-    return TRUE;
+    return true;
   }
 }
 
 /**
   * @brief  Remove directory on the SD disk
   * @param  filename: File name
-  * @retval TRUE or FALSE
+  * @retval true or false
   */
-uint8_t SDClass::rmdir(const char *filepath)
+bool SDClass::rmdir(const char *filepath)
 {
   if (f_unlink(filepath) != FR_OK) {
-    return FALSE;
+    return false;
   } else {
-    return TRUE;
+    return true;
   }
 }
 
@@ -141,7 +141,7 @@ File SDClass::open(const char *filepath, uint8_t mode)
 {
   File file = File(filepath);
 
-  if ((mode == FILE_WRITE) && (SD.exists(filepath) != TRUE)) {
+  if ((mode == FILE_WRITE) && (!SD.exists(filepath))) {
     mode = mode | FA_CREATE_ALWAYS;
   }
 
@@ -154,14 +154,14 @@ File SDClass::open(const char *filepath, uint8_t mode)
 /**
   * @brief  Remove a file on the SD disk
   * @param  filename: File name
-  * @retval TRUE or FALSE
+  * @retval true or false
   */
-uint8_t SDClass::remove(const char *filepath)
+bool SDClass::remove(const char *filepath)
 {
   if (f_unlink(filepath) != FR_OK) {
-    return FALSE;
+    return false;
   } else {
-    return TRUE;
+    return true;
   }
 }
 
@@ -455,17 +455,17 @@ uint32_t File::position()
 /**
   * @brief  Seek to a new position in the file
   * @param  pos: The position to which to seek
-  * @retval TRUE or FALSE
+  * @retval true or false
   */
-uint8_t File::seek(uint32_t pos)
+bool File::seek(uint32_t pos)
 {
   if (pos > size()) {
-    return FALSE;
+    return false;
   } else {
     if (f_lseek(_fil, pos) != FR_OK) {
-      return FALSE;
+      return false;
     } else {
-      return TRUE;
+      return true;
     }
   }
 }
@@ -486,9 +486,9 @@ uint32_t File::size()
 File::operator bool()
 {
 #if _FATFS == 68300
-  return ((_name == NULL) || ((_fil == NULL) && (_dir.obj.fs == 0)) || ((_fil != NULL) && (_fil->obj.fs == 0) && (_dir.obj.fs == 0))) ? FALSE : TRUE;
+  return !((_name == NULL) || ((_fil == NULL) && (_dir.obj.fs == 0)) || ((_fil != NULL) && (_fil->obj.fs == 0) && (_dir.obj.fs == 0)));
 #else
-  return ((_name == NULL) || ((_fil == NULL) && (_dir.fs == 0)) || ((_fil != NULL) && (_fil->fs == 0) && (_dir.fs == 0))) ? FALSE : TRUE;
+  return !((_name == NULL) || ((_fil == NULL) && (_dir.fs == 0)) || ((_fil != NULL) && (_fil->fs == 0) && (_dir.fs == 0)));
 #endif
 }
 /**
@@ -584,7 +584,7 @@ char *File::name()
   * @brief  Check if the file is directory or normal file
   * @retval TRUE if directory else FALSE
   */
-uint8_t File::isDirectory()
+bool File::isDirectory()
 {
   FILINFO fno;
   if (_name == NULL) {
@@ -595,21 +595,21 @@ uint8_t File::isDirectory()
 #else
   if (_dir.fs != 0)
 #endif
-    return TRUE;
+    return true;
 #if _FATFS == 68300
   else if (_fil->obj.fs != 0)
 #else
   else if (_fil->fs != 0)
 #endif
-    return FALSE;
+    return false;
   // if not init get info
   if (f_stat(_name, &fno) == FR_OK) {
     if (fno.fattrib & AM_DIR) {
-      return TRUE;
+      return true;
     }
   }
   // Assume not a directory
-  return FALSE;
+  return false;
 }
 
 File File::openNextFile(uint8_t mode)

src/STM32SD.h

@@ -43,7 +43,7 @@ class File {
     virtual int available();
     virtual void flush();
     int read(void *buf, size_t len);
-    uint8_t seek(uint32_t pos);
+    bool seek(uint32_t pos);
     uint32_t position();
     uint32_t size();
     void close();
@@ -54,7 +54,7 @@ class File {
     {
       return _name;
     };
-    uint8_t isDirectory();
+    bool isDirectory();
     File openNextFile(uint8_t mode = FILE_READ);
     void rewindDirectory(void);
 
@@ -81,13 +81,13 @@ class SDClass {
   public:
 
     /* Initialize the SD peripheral */
-    uint8_t begin(uint32_t detectpin = SD_DETECT_NONE);
+    bool begin(uint32_t detectpin = SD_DETECT_NONE);
     static File open(const char *filepath, uint8_t mode);
     static File open(const char *filepath);
-    static uint8_t exists(const char *filepath);
-    static uint8_t mkdir(const char *filepath);
-    static uint8_t remove(const char *filepath);
-    static uint8_t rmdir(const char *filepath);
+    static bool exists(const char *filepath);
+    static bool mkdir(const char *filepath);
+    static bool remove(const char *filepath);
+    static bool rmdir(const char *filepath);
 
     File openRoot(void);
 

src/Sd2Card.cpp

@@ -37,21 +37,21 @@
 #include <Arduino.h>
 #include "Sd2Card.h"
 
-uint8_t Sd2Card::init(uint32_t detectpin)
+bool Sd2Card::init(uint32_t detectpin)
 {
   if (detectpin != SD_DETECT_NONE) {
     PinName p = digitalPinToPinName(detectpin);
     if ((p == NC) || \
         BSP_SD_DetectPin(set_GPIO_Port_Clock(STM_PORT(p)),
                          STM_LL_GPIO_PIN(p)) != MSD_OK) {
-      return FALSE;
+      return false;
     }
   }
   if (BSP_SD_Init() == MSD_OK) {
     BSP_SD_GetCardInfo(&_SdCardInfo);
-    return TRUE;
+    return true;
   }
-  return FALSE;
+  return false;
 }
 
 uint8_t Sd2Card::type(void) const

src/Sd2Card.h

@@ -39,9 +39,6 @@
 
 #include "bsp_sd.h"
 
-#define   FALSE      ((uint8_t)0x00)
-#define   TRUE       ((uint8_t)0x01)
-
 // card types to match Arduino definition
 #define SD_CARD_TYPE_UKN      0
 /** Standard capacity V1 SD card */
@@ -56,7 +53,7 @@
 class Sd2Card {
   public:
 
-    uint8_t init(uint32_t detectpin = SD_DETECT_NONE);
+    bool init(uint32_t detectpin = SD_DETECT_NONE);
 
     /** Return the card type: SD V1, SD V2 or SDHC */
     uint8_t type(void) const;