Merge pull request #13475 from pan-/ble-remove-user-facing-abstraction

Ble remove user facing abstraction

Author: 0xc0170

connectivity/FEATURE_BLE/include/ble/BLE.h

@@ -19,20 +19,20 @@
 #ifndef MBED_BLE_H__
 #define MBED_BLE_H__
 
-#include "FunctionPointerWithContext.h"
 #include "platform/mbed_error.h"
 #include "platform/mbed_assert.h"
 #include "platform/mbed_toolchain.h"
 
-#include "ble/common/ble/BLERoles.h"
-#include "ble/common/ble/BLETypes.h"
-#include "ble/common/ble/blecommon.h"
-
 #include "ble/Gap.h"
 #include "ble/GattClient.h"
 #include "ble/GattServer.h"
 #include "ble/SecurityManager.h"
 
+#include "ble/common/BLERoles.h"
+#include "ble/common/BLETypes.h"
+#include "ble/common/blecommon.h"
+#include "ble/common/FunctionPointerWithContext.h"
+
 /* Forward declaration for the implementation class */
 
 namespace ble {
@@ -154,6 +154,10 @@ class BLE {
      */
     static const InstanceID_t NUM_INSTANCES = 1;
 
+    // Prevent copy construction and copy assignment of BLE.
+    BLE(const BLE &) = delete;
+    BLE &operator=(const BLE &) = delete;
+
     /**
      * Get a reference to the BLE singleton.
      *
@@ -164,16 +168,6 @@ class BLE {
      */
     static BLE &Instance();
 
-    /**
-     * Constructor for a handle to a BLE instance (the BLE stack). BLE handles
-     * are thin wrappers around a transport object (that is, ptr. to
-     * ble::BLEInstanceBase).
-     *
-     * @param[in] transport Ble transport used for the BLE instance.
-     * @note Cordio supports only one instance.
-     */
-    BLE(ble::BLEInstanceBase &transport);
-
     /**
      * Get a reference to the BLE singleton corresponding to a given interface.
      *
@@ -203,7 +197,7 @@ class BLE {
      */
     MBED_DEPRECATED_SINCE("mbed-os-6.3.0", "BLE singleton supports one instance. You may create multiple"
                           "instances by using the constructor.")
-    InstanceID_t getInstanceID(void) const
+    InstanceID_t getInstanceID() const
     {
         return DEFAULT_INSTANCE;
     }
@@ -309,7 +303,7 @@ class BLE {
      * @attention This should be called before using anything else in the BLE
      * API.
      */
-    ble_error_t init(InitializationCompleteCallback_t completion_cb = NULL)
+    ble_error_t init(InitializationCompleteCallback_t completion_cb = nullptr)
     {
         FunctionPointerWithContext<InitializationCompleteCallbackContext *> callback(completion_cb);
         return initImplementation(callback);
@@ -341,7 +335,7 @@ class BLE {
      * @note The application should set up a callback to signal completion of
      * initialization when using init().
      */
-    bool hasInitialized(void) const;
+    bool hasInitialized() const;
 
     /**
      * Shut down the underlying stack, and reset state of this BLE instance.
@@ -353,7 +347,7 @@ class BLE {
      * GAP state. This API offers a way to repopulate the GATT database with new
      * services and characteristics.
      */
-    ble_error_t shutdown(void);
+    ble_error_t shutdown();
 
     /**
      * This call allows the application to get the BLE stack version information.
@@ -362,7 +356,7 @@ class BLE {
      *
      * @note The BLE API owns the string returned.
      */
-    const char *getVersion(void);
+    const char *getVersion();
 
     /**
      * Accessor to Gap. All Gap-related functionality requires going through
@@ -455,6 +449,16 @@ class BLE {
 private:
     friend class ble::BLEInstanceBase;
 
+    /**
+     * Constructor for a handle to a BLE instance (the BLE stack). BLE handles
+     * are thin wrappers around a transport object (that is, ptr. to
+     * ble::BLEInstanceBase).
+     *
+     * @param[in] transport Ble transport used for the BLE instance.
+     * @note Cordio supports only one instance.
+     */
+    BLE(ble::BLEInstanceBase &transport);
+
     /**
      * Implementation of init() [internal to BLE_API].
      *
@@ -465,11 +469,6 @@ class BLE {
         FunctionPointerWithContext<InitializationCompleteCallbackContext *> callback
     );
 
-private:
-    // Prevent copy construction and copy assignment of BLE.
-    BLE(const BLE &);
-    BLE &operator=(const BLE &);
-
 private:
     ble::BLEInstanceBase &transport; /* The device-specific backend */
     OnEventsToProcessCallback_t whenEventsToProcess;
@@ -480,7 +479,7 @@ class BLE {
 
 using ble::BLE;
 /**
- * @namespace ble Entry namespace for all %BLE API definitions.
+ * @namespace ble Entry namespace for all BLE API definitions.
  */
 
 /**

connectivity/FEATURE_BLE/include/ble/Gap.h

@@ -19,28 +19,27 @@
 #ifndef BLE_GAP_GAP_H
 #define BLE_GAP_GAP_H
 
-#include "CallChainOfFunctionPointersWithContext.h"
-
-#include <algorithm>
-
-#include "drivers/LowPowerTimeout.h"
-#include "drivers/LowPowerTicker.h"
-#include "platform/mbed_error.h"
-
-#include "ble/common/ble/BLERoles.h"
-#include "ble/common/ble/BLETypes.h"
-#include "ble/common/ble/gap/AdvertisingDataBuilder.h"
-#include "ble/common/ble/gap/AdvertisingDataParser.h"
-#include "ble/common/ble/gap/AdvertisingDataSimpleBuilder.h"
-#include "ble/common/ble/gap/AdvertisingDataTypes.h"
-#include "ble/common/ble/gap/AdvertisingParameters.h"
-#include "ble/common/ble/gap/ConnectionParameters.h"
-#include "ble/common/ble/gap/Events.h"
-#include "ble/common/ble/gap/ScanParameters.h"
-#include "ble/common/ble/gap/Types.h"
+#include "ble/common/CallChainOfFunctionPointersWithContext.h"
+
+#include "ble/common/BLERoles.h"
+#include "ble/common/BLETypes.h"
+#include "ble/gap/AdvertisingDataBuilder.h"
+#include "ble/gap/AdvertisingDataParser.h"
+#include "ble/gap/AdvertisingDataSimpleBuilder.h"
+#include "ble/gap/AdvertisingDataTypes.h"
+#include "ble/gap/AdvertisingParameters.h"
+#include "ble/gap/ConnectionParameters.h"
+#include "ble/gap/ScanParameters.h"
+#include "ble/gap/Events.h"
+#include "ble/gap/Types.h"
 
 namespace ble {
-class PalGenericAccessService;
+
+#if !defined(DOXYGEN_ONLY)
+namespace impl {
+class Gap;
+}
+#endif // !defined(DOXYGEN_ONLY)
 
 /**
  * @addtogroup ble
@@ -280,9 +279,6 @@ class PalGenericAccessService;
  * PHY and of any changes to PHYs which may be triggered autonomously by the
  * controller or by the peer.
  */
-#if !defined(DOXYGEN_ONLY)
-namespace interface {
-#endif // !defined(DOXYGEN_ONLY)
 class Gap {
 public:
     /**
@@ -547,9 +543,7 @@ class Gap {
          * Prevent polymorphic deletion and avoid unnecessary virtual destructor
          * as the Gap class will never delete the instance it contains.
          */
-        ~EventHandler()
-        {
-        }
+        ~EventHandler() = default;
     };
 
     /**
@@ -1314,7 +1308,7 @@ class Gap {
      *
      * @return Maximum size of the whitelist.
      */
-    uint8_t getMaxWhitelistSize(void) const;
+    uint8_t getMaxWhitelistSize() const;
 
     /**
      * Get the Link Layer to use the internal whitelist when scanning,
@@ -1377,7 +1371,7 @@ class Gap {
      * the address in input was not identifiable as a random address.
      */
     static ble_error_t getRandomAddressType(
-        const ble::address_t address,
+        ble::address_t address,
         ble::random_address_type_t *addressType
     );
 
@@ -1399,7 +1393,7 @@ class Gap {
      * @note Currently, a call to reset() does not reset the advertising and
      * scan parameters to default values.
      */
-    ble_error_t reset(void);
+    ble_error_t reset();
 
         /**
      * Register a Gap shutdown event handler.
@@ -1421,7 +1415,9 @@ class Gap {
      * @param[in] memberPtr Shutdown event handler to register.
      */
     template<typename T>
-    void onShutdown(T *objPtr, void (T::*memberPtr)(const Gap *));
+    void onShutdown(T *objPtr, void (T::*memberPtr)(const Gap *)) {
+        onShutdown(GapShutdownCallback_t(objPtr, memberPtr));
+    }
 
     /**
      * Access the callchain of shutdown event handler.
@@ -1435,29 +1431,36 @@ class Gap {
     GapShutdownCallbackChain_t &onShutdown();
 
 #if !defined(DOXYGEN_ONLY)
+    /*
+     * Constructor from the private implementation.
+     */
+    Gap(impl::Gap* impl) : impl(impl) {}
+
+    /*
+     * Restrict copy and move.
+     */
+    Gap(const Gap&) = delete;
+    Gap& operator=(const Gap&) = delete;
+
     /*
      * API reserved for the controller driver to set the random static address.
      * Setting a new random static address while the controller is operating is
      * forbidden by the Bluetooth specification.
      */
     ble_error_t setRandomStaticAddress(const ble::address_t& address);
 #endif // !defined(DOXYGEN_ONLY)
+
+private:
+    impl::Gap* impl;
 };
 
 /**
  * @}
  * @}
  */
 
-#if !defined(DOXYGEN_ONLY)
-} // namespace interface
-#endif // !defined(DOXYGEN_ONLY)
 } // namespace ble
 
-/* This includes the concrete class implementation, to provide a an alternative API implementation
- * disable ble-api-implementation and place your header in a path with the same structure */
-#include "ble/internal/GapImpl.h"
-
 /** @deprecated Use the namespaced ble::Gap instead of the global Gap. */
 using ble::Gap;