Fix includes in BLE lib with IWYU and force others to include this

library via the umbrella header <ble/Ble.h>.

Author: arkq

src/ble/BLEEndPoint.cpp

@@ -25,20 +25,29 @@
  *
  */
 
-#include <stdint.h>
-#include <string.h>
+#define _CHIP_BLE_BLE_H
+#include "BLEEndPoint.h"
 
-#include <ble/BleConfig.h>
+#include <cstdint>
+#include <cstring>
+#include <utility>
 
-#include <lib/core/CHIPConfig.h>
 #include <lib/support/BitFlags.h>
-#include <lib/support/CHIPFaultInjection.h>
 #include <lib/support/CodeUtils.h>
 #include <lib/support/logging/CHIPLogging.h>
-
-#include <ble/BLEEndPoint.h>
-#include <ble/BleLayer.h>
-#include <ble/BtpEngine.h>
+#include <system/SystemClock.h>
+#include <system/SystemLayer.h>
+#include <system/SystemPacketBuffer.h>
+
+#include "BleApplicationDelegate.h"
+#include "BleConfig.h"
+#include "BleError.h"
+#include "BleLayer.h"
+#include "BleLayerDelegate.h"
+#include "BlePlatformDelegate.h"
+#include "BleRole.h"
+#include "BleUUID.h"
+#include "BtpEngine.h"
 
 // Define below to enable extremely verbose, BLE end point-specific debug logging.
 #undef CHIP_BLE_END_POINT_DEBUG_LOGGING_ENABLED

src/ble/BLEEndPoint.h

@@ -27,10 +27,23 @@
 
 #pragma once
 
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
+
+#include <cstdint>
+
+#include <lib/core/CHIPError.h>
+#include <lib/support/BitFlags.h>
+#include <lib/support/DLLUtil.h>
 #include <system/SystemLayer.h>
+#include <system/SystemPacketBuffer.h>
 
-#include <ble/BleRole.h>
-#include <ble/BtpEngine.h>
+#include "BleConnectionDelegate.h"
+#include "BleLayerDelegate.h"
+#include "BlePlatformDelegate.h"
+#include "BleRole.h"
+#include "BtpEngine.h"
 
 namespace chip {
 namespace Ble {
@@ -46,8 +59,6 @@ enum
 // Forward declarations
 class BleLayer;
 class BleEndPointPool;
-// BLEEndPoint holds a pointer to BleLayerDelegate for messages, while BleLayerDelegate functions also accepts BLEEndPoint.
-class BleLayerDelegate;
 
 class DLL_EXPORT BLEEndPoint
 {

src/ble/Ble.h

@@ -28,14 +28,22 @@
 
 #include <ble/BleConfig.h>
 
+// Other includes check for the _CHIP_BLE_BLE_H define to ensure that the BLE
+// library is included correctly by others (via Ble.h umbrella header).
+#define _CHIP_BLE_BLE_H
+
 #include <ble/BLEEndPoint.h>
 #include <ble/BleApplicationDelegate.h>
 #include <ble/BleConnectionDelegate.h>
 #include <ble/BleError.h>
 #include <ble/BleLayer.h>
+#include <ble/BleLayerDelegate.h>
 #include <ble/BlePlatformDelegate.h>
 #include <ble/BleUUID.h>
 #include <ble/BtpEngine.h>
+#include <ble/CHIPBleServiceData.h>
+
+#undef _CHIP_BLE_BLE_H
 
 /**
  *   @namespace Ble

src/ble/BleApplicationDelegate.h

@@ -24,10 +24,14 @@
 
 #pragma once
 
-#include <ble/BleConfig.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
 
 #include <lib/support/DLLUtil.h>
 
+#include "BleConfig.h"
+
 namespace chip {
 namespace Ble {
 

src/ble/BleConnectionDelegate.h

@@ -23,12 +23,16 @@
 
 #pragma once
 
-#include <ble/BleConfig.h>
-#include <ble/BleError.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
 
 #include <lib/support/DLLUtil.h>
 #include <lib/support/SetupDiscriminator.h>
 
+#include "BleConfig.h"
+#include "BleError.h"
+
 namespace chip {
 namespace Ble {
 class BleLayer;

src/ble/BleError.cpp

@@ -21,11 +21,10 @@
  *      This file contains functions for working with BLE Layer errors.
  */
 
-#include <stddef.h>
+#define _CHIP_BLE_BLE_H
+#include "BleError.h"
 
-#include <ble/BleConfig.h>
-#include <ble/BleError.h>
-#include <ble/BleLayer.h>
+#include <lib/core/ErrorStr.h>
 
 namespace chip {
 namespace Ble {

src/ble/BleError.h

@@ -30,7 +30,11 @@
 
 #pragma once
 
-#include "BleConfig.h"
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
+
+#include <cstdint>
 
 #include <lib/core/CHIPError.h>
 

src/ble/BleLayer.cpp

@@ -50,19 +50,28 @@
  *      drive BLE data and control input up the stack.
  */
 
-#include <ble/BleConfig.h>
+#define _CHIP_BLE_BLE_H
+#include "BleLayer.h"
 
-#include <string.h>
-
-#include <ble/BLEEndPoint.h>
-#include <ble/BleApplicationDelegate.h>
-#include <ble/BleLayer.h>
-#include <ble/BlePlatformDelegate.h>
-#include <ble/BleUUID.h>
+#include <cstring>
+#include <utility>
 
 #include <lib/core/CHIPEncoding.h>
 #include <lib/support/CodeUtils.h>
+#include <lib/support/SetupDiscriminator.h>
 #include <lib/support/logging/CHIPLogging.h>
+#include <system/SystemLayer.h>
+#include <system/SystemPacketBuffer.h>
+
+#include "BLEEndPoint.h"
+#include "BleApplicationDelegate.h"
+#include "BleConfig.h"
+#include "BleConnectionDelegate.h"
+#include "BleError.h"
+#include "BleLayerDelegate.h"
+#include "BlePlatformDelegate.h"
+#include "BleRole.h"
+#include "BleUUID.h"
 
 // Magic values expected in first 2 bytes of valid BLE transport capabilities request or response:
 #define CAPABILITIES_MSG_CHECK_BYTE_1 0b01100101

src/ble/BleLayer.h

@@ -47,21 +47,26 @@
 
 #pragma once
 
-#include <stdint.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
 
-#include <ble/BleConfig.h>
+#include <cstddef>
+#include <cstdint>
 
+#include <lib/core/CHIPError.h>
+#include <lib/support/DLLUtil.h>
 #include <lib/support/SetupDiscriminator.h>
 #include <system/SystemLayer.h>
 #include <system/SystemPacketBuffer.h>
 
-#include <ble/BleApplicationDelegate.h>
-#include <ble/BleConnectionDelegate.h>
-#include <ble/BleError.h>
-#include <ble/BleLayerDelegate.h>
-#include <ble/BlePlatformDelegate.h>
-#include <ble/BleRole.h>
-#include <ble/BleUUID.h>
+#include "BleApplicationDelegate.h"
+#include "BleConfig.h"
+#include "BleConnectionDelegate.h"
+#include "BleLayerDelegate.h"
+#include "BlePlatformDelegate.h"
+#include "BleRole.h"
+#include "BleUUID.h"
 
 namespace chip {
 namespace Ble {
@@ -78,10 +83,6 @@ namespace Ble {
 #define CHIP_BLE_TRANSPORT_PROTOCOL_MIN_SUPPORTED_VERSION kBleTransportProtocolVersion_V4
 #define CHIP_BLE_TRANSPORT_PROTOCOL_MAX_SUPPORTED_VERSION kBleTransportProtocolVersion_V4
 
-/// Forward declarations.
-class BleLayer;
-class BLEEndPoint;
-
 /// Enum defining versions of CHIP over BLE transport protocol.
 typedef enum
 {
@@ -344,5 +345,3 @@ class DLL_EXPORT BleLayer
 
 } /* namespace Ble */
 } /* namespace chip */
-
-#include "BLEEndPoint.h"

src/ble/BleLayerDelegate.h

@@ -23,15 +23,23 @@
 
 #pragma once
 
-#include <ble/BLEEndPoint.h>
-#include <ble/BleConfig.h>
-#include <ble/BleError.h>
-#include <ble/BleUUID.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
+
 #include <system/SystemPacketBuffer.h>
 
+#include "BleConfig.h"
+#include "BleError.h"
+#include "BleUUID.h"
+
 namespace chip {
 namespace Ble {
 
+// BLEEndPoint holds a pointer to BleLayerDelegate for messages,
+// while BleLayerDelegate functions also accepts BLEEndPoint.
+class BLEEndPoint;
+
 class BleLayerDelegate
 {
 public:

src/ble/BlePlatformDelegate.h

@@ -24,13 +24,16 @@
 
 #pragma once
 
-#include <ble/BleConfig.h>
-
-#include <ble/BleUUID.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
 
 #include <lib/support/DLLUtil.h>
 #include <system/SystemPacketBuffer.h>
 
+#include "BleConfig.h"
+#include "BleUUID.h"
+
 namespace chip {
 namespace Ble {
 

src/ble/BleRole.h

@@ -18,6 +18,10 @@
 
 #pragma once
 
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
+
 namespace chip {
 namespace Ble {
 

src/ble/BleUUID.cpp

@@ -15,14 +15,14 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-#include <ble/BleConfig.h>
+
+#define _CHIP_BLE_BLE_H
+#include "BleUUID.h"
 
 #include <cctype>
 #include <cstdint>
 #include <cstring>
 
-#include "BleUUID.h"
-
 namespace chip {
 namespace Ble {
 

src/ble/BleUUID.h

@@ -15,9 +15,14 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
+
 #pragma once
 
-#include <stdint.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
+
+#include <cstdint>
 
 namespace chip {
 namespace Ble {

src/ble/BtpEngine.cpp

@@ -25,13 +25,19 @@
  *
  */
 
-#include <ble/BleConfig.h>
+#define _CHIP_BLE_BLE_H
+#include "BtpEngine.h"
 
-#include <ble/BtpEngine.h>
+#include <utility>
 
+#include <lib/core/CHIPConfig.h>
+#include <lib/support/BitFlags.h>
 #include <lib/support/BufferReader.h>
 #include <lib/support/CodeUtils.h>
 #include <lib/support/logging/CHIPLogging.h>
+#include <system/SystemPacketBuffer.h>
+
+#include "BleError.h"
 
 // Define below to enable extremely verbose BLE-specific debug logging.
 #undef CHIP_BTP_PROTOCOL_ENGINE_DEBUG_LOGGING_ENABLED

src/ble/BtpEngine.h

@@ -27,13 +27,14 @@
 
 #pragma once
 
-#include <stdint.h>
-#include <string.h>
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
 
-#include <ble/BleConfig.h>
+#include <cstdint>
+#include <cstring>
 
-#include <ble/BleError.h>
-#include <lib/support/BitFlags.h>
+#include <lib/core/CHIPError.h>
 #include <system/SystemPacketBuffer.h>
 
 namespace chip {

src/ble/CHIPBleServiceData.h

@@ -23,6 +23,12 @@
 
 #pragma once
 
+#ifndef _CHIP_BLE_BLE_H
+#error "Please include <ble/Ble.h> instead!"
+#endif
+
+#include <cstdint>
+
 #include <lib/core/CHIPEncoding.h>
 
 namespace chip {