Add IWYU pragmas where necessary to keep or exclude selected headers

Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>

plugins/Kaleidoscope-Devel-ArduinoTrace/src/ArduinoTrace.h

@@ -20,6 +20,8 @@
 #include <Arduino.h>  // for PROGMEM, F
 #include <stddef.h>   // for size_t
 
+// IWYU pragma: no_include "WString.h"
+
 #ifndef ARDUINOTRACE_ENABLE
 #define ARDUINOTRACE_ENABLE 1
 #endif

plugins/Kaleidoscope-FocusSerial/src/kaleidoscope/plugin/FocusSerial.h

@@ -27,6 +27,8 @@
 #include "kaleidoscope/key_defs.h"              // for Key
 #include "kaleidoscope/plugin.h"                // for Plugin
 
+// IWYU pragma: no_include "WString.h"
+
 namespace kaleidoscope {
 namespace plugin {
 class FocusSerial : public kaleidoscope::Plugin {

plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.cpp

@@ -32,9 +32,10 @@
 
 // Kaleidoscope headers
 #include "kaleidoscope/driver/keyscanner/Base_Impl.h"  // IWYU pragma: keep
+// IWYU pragma: no_include "kaleidoscope/device/device.h"
 
 // Kaleidoscope-Hardware-Keyboardio-Model01 headers
-#include "kaleidoscope/driver/keyboardio/Model01Side.h"
+#include "kaleidoscope/driver/keyboardio/Model01Side.h"  // IWYU pragma: keep
 
 namespace kaleidoscope {
 namespace device {

plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.h

@@ -27,8 +27,10 @@
 #include <Arduino.h>  // for PROGMEM
 
 // Kaleidoscope headers
-#include "kaleidoscope/MatrixAddr.h"     // for MatrixAddr
 #include "kaleidoscope/macro_helpers.h"  // for RESTRICT_AR...
+#include "kaleidoscope/MatrixAddr.h"     // IWYU pragma: keep
+
+// IWYU pragma: no_include "kaleidoscope/KeyAddr.h"
 
 #define CRGB(r, g, b) \
   (cRGB) { b, g, r }

plugins/Kaleidoscope-Hardware-Model01/src/Kaleidoscope-Hardware-Model01.h

@@ -17,4 +17,4 @@
 
 #pragma once
 
-#include "Kaleidoscope-Hardware-Keyboardio-Model01.h"
+#include "Kaleidoscope-Hardware-Keyboardio-Model01.h"  // IWYU pragma: keep

plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h

@@ -28,6 +28,8 @@
 #include "kaleidoscope/key_defs.h"              // for Key, Key_LeftControl
 #include "kaleidoscope/plugin.h"                // for Plugin
 
+// IWYU pragma: no_include "HIDAliases.h"
+
 // ----------------------------------------------------------------------------
 // Keymap macros
 

plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h

@@ -30,6 +30,8 @@
 #include "kaleidoscope/key_defs.h"              // for Key, Key_Transparent
 #include "kaleidoscope/plugin.h"                // for Plugin
 
+// IWYU pragma: no_include "HIDAliases.h"
+
 // DualUse Key definitions for Qukeys in the keymap
 #define MT(mod, key)   kaleidoscope::plugin::ModTapKey(Key_##mod, Key_##key)
 

src/kaleidoscope/driver/hid/keyboardio/AbsoluteMouse.h

@@ -26,6 +26,8 @@
 // From Kaleidoscope:
 #include "kaleidoscope/driver/hid/base/AbsoluteMouse.h"  // for AbsoluteMouse
 
+// IWYU pragma: no_include "DeviceAPIs/AbsoluteMouseAPI.hpp"
+
 namespace kaleidoscope {
 namespace driver {
 namespace hid {

src/kaleidoscope/driver/keyscanner/Base.h

@@ -19,9 +19,11 @@
 
 #include <stdint.h>  // for uint8_t
 
-#include "kaleidoscope/MatrixAddr.h"  // for MatrixAddr
+#include "kaleidoscope/MatrixAddr.h"  // IWYU pragma: keep
 #include "kaleidoscope/key_defs.h"    // for Key
 
+// IWYU pragma: no_include "kaleidoscope/KeyAddr.h"
+
 namespace kaleidoscope {
 namespace driver {
 namespace keyscanner {

src/kaleidoscope/hooks.h

@@ -24,8 +24,8 @@
 
 namespace kaleidoscope {
 // Forward declarations to enable friend declarations.
-class Layer_;
+class Layer_;    // IWYU pragma: keep
-class Runtime_;
+class Runtime_;  // IWYU pragma: keep
 
 namespace plugin {
 // Forward declarations to enable friend declarations.

src/kaleidoscope_internal/LEDModeManager.h

@@ -19,7 +19,6 @@
 #include <Arduino.h>  // for PROGMEM
 #include <stddef.h>   // for size_t
 #include <stdint.h>   // for uint8_t
-// IWYU pragma: no_include <new>
 
 #include "kaleidoscope/macro_helpers.h"                    // for __NL__
 #include "kaleidoscope/plugin.h"                           // for Plugin
@@ -29,7 +28,7 @@
 #include "kaleidoscope_internal/type_traits/has_method.h"  // for DEFINE_HAS...
 
 #if defined(KALEIDOSCOPE_VIRTUAL_BUILD) || defined(ARDUINO_ARCH_STM32)
-#include <new>
+#include <new>  // for operator new
 #else
 
 // To enable placement new, we need to supply a global operator
@@ -44,8 +43,8 @@ namespace kaleidoscope {
 
 namespace plugin {
 // Forward declarations to avoid header inclusions
-class LEDControl;
+class LEDControl;        // IWYU pragma: keep
-class LEDModeInterface;
+class LEDModeInterface;  // IWYU pragma: keep
 
 }  // namespace plugin
 

src/kaleidoscope_internal/deprecations.h

@@ -18,7 +18,7 @@
 
 #pragma once
 
-#include "kaleidoscope/macro_helpers.h"
+#include "kaleidoscope/macro_helpers.h"  // IWYU pragma: keep
 
 #define DEPRECATED(tag)                                                 \
   __attribute__((deprecated(_DEPRECATE(_DEPRECATED_MESSAGE_ ## tag))))

src/kaleidoscope_internal/event_dispatch.h

@@ -37,9 +37,10 @@
 
 #include "kaleidoscope/event_handlers.h"
 #include "kaleidoscope/macro_helpers.h"
-#include "kaleidoscope/plugin.h"
+#include "kaleidoscope/plugin.h"  // IWYU pragma: keep
 #include "kaleidoscope_internal/eventhandler_signature_check.h"
-#include "kaleidoscope_internal/sketch_exploration/sketch_exploration.h"
+#include "kaleidoscope_internal/sketch_exploration/plugin_exploration.h"
+#include "kaleidoscope_internal/sketch_exploration/sketch_exploration.h"  // IWYU pragma: keep
 
 // Some words about the design of hook routing:
 //