Refactor include guards and move debug utilities to headers

Standardized include guards across multiple header files, replacing #pragma once and correcting placement. Moved debug_dump and debug_print_bits implementations from .cpp files to new header files in common/include/firmware/debug/. Updated references to these debug utilities and to pixeldmx/show.h to match new include paths. Changed file permissions for consistency and performed minor code cleanups.

Author: vanvught

common/include/common/utils/utils_array.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_UTILS_UTILS_ARRAY_H_
-#define COMMON_UTILS_UTILS_ARRAY_H_
-
 /**
  * @file utils_array.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_UTILS_UTILS_ARRAY_H_
+#define COMMON_UTILS_UTILS_ARRAY_H_
+
 #include <cstddef>
 
 namespace common

common/include/common/utils/utils_enum.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_UTILS_UTILS_ENUM_H_
-#define COMMON_UTILS_UTILS_ENUM_H_
-
 /**
  * @file utils_enum.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_UTILS_UTILS_ENUM_H_
+#define COMMON_UTILS_UTILS_ENUM_H_
+
 #include <type_traits>
 
 namespace common

common/include/common/utils/utils_flags.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_UTILS_UTILS_FLAGS_H_
-#define COMMON_UTILS_UTILS_FLAGS_H_
-
 /**
  * @file utils_flags.h
  * Generic enum class bitmask helpers (C++20, freestanding-safe, Google Style)
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_UTILS_UTILS_FLAGS_H_
+#define COMMON_UTILS_UTILS_FLAGS_H_
+
 #include <cstdint>
 #include <type_traits>
 

common/include/common/utils/utils_hash.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_UTILS_UTILS_HASH_H_
-#define COMMON_UTILS_UTILS_HASH_H_
-
 /**
  * @file hash.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_UTILS_UTILS_HASH_H_
+#define COMMON_UTILS_UTILS_HASH_H_
+
 #include <cstdint>
 
 // Compile-time FNV-1a 32-bit hash

common/include/common/utils/utils_hex.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_UTILS_UTILS_HEX_H_
-#define COMMON_UTILS_UTILS_HEX_H_
-
 /**
  * @file utils_hex.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_UTILS_UTILS_HEX_H_
+#define COMMON_UTILS_UTILS_HEX_H_
+
 #include <cstdint>
 #include <cstddef>
 #include <cassert>

lib-hal/debug/debug_dump.cpp …mmon/include/firmware/debug/debug_dump.hlib-hal/debug/debug_dump.cpp renamed to common/include/firmware/debug/debug_dump.h lib-hal/debug/debug_dump.cpp renamed to common/include/firmware/debug/debug_dump.h

@@ -1,5 +1,5 @@
 /**
- * @file debug_dump.cpp
+ * @file debug_dump.h
  *
  */
 /* Copyright (C) 2018-2025 by Arjan van Vught mailto:info@gd32-dmx.org
@@ -23,21 +23,31 @@
  * THE SOFTWARE.
  */
 
-#include <cstdio>
+#ifndef COMMON_DEBUG_DEBUG_DUMP_H_
+#define COMMON_DEBUG_DEBUG_DUMP_H_
+
 #include <cstdint>
+#include <cstdio>
 #include <ctype.h>
 
 #if defined(H3)
 namespace uart0
 {
 int Printf(const char* fmt, ...);
 }
-#define printf uart0::Printf
+#define printf uart0::Printf // NOLINT
 #endif
 
-static constexpr uint32_t kCharsPerLine = 16;
-
-void debug_dump(const void* data, uint32_t size)
+namespace debug
+{
+namespace dump
+{
+inline constexpr uint32_t kCharsPerLine = 16;
+}
+#ifdef NDEBUG
+inline void Dump([[maybe_unused]] const void* data, [[maybe_unused]] uint32_t size) {}
+#else
+inline void Dump(const void* data, uint32_t size)
 {
     uint32_t chars = 0;
     const auto* p = reinterpret_cast<const uint8_t*>(data);
@@ -52,7 +62,7 @@ void debug_dump(const void* data, uint32_t size)
 
         const auto* q = p;
 
-        while ((chars_this_line < kCharsPerLine) && (chars < size))
+        while ((chars_this_line < dump::kCharsPerLine) && (chars < size))
         {
             if (chars_this_line % 8 == 0)
             {
@@ -68,7 +78,7 @@ void debug_dump(const void* data, uint32_t size)
 
         auto chars_dot_line = chars_this_line;
 
-        for (; chars_this_line < kCharsPerLine; chars_this_line++)
+        for (; chars_this_line < dump::kCharsPerLine; chars_this_line++)
         {
             if (chars_this_line % 8 == 0)
             {
@@ -104,3 +114,7 @@ void debug_dump(const void* data, uint32_t size)
 
     } while (chars < size);
 }
+#endif
+} // namespace debug
+
+#endif /* COMMON_DEBUG_DEBUG_DUMP_H_ */

lib-hal/debug/debug_print_bits.cpp …include/firmware/debug/debug_printbits.hlib-hal/debug/debug_print_bits.cpp renamed to common/include/firmware/debug/debug_printbits.h lib-hal/debug/debug_print_bits.cpp renamed to common/include/firmware/debug/debug_printbits.h

@@ -1,8 +1,8 @@
 /**
- * @file debug_print_bits.cpp
+ * @file debug_print_bits.h
  *
  */
-/* Copyright (C) 2018-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+ /* Copyright (C) 2025 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -23,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_DEBUG_DEBUG_PRINTBITS_H_
+#define COMMON_DEBUG_DEBUG_PRINTBITS_H_
+
 #include <cstdio>
 #include <cstdint>
 
@@ -31,16 +34,19 @@ namespace uart0
 {
 int Printf(const char* fmt, ...);
 }
-#define printf uart0::Printf
+#define printf uart0::Printf // NOLINT
 #endif
 
-void debug_print_bits(uint32_t u)
+namespace debug
+{
+#ifdef NDEBUG
+inline void PrintBits([[maybe_unused]] uint32_t u) {}
+#else
+inline void PrintBits(uint32_t u)
 {
-    uint32_t i;
-
     uint32_t b = 1U << 31;
 
-    for (i = 0; i < 32; i++)
+    for (uint32_t i = 0; i < 32; i++)
     {
         if ((b & u) == b)
         {
@@ -52,3 +58,7 @@ void debug_print_bits(uint32_t u)
 
     puts("");
 }
+#endif
+} // namespace debug
+
+#endif /* COMMON_DEBUG_DEBUG_PRINTBITS_H_ */

…e/common/firmware/jamstapl/handleroled.h …/include/firmware/jamstapl/handleroled.hcommon/include/common/firmware/jamstapl/handleroled.h renamed to common/include/firmware/jamstapl/handleroled.h common/include/common/firmware/jamstapl/handleroled.h renamed to common/include/firmware/jamstapl/handleroled.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_FIRMWARE_JAMSTAPL_HANDLEROLED_H_
-#define COMMON_FIRMWARE_JAMSTAPL_HANDLEROLED_H_
-
 /**
  * @file handleroled.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_FIRMWARE_JAMSTAPL_HANDLEROLED_H_
+#define COMMON_FIRMWARE_JAMSTAPL_HANDLEROLED_H_
+
 #include "jamstapl.h"
 #include "console.h"
 #include "display.h"

…/include/common/firmware/pixeldmx/show.h common/include/firmware/pixeldmx/show.hcommon/include/common/firmware/pixeldmx/show.h renamed to common/include/firmware/pixeldmx/show.h common/include/common/firmware/pixeldmx/show.h renamed to common/include/firmware/pixeldmx/show.h

@@ -1,6 +1,3 @@
-#ifndef COMMON_FIRMWARE_PIXELDMX_SHOW_H_
-#define COMMON_FIRMWARE_PIXELDMX_SHOW_H_
-
 /*
  * display.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef COMMON_FIRMWARE_PIXELDMX_SHOW_H_
+#define COMMON_FIRMWARE_PIXELDMX_SHOW_H_
+
 #include <cstdint>
 
 #include "pixeldmxconfiguration.h"
@@ -53,4 +53,4 @@ inline void Show(uint32_t line, pixelpatterns::Pattern pattern = pixelpatterns::
 }
 } // namespace common::firmware::pixeldmx
 
-#endif  // COMMON_FIRMWARE_PIXELDMX_SHOW_H_
+#endif // COMMON_FIRMWARE_PIXELDMX_SHOW_H_

common/include/json/json_format_helpers.h

@@ -1,6 +1,3 @@
-#ifndef JSON_JSON_FORMAT_HELPERS_H_
-#define JSON_JSON_FORMAT_HELPERS_H_
-
 /**
  * @file format_helpers.h
  *
@@ -26,6 +23,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef JSON_JSON_FORMAT_HELPERS_H_
+#define JSON_JSON_FORMAT_HELPERS_H_
+
 #include <cstdio>
 #include <cstdint>