Add style check matching RP2040 core (#740)

Will let us backport the BackgroundAudio patches to libhelix easier and clean
up some ugly formatting we've let develop.

Author: earlephilhower

.github/workflows/pr-or-master-push.yml

@@ -120,13 +120,10 @@ jobs:
         with:
           library-manager: 'update'
 
-# Validate orthography
+# Style and spelling
   code-spell:
-    name: Check spelling
+    name: Spelling, Style
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash
     steps:
     - uses: actions/checkout@v4
       with:
@@ -136,3 +133,10 @@ jobs:
       with:
         skip: ./src/libmad,./src/libhelix-aac,./src/libopus,./src/libflac
         ignore_words_list: ESP8266,esp8266,esp,dout,DOUT,ser,ans,inout,numer,hist
+    - name: Run astyle on all code/examples
+      run: |
+        sudo apt update
+        sudo apt install astyle
+        ./tests/restyle.sh
+        # If anything changed, GIT should return an error and fail the test
+        git diff --exit-code

examples/MixerSample/MixerSample.ino

@@ -1,13 +1,16 @@
 #include <Arduino.h>
 
 #if defined(ARDUINO_ARCH_RP2040)
-    #define WIFI_OFF
-    class __x { public: __x() {}; void mode() {}; };
-    __x WiFi;
+#define WIFI_OFF
+class __x {
+  public: __x() {};
+    void mode() {};
+};
+__x WiFi;
 #elif defined(ESP32)
-    #include <WiFi.h>
+#include <WiFi.h>
 #else
-    #include <ESP8266WiFi.h>
+#include <ESP8266WiFi.h>
 #endif
 
 #include "AudioFileSourcePROGMEM.h"
@@ -24,15 +27,14 @@ AudioOutputI2S *out;
 AudioOutputMixer *mixer;
 AudioOutputMixerStub *stub[2];
 
-void setup()
-{
-  WiFi.mode(WIFI_OFF); 
+void setup() {
+  WiFi.mode(WIFI_OFF);
   Serial.begin(115200);
   delay(1000);
   Serial.printf("WAV start\n");
 
   audioLogger = &Serial;
-  file[0] = new AudioFileSourcePROGMEM( viola, sizeof(viola) );
+  file[0] = new AudioFileSourcePROGMEM(viola, sizeof(viola));
   out = new AudioOutputI2S();
   mixer = new AudioOutputMixer(32, out);
   stub[0] = mixer->NewInput();
@@ -43,29 +45,38 @@ void setup()
   Serial.printf("starting 1\n");
 }
 
-void loop()
-{
+void loop() {
   static uint32_t start = 0;
   static bool go = false;
-  
-  if (!start) start = millis();
+
+  if (!start) {
+    start = millis();
+  }
 
   if (wav[0]->isRunning()) {
-    if (!wav[0]->loop()) { wav[0]->stop(); stub[0]->stop(); Serial.printf("stopping 1\n"); }
+    if (!wav[0]->loop()) {
+      wav[0]->stop();
+      stub[0]->stop();
+      Serial.printf("stopping 1\n");
+    }
   }
 
-  if (millis()-start > 3000) {
+  if (millis() - start > 3000) {
     if (!go) {
       Serial.printf("starting 2\n");
       stub[1] = mixer->NewInput();
       stub[1]->SetGain(0.4);
       wav[1] = new AudioGeneratorWAV();
-      file[1] = new AudioFileSourcePROGMEM( viola, sizeof(viola) );
+      file[1] = new AudioFileSourcePROGMEM(viola, sizeof(viola));
       wav[1]->begin(file[1], stub[1]);
       go = true;
     }
     if (wav[1]->isRunning()) {
-      if (!wav[1]->loop()) { wav[1]->stop(); stub[1]->stop(); Serial.printf("stopping 2\n");}
+      if (!wav[1]->loop()) {
+        wav[1]->stop();
+        stub[1]->stop();
+        Serial.printf("stopping 2\n");
+      }
     }
   }
 

examples/PlayAACFromPROGMEM/PlayAACFromPROGMEM.ino

@@ -8,8 +8,7 @@ AudioFileSourcePROGMEM *in;
 AudioGeneratorAAC *aac;
 AudioOutputI2S *out;
 
-void setup()
-{
+void setup() {
   Serial.begin(115200);
 
   audioLogger = &Serial;
@@ -21,8 +20,7 @@ void setup()
 }
 
 
-void loop()
-{
+void loop() {
   if (aac->isRunning()) {
     aac->loop();
   } else {

examples/PlayFLAC-SD-SPDIF/PlayFLAC-SD-SPDIF.ino

@@ -8,18 +8,18 @@ void loop() {}
 #include "AudioGeneratorFLAC.h"
 
 // For this sketch, you need connected SD card with '.flac' music files in the root
-// directory. Some samples with various sampling rates are available from i.e. 
+// directory. Some samples with various sampling rates are available from i.e.
 // Espressif Audio Development Framework at:
 // https://docs.espressif.com/projects/esp-adf/en/latest/design-guide/audio-samples.html
 //
-// On ESP8266 you might need to re-encode FLAC files with max '-2' compression level 
-// (i.e. 1152 maximum block size) or you will run out of memory. FLAC files will be 
+// On ESP8266 you might need to re-encode FLAC files with max '-2' compression level
+// (i.e. 1152 maximum block size) or you will run out of memory. FLAC files will be
 // slightly bigger but you don't loose audio quality with reencoding (lossles codec).
 
 // You may need a fast SD card. Set this as high as it will work (40MHz max).
 #define SPI_SPEED SD_SCK_MHZ(40)
 
-// On ESP32 you can adjust the SPDIF_OUT_PIN (GPIO number). 
+// On ESP32 you can adjust the SPDIF_OUT_PIN (GPIO number).
 // On ESP8266 it is fixed to GPIO3/RX0 and this setting has no effect
 #define SPDIF_OUT_PIN 27
 
@@ -33,41 +33,43 @@ void setup() {
   Serial.println();
   delay(1000);
 
-  audioLogger = &Serial;  
+  audioLogger = &Serial;
   source = new AudioFileSourceSD();
   output = new AudioOutputSPDIF(SPDIF_OUT_PIN);
   decoder = new AudioGeneratorFLAC();
 
-  // NOTE: SD.begin(...) should be called AFTER AudioOutputSPDIF() 
+  // NOTE: SD.begin(...) should be called AFTER AudioOutputSPDIF()
   //       to takover the the SPI pins if they share some with I2S
   //       (i.e. D8 on Wemos D1 mini is both I2S BCK and SPI SS)
-  #if defined(ESP8266)
-    SD.begin(SS, SPI_SPEED);
-  #else
-    SD.begin();
-  #endif
-  dir = SD.open("/"); 
+#if defined(ESP8266)
+  SD.begin(SS, SPI_SPEED);
+#else
+  SD.begin();
+#endif
+  dir = SD.open("/");
 }
 
 void loop() {
   if ((decoder) && (decoder->isRunning())) {
-    if (!decoder->loop()) decoder->stop();
+    if (!decoder->loop()) {
+      decoder->stop();
+    }
   } else {
     File file = dir.openNextFile();
-    if (file) {      
+    if (file) {
       if (String(file.name()).endsWith(".flac")) {
         source->close();
-        if (source->open(file.name())) { 
+        if (source->open(file.name())) {
           Serial.printf_P(PSTR("Playing '%s' from SD card...\n"), file.name());
           decoder->begin(source, output);
         } else {
           Serial.printf_P(PSTR("Error opening '%s'\n"), file.name());
         }
-      } 
+      }
     } else {
       Serial.println(F("Playback from SD card done\n"));
       delay(1000);
-    }       
+    }
   }
 }
 #endif

examples/PlayFLACFromPROGMEMToDAC/PlayFLACFromPROGMEMToDAC.ino

@@ -9,22 +9,22 @@ AudioOutputI2S *out;
 AudioFileSourcePROGMEM *file;
 AudioGeneratorFLAC *flac;
 
-void setup()
-{
+void setup() {
   Serial.begin(115200);
   Serial.println("Starting up...\n");
 
   audioLogger = &Serial;
-  file = new AudioFileSourcePROGMEM( sample_flac, sizeof(sample_flac) );
+  file = new AudioFileSourcePROGMEM(sample_flac, sizeof(sample_flac));
   out = new AudioOutputI2S();
   flac = new AudioGeneratorFLAC();
   flac->begin(file, out);
 }
 
-void loop()
-{
+void loop() {
   if (flac->isRunning()) {
-    if (!flac->loop()) flac->stop();
+    if (!flac->loop()) {
+      flac->stop();
+    }
   } else {
     Serial.printf("FLAC done\n");
     delay(1000);

examples/PlayMIDIFromLittleFS/PlayMIDIFromLittleFS.ino

@@ -1,17 +1,20 @@
 #include <Arduino.h>
 #ifdef ESP32
-    void setup() {
-        Serial.begin(115200);
-        Serial.printf("ERROR - ESP32 does not support LittleFS\n");
-    }
-    void loop() {}
+void setup() {
+  Serial.begin(115200);
+  Serial.printf("ERROR - ESP32 does not support LittleFS\n");
+}
+void loop() {}
 #else
 #if defined(ARDUINO_ARCH_RP2040)
-    #define WIFI_OFF
-    class __x { public: __x() {}; void mode() {}; };
-    __x WiFi;
+#define WIFI_OFF
+class __x {
+  public: __x() {};
+    void mode() {};
+};
+__x WiFi;
 #else
-    #include <ESP8266WiFi.h>
+#include <ESP8266WiFi.h>
 #endif
 #include <AudioOutputI2S.h>
 #include <AudioGeneratorMIDI.h>
@@ -22,20 +25,19 @@ AudioFileSourceLittleFS *mid;
 AudioOutputI2S *dac;
 AudioGeneratorMIDI *midi;
 
-void setup()
-{
+void setup() {
   const char *soundfont = "/1mgm.sf2";
   const char *midifile = "/furelise.mid";
 
-  WiFi.mode(WIFI_OFF); 
+  WiFi.mode(WIFI_OFF);
 
   Serial.begin(115200);
   Serial.println("Starting up...\n");
 
   audioLogger = &Serial;
   sf2 = new AudioFileSourceLittleFS(soundfont);
   mid = new AudioFileSourceLittleFS(midifile);
-  
+
   dac = new AudioOutputI2S();
   midi = new AudioGeneratorMIDI();
   midi->SetSoundfont(sf2);
@@ -44,8 +46,7 @@ void setup()
   midi->begin(mid, dac);
 }
 
-void loop()
-{
+void loop() {
   if (midi->isRunning()) {
     if (!midi->loop()) {
       midi->stop();

examples/PlayMIDIFromSPIFFS/PlayMIDIFromSPIFFS.ino

@@ -7,10 +7,10 @@ void setup() {}
 void loop() {}
 #else
 #ifdef ESP32
-    #include <WiFi.h>
-    #include "SPIFFS.h"
+#include <WiFi.h>
+#include "SPIFFS.h"
 #else
-    #include <ESP8266WiFi.h>
+#include <ESP8266WiFi.h>
 #endif
 
 
@@ -24,12 +24,11 @@ AudioFileSourceSPIFFS *mid;
 AudioOutputI2S *dac;
 AudioGeneratorMIDI *midi;
 
-void setup()
-{
+void setup() {
   const char *soundfont = "/1mgm.sf2";
   const char *midifile = "/furelise.mid";
 
-  WiFi.mode(WIFI_OFF); 
+  WiFi.mode(WIFI_OFF);
 
   Serial.begin(115200);
   SPIFFS.begin();
@@ -38,7 +37,7 @@ void setup()
   audioLogger = &Serial;
   sf2 = new AudioFileSourceSPIFFS(soundfont);
   mid = new AudioFileSourceSPIFFS(midifile);
-  
+
   dac = new AudioOutputI2S();
   midi = new AudioGeneratorMIDI();
   midi->SetSoundfont(sf2);
@@ -47,8 +46,7 @@ void setup()
   midi->begin(mid, dac);
 }
 
-void loop()
-{
+void loop() {
   if (midi->isRunning()) {
     if (!midi->loop()) {
       midi->stop();