clang-format implementation (#1740)

* Testing clang-format style check using github CI

* github/push: implement check-style for clang-format as a separate build step

* github/push: add missing packages for check-style/clang-format build step

* source/Makefile: check-style - reduce files of interest; update .clang-format to keep enums init

* source/Makefile: empty lines, spaces & tabs refactoring to unify style - part 1 out of N

* source/Makefile: fix formatting for multi-line variables

* source/Makefile: update formatting for multi-line variables

* source/Makefile: remove spaces on vars assignments to unify style

* source/Makefile: remove unused target style

* source/Makefile: implement exclude vars for clang-format related files

* source/Makefile: exclude configuration.h from clang-format check

* Dockerfile: add diffutils in a container to make check-style target using advanced version of diff to get more advanced output to parse & navigate log more easily

* source/Makefile: implement parser for clang-format inside check-style target to make output compatible with gcc-like error compilation format for compatibility with IDEs/editors for easy navigation over files to fix style errors

* source/Makefile: probably final touches on unifying style

* source/Makefile: implement check-style-list target to only list affected file names with wrong code style for debug purposes

* source/Makefile: fix missed spaces

* deploy.sh: add helper routine to deal with clang-format error output logging from makefile

* gitignore: add clang-format log explicitly

* Refactoring for clang-format compiance

* Dockerfile: add sed

* Dockerfile: false alarm - remove sed since busybox-sed seems fine

* source/Makefile: reduce calls of clang-format & make error log more clean, clear, and tidy

* deploy.sh:check_style() - add removal of DOS EOLs for generated log

* source/Makefile:check-style: add more empty lines between blocks with errors for readability when suggestion is too long & heavy

* source/Makefile: add STOP var to check-style for exit on first failed file

* source/Makefile: check-style: make log looks more like traditional diff/patch output

* source/Core/BSP/Pinecilv2/MemMang/heap_5.c: clang-format refactoring using reasonable advises ... and then disable it in Makefile from scanning by clang-format

* Return headers include order

* clang-format config: disable warnings about non-alphabetic include order

* clang-format refactoring

* clang-format refactoring, part 2

* clang-format refactoring, part 3

* settingsGUI.cpp: refactoring, part 1

* settingsGUI.cpp: refactoring, part 2

* settingsGUI.cpp: refactoring, part 3

* settingsGUI.cpp: refactoring, part 4

* clang-format should be happy now

* workflows/push: put readme check into separate build step & update style

* clang-format: giving SortIncludes option second chance by tweaking a couple of headers a bit

* source/Makefile: check-style: add homebrew parser to check for { } in conditional blocks

* homebrew-format: add { } for if/else, while, and for & unify some comments style; left two errors intentionally to debug & improve parser

* source/Makefile: homebrew-format: fix false negative trigger for multi-line condition in if-s

* Sleep.cpp: unify style & comments

* source/Makefile: remove unused debug target

source/Core/Threads/OperatingModes/utils/DrawTipTemperature.cpp

@@ -14,16 +14,18 @@ void gui_drawTipTemp(bool symbol, const FontStyle font) {
   if (symbol) {
     if (font == FontStyle::LARGE) {
       // Big font, can draw nice symbols
-      if (getSettingValue(SettingsOptions::TemperatureInF))
+      if (getSettingValue(SettingsOptions::TemperatureInF)) {
         OLED::drawSymbol(0);
-      else
+      } else {
         OLED::drawSymbol(1);
+      }
     } else {
       // Otherwise fall back to chars
-      if (getSettingValue(SettingsOptions::TemperatureInF))
+      if (getSettingValue(SettingsOptions::TemperatureInF)) {
         OLED::print(SmallSymbolDegF, FontStyle::SMALL);
-      else
+      } else {
         OLED::print(SmallSymbolDegC, FontStyle::SMALL);
+      }
     }
   }
-}
+}

source/Core/Threads/OperatingModes/utils/SolderingCommon.cpp

@@ -2,8 +2,8 @@
 // Created by laura on 24.04.23.
 //
 
-#include "OperatingModes.h"
 #include "SolderingCommon.h"
+#include "OperatingModes.h"
 
 extern bool heaterThermalRunaway;
 
@@ -16,7 +16,8 @@ void detailedPowerStatus() {
   // Print wattage
   {
     uint32_t x10Watt = x10WattHistory.average();
-    if (x10Watt > 999) { // If we exceed 99.9W we drop the decimal place to keep it all fitting
+    if (x10Watt > 999) {
+      // If we exceed 99.9W we drop the decimal place to keep it all fitting
       OLED::print(SmallSymbolSpace, FontStyle::SMALL);
       OLED::printNumber(x10WattHistory.average() / 10, 3, FontStyle::SMALL);
     } else {
@@ -42,30 +43,35 @@ void basicSolderingStatus(bool boostModeOn) {
   if (OLED::getRotation()) {
     // battery
     gui_drawBatteryIcon();
-    OLED::print(LargeSymbolSpace, FontStyle::LARGE); // Space out gap between battery <-> temp
-    gui_drawTipTemp(true, FontStyle::LARGE);         // Draw current tip temp
+    // Space out gap between battery <-> temp
+    OLED::print(LargeSymbolSpace, FontStyle::LARGE);
+    // Draw current tip temp
+    gui_drawTipTemp(true, FontStyle::LARGE);
 
-    // We draw boost arrow if boosting, or else gap temp <-> heat
-    // indicator
-    if (boostModeOn)
+    // We draw boost arrow if boosting,
+    // or else gap temp <-> heat indicator
+    if (boostModeOn) {
       OLED::drawSymbol(2);
-    else
+    } else {
       OLED::print(LargeSymbolSpace, FontStyle::LARGE);
+    }
 
     // Draw heating/cooling symbols
     OLED::drawHeatSymbol(X10WattsToPWM(x10WattHistory.average()));
   } else {
     // Draw heating/cooling symbols
     OLED::drawHeatSymbol(X10WattsToPWM(x10WattHistory.average()));
-    // We draw boost arrow if boosting, or else gap temp <-> heat
-    // indicator
-    if (boostModeOn)
+    // We draw boost arrow if boosting,
+    // or else gap temp <-> heat indicator
+    if (boostModeOn) {
       OLED::drawSymbol(2);
-    else
+    } else {
       OLED::print(LargeSymbolSpace, FontStyle::LARGE);
-    gui_drawTipTemp(true, FontStyle::LARGE); // Draw current tip temp
-
-    OLED::print(LargeSymbolSpace, FontStyle::LARGE); // Space out gap between battery <-> temp
+    }
+    // Draw current tip temp
+    gui_drawTipTemp(true, FontStyle::LARGE);
+    // Space out gap between battery <-> temp
+    OLED::print(LargeSymbolSpace, FontStyle::LARGE);
 
     gui_drawBatteryIcon();
   }

source/Core/Threads/OperatingModes/utils/drawPowerSourceIcon.cpp

@@ -6,10 +6,11 @@ void gui_drawBatteryIcon(void) {
     // On non-DC inputs we replace this symbol with the voltage we are operating on
     // If <9V then show single digit, if not show dual small ones vertically stacked
     uint16_t V = getInputVoltageX10(getSettingValue(SettingsOptions::VoltageDiv), 0);
-    if (V % 10 >= 5)
+    if (V % 10 >= 5) {
       V = (V / 10) + 1; // round up
-    else
+    } else {
       V = V / 10;
+    }
     if (V > 9) {
       int16_t xPos = OLED::getCursorX();
       OLED::printNumber(V / 10, 1, FontStyle::SMALL);
@@ -30,14 +31,16 @@ void gui_drawBatteryIcon(void) {
     uint32_t cellV     = getInputVoltageX10(getSettingValue(SettingsOptions::VoltageDiv), 0) / cellCount;
     // Should give us approx cell voltage X10
     // Range is 42 -> Minimum voltage setting (systemSettings.minVoltageCells) = 9 steps therefore we will use battery 0-9
-    if (cellV < getSettingValue(SettingsOptions::MinVoltageCells))
+    if (cellV < getSettingValue(SettingsOptions::MinVoltageCells)) {
       cellV = getSettingValue(SettingsOptions::MinVoltageCells);
+    }
     cellV -= getSettingValue(SettingsOptions::MinVoltageCells); // Should leave us a number of 0-9
-    if (cellV > 9)
+    if (cellV > 9) {
       cellV = 9;
+    }
     OLED::drawBattery(cellV + 1);
   } else {
     OLED::drawSymbol(15); // Draw the DC Logo
   }
 #endif
-}
+}

source/Core/Threads/OperatingModes/utils/getSleepTimeout.cpp

@@ -7,12 +7,13 @@ uint32_t getSleepTimeout(void) {
   if (getSettingValue(SettingsOptions::Sensitivity) && getSettingValue(SettingsOptions::SleepTime)) {
 
     uint32_t sleepThres = 0;
-    if (getSettingValue(SettingsOptions::SleepTime) < 6)
+    if (getSettingValue(SettingsOptions::SleepTime) < 6) {
       sleepThres = getSettingValue(SettingsOptions::SleepTime) * 10 * 1000;
-    else
+    } else {
       sleepThres = (getSettingValue(SettingsOptions::SleepTime) - 5) * 60 * 1000;
+    }
     return sleepThres;
   }
   return 0;
 }
-#endif
+#endif

source/Core/Threads/OperatingModes/utils/min.cpp

@@ -3,8 +3,9 @@
 #include "OperatingModeUtilities.h"
 #include <stdint.h>
 uint16_t min(uint16_t a, uint16_t b) {
-  if (a > b)
+  if (a > b) {
     return b;
-  else
+  } else {
     return a;
-}
+  }
+}

source/Core/Threads/OperatingModes/utils/shouldDeviceSleep.cpp

@@ -26,8 +26,9 @@ bool shouldBeSleeping(bool inAutoStart) {
   // threshold, and if so then we force sleep
   if (getHallSensorFitted() && lookupHallEffectThreshold()) {
     int16_t hallEffectStrength = getRawHallEffect();
-    if (hallEffectStrength < 0)
+    if (hallEffectStrength < 0) {
       hallEffectStrength = -hallEffectStrength;
+    }
     // Have absolute value of measure of magnetic field strength
     if (hallEffectStrength > lookupHallEffectThreshold()) {
       if (lastHallEffectSleepStart == 0) {
@@ -43,4 +44,4 @@ bool shouldBeSleeping(bool inAutoStart) {
 #endif
 #endif
   return false;
-}
+}