From 418fdcad7e3a985da7fffef1146ebdacf233eb4f Mon Sep 17 00:00:00 2001 From: Michael Richters Date: Tue, 5 Apr 2022 13:42:28 -0500 Subject: [PATCH] Add IWYU pragmas where necessary to keep or exclude selected headers Signed-off-by: Michael Richters --- plugins/Kaleidoscope-Devel-ArduinoTrace/src/ArduinoTrace.h | 2 ++ .../src/kaleidoscope/plugin/FocusSerial.h | 2 ++ .../src/kaleidoscope/device/keyboardio/Model01.cpp | 3 ++- .../src/kaleidoscope/device/keyboardio/Model01.h | 4 +++- .../src/Kaleidoscope-Hardware-Model01.h | 2 +- .../Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h | 2 ++ .../Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h | 2 ++ src/kaleidoscope/driver/hid/keyboardio/AbsoluteMouse.h | 2 ++ src/kaleidoscope/driver/keyscanner/Base.h | 4 +++- src/kaleidoscope/hooks.h | 4 ++-- src/kaleidoscope_internal/LEDModeManager.h | 7 +++---- src/kaleidoscope_internal/deprecations.h | 2 +- src/kaleidoscope_internal/event_dispatch.h | 5 +++-- 13 files changed, 28 insertions(+), 13 deletions(-) diff --git a/plugins/Kaleidoscope-Devel-ArduinoTrace/src/ArduinoTrace.h b/plugins/Kaleidoscope-Devel-ArduinoTrace/src/ArduinoTrace.h index 00edd99c..538ed234 100644 --- a/plugins/Kaleidoscope-Devel-ArduinoTrace/src/ArduinoTrace.h +++ b/plugins/Kaleidoscope-Devel-ArduinoTrace/src/ArduinoTrace.h @@ -20,6 +20,8 @@ #include // for PROGMEM, F #include // for size_t +// IWYU pragma: no_include "WString.h" + #ifndef ARDUINOTRACE_ENABLE #define ARDUINOTRACE_ENABLE 1 #endif diff --git a/plugins/Kaleidoscope-FocusSerial/src/kaleidoscope/plugin/FocusSerial.h b/plugins/Kaleidoscope-FocusSerial/src/kaleidoscope/plugin/FocusSerial.h index 48db60b1..6850eb78 100644 --- a/plugins/Kaleidoscope-FocusSerial/src/kaleidoscope/plugin/FocusSerial.h +++ b/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 { diff --git a/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.cpp b/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.cpp index bb5d5c5b..64cb7f17 100644 --- a/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.cpp +++ b/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 { diff --git a/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.h b/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.h index cbd6d6a8..dc04b775 100644 --- a/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.h +++ b/plugins/Kaleidoscope-Hardware-Keyboardio-Model01/src/kaleidoscope/device/keyboardio/Model01.h @@ -27,8 +27,10 @@ #include // 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 } diff --git a/plugins/Kaleidoscope-Hardware-Model01/src/Kaleidoscope-Hardware-Model01.h b/plugins/Kaleidoscope-Hardware-Model01/src/Kaleidoscope-Hardware-Model01.h index 6b4a1c37..e88cbcbe 100644 --- a/plugins/Kaleidoscope-Hardware-Model01/src/Kaleidoscope-Hardware-Model01.h +++ b/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 diff --git a/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h b/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h index 9cdeca5d..730c1300 100644 --- a/plugins/Kaleidoscope-OneShot/src/kaleidoscope/plugin/OneShot.h +++ b/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 diff --git a/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h b/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h index e4d674f7..41c8792e 100644 --- a/plugins/Kaleidoscope-Qukeys/src/kaleidoscope/plugin/Qukeys.h +++ b/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) diff --git a/src/kaleidoscope/driver/hid/keyboardio/AbsoluteMouse.h b/src/kaleidoscope/driver/hid/keyboardio/AbsoluteMouse.h index 257e7b2d..dfbad768 100644 --- a/src/kaleidoscope/driver/hid/keyboardio/AbsoluteMouse.h +++ b/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 { diff --git a/src/kaleidoscope/driver/keyscanner/Base.h b/src/kaleidoscope/driver/keyscanner/Base.h index 58953c8e..1d2a757e 100644 --- a/src/kaleidoscope/driver/keyscanner/Base.h +++ b/src/kaleidoscope/driver/keyscanner/Base.h @@ -19,9 +19,11 @@ #include // 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 { diff --git a/src/kaleidoscope/hooks.h b/src/kaleidoscope/hooks.h index a0f3c49d..5df8ee53 100644 --- a/src/kaleidoscope/hooks.h +++ b/src/kaleidoscope/hooks.h @@ -24,8 +24,8 @@ namespace kaleidoscope { // Forward declarations to enable friend declarations. -class Layer_; -class Runtime_; +class Layer_; // IWYU pragma: keep +class Runtime_; // IWYU pragma: keep namespace plugin { // Forward declarations to enable friend declarations. diff --git a/src/kaleidoscope_internal/LEDModeManager.h b/src/kaleidoscope_internal/LEDModeManager.h index 245f5638..e4806db1 100644 --- a/src/kaleidoscope_internal/LEDModeManager.h +++ b/src/kaleidoscope_internal/LEDModeManager.h @@ -19,7 +19,6 @@ #include // for PROGMEM #include // for size_t #include // for uint8_t -// IWYU pragma: no_include #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 +#include // 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 LEDModeInterface; +class LEDControl; // IWYU pragma: keep +class LEDModeInterface; // IWYU pragma: keep } // namespace plugin diff --git a/src/kaleidoscope_internal/deprecations.h b/src/kaleidoscope_internal/deprecations.h index ff38a46a..95cb4d26 100644 --- a/src/kaleidoscope_internal/deprecations.h +++ b/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)))) diff --git a/src/kaleidoscope_internal/event_dispatch.h b/src/kaleidoscope_internal/event_dispatch.h index c2594283..0ed3f078 100644 --- a/src/kaleidoscope_internal/event_dispatch.h +++ b/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: //