Code style and minor fixes across libs

Apply consistent code style (remove redundant `const` on value params, remove duplicate `private:`, brace style, spacing) across display, displayudf, dmxnode, and pixeldmx libraries. Also fix printf format warnings with explicit casts, update network includes to use more specific headers, add `kTitleSize` constant, fix `vsnprintf` buffer size off-by-one, and update copyright year.

Author: vanvught

lib-display/include/spi/display.h

@@ -105,17 +105,17 @@ class Display : public LcdDriver {
 #else
         printf("ST7789 ");
 #endif
-        printf("(%u,%u)\n", rows_, cols_);
+        printf("(%u,%u)\n", static_cast<unsigned>(rows_), static_cast<unsigned>(cols_));
     }
 
     void Cls() { FillColour(kColorBackground); }
 
-    void SetCursorPos(const uint32_t nCol, const uint32_t row) {
+    void SetCursorPos(uint32_t nCol, uint32_t row) {
         cursor_x_ = nCol * s_pFONT->kWidth;
         cursor_y_ = row * s_pFONT->kHeight;
     }
 
-    void PutChar(const int c) {
+    void PutChar(int c) {
         DrawChar(cursor_x_, cursor_y_, static_cast<char>(c), s_pFONT, kColorBackground, kColorForeground);
 
         cursor_x_ += s_pFONT->kWidth;
@@ -137,7 +137,7 @@ class Display : public LcdDriver {
 	    }
 	}
 
-    void ClearLine(const uint32_t nLine) {
+    void ClearLine(uint32_t nLine) {
         if (__builtin_expect((!(nLine <= rows_)), 0)) {
             return;
         }
@@ -151,7 +151,7 @@ class Display : public LcdDriver {
         SetCursorPos(0, (nLine - 1U));
     }
 
-    void TextLine(const uint32_t nLine, const char* pText, const uint32_t nLength) {
+    void TextLine(uint32_t nLine, const char* pText, const uint32_t nLength) {
         if (__builtin_expect((!(nLine <= rows_)), 0)) {
             return;
         }
@@ -162,18 +162,18 @@ class Display : public LcdDriver {
 
     void ClearEndOfLine() { clear_end_of_line_ = true; }
 
-    void Text(const char* pData, uint32_t nLength) {
-        if (nLength > cols_) {
-            nLength = cols_;
+    void Text(const char* data, uint32_t length) {
+        if (length > cols_) {
+            length = cols_;
         }
 
-        for (uint32_t i = 0; i < nLength; i++) {
-            PutChar(pData[i]);
+        for (uint32_t i = 0; i < length; i++) {
+            PutChar(data[i]);
         }
     }
 
-    int Write(const uint32_t nLine, const char* pText) {
-        const auto* p = pText;
+    int Write(uint32_t line, const char* text) {
+        const auto* p = text;
         int nCount = 0;
 
         const auto columns = static_cast<int>(cols_);
@@ -182,28 +182,28 @@ class Display : public LcdDriver {
             ++p;
         }
 
-        TextLine(nLine, pText, static_cast<uint8_t>(nCount));
+        TextLine(line, text, static_cast<uint8_t>(nCount));
 
         return nCount;
     }
 
-    int Printf(const uint8_t nLine, const char* format, ...) {
+    int Printf(uint8_t line, const char* format, ...) {
         char buffer[32];
 
         va_list arp;
 
         va_start(arp, format);
 
-        auto i = vsnprintf(buffer, sizeof(buffer) / sizeof(buffer[0]), format, arp);
+        const auto kSize = vsnprintf(buffer, sizeof(buffer) / sizeof(buffer[0]), format, arp);
 
         va_end(arp);
 
-        TextLine(nLine, buffer, static_cast<uint16_t>(i));
+        TextLine(line, buffer, static_cast<uint16_t>(kSize));
 
-        return i;
+        return kSize;
     }
 
-    void TextStatus(const char* pText) {
+    void TextStatus(const char* text) {
         SetCursorPos(0, static_cast<uint8_t>(rows_ - 1));
 
         for (uint32_t i = 0; i < (cols_ - 1); i++) {
@@ -212,7 +212,7 @@ class Display : public LcdDriver {
 
         SetCursorPos(0, static_cast<uint8_t>(rows_ - 1));
 
-        Write(rows_, pText);
+        Write(rows_, text);
     }
 
 	void TextStatus(const char* text, ansi::Colours::Colour colour) {
@@ -221,20 +221,20 @@ class Display : public LcdDriver {
 	}
 
     void Progress() {
-        static constexpr char SYMBOLS[] = {'/', '-', '\\', '|'};
+        static constexpr char kSymbols[] = {'/', '-', '\\', '|'};
         static uint32_t nSymbolsIndex;
 
         SetCursorPos(GetColumns() - 1U, GetRows() - 1U);
-        PutChar(SYMBOLS[nSymbolsIndex++]);
+        PutChar(kSymbols[nSymbolsIndex++]);
 
-        if (nSymbolsIndex >= sizeof(SYMBOLS)) {
+        if (nSymbolsIndex >= sizeof(kSymbols)) {
             nSymbolsIndex = 0;
         }
     }
 
-    void SetContrast(const uint8_t nContrast) { SetBackLight(nContrast); }
+    void SetContrast(uint8_t nContrast) { SetBackLight(nContrast); }
 
-    void SetSleep(const bool bSleep) {
+    void SetSleep(bool bSleep) {
         is_sleep_ = bSleep;
 
         EnableSleep(bSleep);
@@ -282,7 +282,6 @@ class Display : public LcdDriver {
    private:
     void SetSleepTimer(const bool bActive);
 
-   private:
     uint32_t cols_;
     uint32_t rows_;
     uint32_t sleep_timeout_{1000U * 60U * display::Defaults::kSleepTimeout};

lib-displayudf/include/displayudf.h

@@ -27,12 +27,13 @@
 #define DISPLAYUDF_H_
 
 #include <cstdint>
-#include <cstdarg>
 
-#include "display.h"
-#include "firmware/firmwareversion.h"
+#include "display.h"                  // IWYU pragma: keep
+#include "firmware/firmwareversion.h" // IWYU pragma: keep
 #if !defined(NO_EMAC)
-#include "network.h"
+#include "network_config.h"
+#include "network_iface.h"
+#include "ip4/ip4_address.h"
 #include "core/protocol/dhcp.h"
 #endif
 #if defined(NODE_ARTNET_MULTI)
@@ -57,14 +58,12 @@
 #if defined(RDM_RESPONDER) || defined(OUTPUT_DMX_MONITOR) || defined(OUTPUT_DMX_PCA9685) || defined(OUTPUT_DMX_PIXEL) || defined(OUTPUT_DMX_TLC59711)
 #define HAVE_DMX_START_ADDRESS
 #endif
-#include "firmware/debug/debug_debug.h"
 
-namespace displayudf
-{
+namespace displayudf {
 inline constexpr uint32_t kLabelMaxRows = 6;
+inline constexpr uint32_t kTitleSize = 32;
 
-enum class Labels : uint8_t
-{
+enum class Labels : uint8_t {
     kTitle,
     kBoardname,
     kVersion,
@@ -101,14 +100,12 @@ enum class Labels : uint8_t
     kUnknown
 };
 
-namespace defaults
-{
+namespace defaults {
 inline constexpr uint8_t kIntensity = 0x7F;
 } // namespace defaults
 } // namespace displayudf
 
-class DisplayUdf final : public Display
-{
+class DisplayUdf final : public Display {
    public:
     DisplayUdf();
 
@@ -120,10 +117,8 @@ class DisplayUdf final : public Display
     void SetTitle(const char* format, ...);
     void Set(uint32_t line, displayudf::Labels label);
 
-    uint8_t GetLabel(uint32_t index) const
-    {
-        if (index < static_cast<uint32_t>(displayudf::Labels::kUnknown))
-        {
+    uint8_t GetLabel(uint32_t index) const {
+        if (index < static_cast<uint32_t>(displayudf::Labels::kUnknown)) {
             return labels_[index];
         }
 
@@ -144,8 +139,7 @@ class DisplayUdf final : public Display
      */
 
 #if defined(RDM_RESPONDER)
-    void ShowDmxStartAddress()
-    {
+    void ShowDmxStartAddress() {
         const auto dmx_start_address = RDMDeviceResponder::Get()->GetDmxStartAddress();
         const auto nDmxFootprint = RDMDeviceResponder::Get()->GetDmxFootPrint();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kDmxStartAddress)], "DMX S:%3u F:%3u", dmx_start_address, nDmxFootprint);
@@ -157,53 +151,44 @@ class DisplayUdf final : public Display
      */
 
 #if !defined(NO_EMAC)
-    void ShowEmacInit()
-    {
+    void ShowEmacInit() {
         ClearEndOfLine();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kIp)], "Ethernet init");
     }
 
-    void ShowEmacStart()
-    {
+    void ShowEmacStart() {
         ClearEndOfLine();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kIp)], "Ethernet start");
     }
 
-    void ShowEmacStatus(bool is_link_up)
-    {
+    void ShowEmacStatus(bool is_link_up) {
         ClearEndOfLine();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kIp)], "Ethernet Link %s", is_link_up ? "UP" : "DOWN");
     }
 
-    void ShowIpAddress()
-    {
+    void ShowIpAddress() {
         ClearEndOfLine();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kIp)], "" IPSTR "/%d %c", IP2STR(network::GetPrimaryIp()), network::GetNetmaskCIDR(), network::iface::AddressingMode());
     }
 
-    void ShowNetmask()
-    {
+    void ShowNetmask() {
         ClearEndOfLine();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kNetmask)], "N: " IPSTR "", IP2STR(network::GetNetmask()));
         ShowIpAddress();
     }
 
-    void ShowGatewayIp()
-    {
+    void ShowGatewayIp() {
         ClearEndOfLine();
         Printf(labels_[static_cast<uint32_t>(displayudf::Labels::kDefaultGateway)], "G: " IPSTR "", IP2STR(network::GetGatewayIp()));
     }
 
-    void ShowHostName()
-    {
+    void ShowHostName() {
         ClearEndOfLine();
         Write(labels_[static_cast<uint32_t>(displayudf::Labels::kHostname)], network::iface::HostName());
     }
 
-    void ShowDhcpStatus(network::dhcp::State state)
-    {
-        switch (state)
-        {
+    void ShowDhcpStatus(network::dhcp::State state) {
+        switch (state) {
             case network::dhcp::State::kOff:
                 break;
             case network::dhcp::State::kRenewing:
@@ -223,25 +208,17 @@ class DisplayUdf final : public Display
     static DisplayUdf* Get() { return s_this; }
 
    private:
-    /**
-     * Art-Net
-     */
-
+    // Art-Net
 #if defined(NODE_ARTNET)
     void ShowArtNetNode();
     void ShowDestinationIpArtNetNode();
 #endif
-
-    /**
-     * sACN E1.31
-     */
-
+    // sACN E1.31
 #if defined(NODE_E131)
     void ShowE131Bridge();
 #endif
 
-   private:
-    char title_[32];
+    char title_[displayudf::kTitleSize];
     uint8_t labels_[static_cast<uint32_t>(displayudf::Labels::kUnknown)];
 
     inline static DisplayUdf* s_this;

lib-displayudf/include/json/displayudfparams.h

@@ -35,11 +35,9 @@
 
 static_assert(common::ArraySize(json::DisplayUdfParamsConst::kLabels) == static_cast<size_t>(displayudf::Labels::kUnknown), "Mismatch between enum and kArray");
 
-namespace json
-{
-class DisplayUdfParams : public JsonParamsBase<DisplayUdfParams>
-{
-	public:
+namespace json {
+class DisplayUdfParams : public JsonParamsBase<DisplayUdfParams> {
+   public:
 
     DisplayUdfParams();
 

lib-displayudf/src/displayudf.cpp

@@ -47,17 +47,17 @@ void DisplayUdf::SetTitle(const char* format, ...) {
     va_list arp;
     va_start(arp, format);
 
-    const auto kI = vsnprintf(title_, sizeof(title_) / sizeof(title_[0]) - 1, format, arp);
+    const auto kIndex = vsnprintf(title_, sizeof(title_) / sizeof(title_[0]), format, arp);
 
     va_end(arp);
 
-    title_[kI] = '\0';
+    title_[kIndex] = '\0';
 
     DEBUG_PUTS(title_);
 }
 
 void DisplayUdf::Set(uint32_t line, displayudf::Labels label) {
-    if (!((line > 0) && (line <= displayudf::kLabelMaxRows))) {
+    if ((line == 0) || (line > displayudf::kLabelMaxRows)) {
         return;
     }
 

lib-displayudf/src/json/displayudfparams.cpp

@@ -74,7 +74,7 @@ void DisplayUdfParams::SetLabel(const char* key, uint32_t key_len, const char* v
         return;
     }
 
-    DEBUG_PRINTF("%.*s ->%.*s", key_len, key, val_len, val);
+    DEBUG_PRINTF("%.*s ->%.*s", static_cast<int>(key_len), key, static_cast<int>(val_len), val);
 
     const uint32_t kHash = Fnv1a32Runtime(key, key_len);
     bool matched = false;
@@ -132,12 +132,12 @@ void DisplayUdfParams::SetAndShow() {
 
 void DisplayUdfParams::Dump() {
     printf("%s::%s \'%s\':\n", __FILE__, __FUNCTION__, json::DisplayUdfParamsConst::kFileName);
-    printf(" %s=%u\n", DisplayUdfParamsConst::kIntensity.name, store_displayudf.intensity);
-    printf(" %s=%u\n", DisplayUdfParamsConst::kSleepTimeout.name, store_displayudf.sleep_timeout);
-    printf(" %s=%u\n", DisplayUdfParamsConst::kFlipVertically.name, common::IsFlagSet(store_displayudf.flags, Flags::Flag::kFlipVertically));
+    printf(" %s=%u\n", DisplayUdfParamsConst::kIntensity.name, static_cast<unsigned>(store_displayudf.intensity));
+    printf(" %s=%u\n", DisplayUdfParamsConst::kSleepTimeout.name, static_cast<unsigned>(store_displayudf.sleep_timeout));
+    printf(" %s=%u\n", DisplayUdfParamsConst::kFlipVertically.name, static_cast<unsigned>(common::IsFlagSet(store_displayudf.flags, Flags::Flag::kFlipVertically)));
 
     for (uint32_t i = 0; i < common::ArraySize(DisplayUdfParamsConst::kLabels); ++i) {
-        printf(" %s=%u\n", DisplayUdfParamsConst::kLabels[i].name, store_displayudf.label_index[i]);
+        printf(" %s=%u\n", DisplayUdfParamsConst::kLabels[i].name, static_cast<unsigned>(store_displayudf.label_index[i]));
     }
 }
 } // namespace json