Ensure header files and .cpp files use the codal namespace appropriat…

…ely. (#437) Also update the codal-core and codal-nrf52 dependencies as they include changes on the same topic. The classes declared in the Mbed compatibility header files have not been wrapped in the codal namespace, as programmes including the mbed.h header might not expect them to be inside that namespace. This header file is not included in any of the codal-microbit-v2 or dependencies, it's mostly used by MakeCode extensions that were accessing Mbed-specific libraries in micro:bit V1. Co-authored-by: Carlos Pereira Atencio <[email protected]>
lancaster-university · Jul 24, 2024 · 762629c · 762629c
1 parent 96faa85
commit 762629c
Show file tree

Hide file tree

Showing 56 changed files with 212 additions and 96 deletions.
diff --git a/inc/MicroBitBLEChar.h b/inc/MicroBitBLEChar.h
@@ -32,6 +32,8 @@ DEALINGS IN THE SOFTWARE.
 
 #include "MicroBitBLETypes.h"
 
+namespace codal
+{
 
 /**
   * Class definition for MicroBitBLEChar.
@@ -67,6 +69,7 @@ class MicroBitBLEChar
     uint16_t                cccd;
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_BLE_CHAR_H
diff --git a/inc/MicroBitBLEService.h b/inc/MicroBitBLEService.h
@@ -32,6 +32,9 @@ DEALINGS IN THE SOFTWARE.
 
 #include "MicroBitBLEChar.h"
 
+namespace codal
+{
+
 /**
   * Class definition for MicroBitBLEService.
   * Provides a base class for the BLE sevices.
@@ -141,6 +144,7 @@ class MicroBitBLEService
     static const uint8_t        bs_base_uuid[16];
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_BLE_SERVICE_H
diff --git a/inc/MicroBitBLEServices.h b/inc/MicroBitBLEServices.h
@@ -41,6 +41,8 @@ DEALINGS IN THE SOFTWARE.
 #define MICROBIT_BLE_SERVICES_OBSERVER_PRIO 2
 #endif
 
+namespace codal
+{
 
 /**
   * Class definition for MicroBitBLEServices.
@@ -74,6 +76,7 @@ class MicroBitBLEServices
     MicroBitBLEService   *bs_services[ MICROBIT_BLE_SERVICES_MAX];
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_BLE_SERVICES_H
diff --git a/inc/MicroBitDevice.h b/inc/MicroBitDevice.h
@@ -170,6 +170,4 @@ namespace codal
 
 extern codal::MicroBitDevice *microbit_device_instance;
 
-using namespace codal;
-
 #endif
diff --git a/inc/MicroBitFile.h b/inc/MicroBitFile.h
@@ -31,6 +31,9 @@ DEALINGS IN THE SOFTWARE.
 #define READ_AND_WRITE                  READ | WRITE
 #define CREATE                          MB_CREAT
 
+namespace codal
+{
+
 class MicroBitFile
 {
 
@@ -192,4 +195,6 @@ class MicroBitFile
     ~MicroBitFile();
 };
 
+} // namespace codal
+
 #endif
diff --git a/inc/MicroBitFileSystem.h b/inc/MicroBitFileSystem.h
@@ -61,6 +61,8 @@ DEALINGS IN THE SOFTWARE.
 #define MBFS_BLOCK_TYPE_DIRECTORY         2
 #define MBFS_BLOCK_TYPE_FILETABLE         3
 
+namespace codal
+{
 
 //
 // Every file in the file system has a file descriptor.
@@ -517,4 +519,6 @@ class MicroBitFileSystem
     int createDirectory(char const *name);
 };
 
+} // namespace codal
+
 #endif
diff --git a/inc/MicroBitFlash.h b/inc/MicroBitFlash.h
@@ -24,6 +24,9 @@ DEALINGS IN THE SOFTWARE.
 
 #include "nrf.h"
 
+namespace codal
+{
+
 class MicroBitFlash
 {
     private:
@@ -86,4 +89,6 @@ class MicroBitFlash
 
 };
 
+} // namespace codal
+
 #endif
diff --git a/inc/MicroBitMemoryMap.h b/inc/MicroBitMemoryMap.h
@@ -36,6 +36,9 @@ DEALINGS IN THE SOFTWARE.
 #define REGION_MAKECODE 2
 #define REGION_PYTHON   3 
 
+namespace codal
+{
+
 /**
  * Structure definition for the reserved, noinit memory segment placed at the end of memory.
  */
@@ -142,4 +145,6 @@ class MicroBitMemoryMap
     int processRecord(uint32_t *address);
 };
 
+} // namespace codal
+
 #endif
diff --git a/inc/MicroBitPowerManager.h b/inc/MicroBitPowerManager.h
@@ -164,6 +164,8 @@ typedef struct {
 #define CONFIG_MINIMUM_POWER_ON_TIME  500
 #endif
 
+namespace codal
+{
 
 /**
  * Class definition for MicroBitPowerManager.
@@ -479,4 +481,7 @@ class MicroBitPowerManager : public CodalComponent
          */
         int simpleDeepSleep( bool wakeOnTime, CODAL_TIMESTAMP wakeUpTime, bool wakeUpSources, NRF52Pin *wakeUpPin);
 };
+
+} // namespace codal
+
 #endif
diff --git a/inc/MicroBitUSBFlashManager.h b/inc/MicroBitUSBFlashManager.h
@@ -74,6 +74,9 @@ DEALINGS IN THE SOFTWARE.
 #define MICROBIT_USB_FLASH_WRITE_CMD                0x0B            // Perform a WRITE operation from applicaiton FLASH memory.
 #define MICROBIT_USB_FLASH_ERASE_CMD                0x0C            // Perform a ERASE operation from applicaiton FLASH memory.
 
+namespace codal
+{
+
 typedef struct
 {
     ManagedString       fileName;                                   // MUST be in 8.3 format
@@ -290,4 +293,7 @@ class MicroBitUSBFlashManager : public CodalComponent, public NVMController
         bool isValidChar(char c);
 
 };
+
+} // namespace codal
+
 #endif
diff --git a/inc/bluetooth/MicroBitAccelerometerService.h b/inc/bluetooth/MicroBitAccelerometerService.h
@@ -35,6 +35,8 @@ DEALINGS IN THE SOFTWARE.
 #include "MicroBitAccelerometer.h"
 #include "EventModel.h"
 
+namespace codal
+{
 
 /**
   * Class definition for a MicroBit BLE Accelerometer Service.
@@ -110,6 +112,7 @@ class MicroBitAccelerometerService : public MicroBitBLEService
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_ACCELEROMETER_SERVICE_H
diff --git a/inc/bluetooth/MicroBitBLEManager.h b/inc/bluetooth/MicroBitBLEManager.h
@@ -62,6 +62,9 @@ DEALINGS IN THE SOFTWARE.
 #define MICROBIT_MODE_PAIRING                   0
 #define MICROBIT_MODE_APPLICATION               1
 
+namespace codal
+{
+
 class MicroBitBLEManager;
 typedef MicroBitBLEManager BLEDevice;
 
@@ -322,6 +325,8 @@ class MicroBitBLEManager : public CodalComponent
     bool advertiseOnDisconnect = true;
 };
 
-#endif
+} // namespace codal
 
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+
+#endif // MICROBIT_BLE_MANAGER_H
diff --git a/inc/bluetooth/MicroBitBLETypes.h b/inc/bluetooth/MicroBitBLETypes.h
@@ -95,6 +95,9 @@ DEALINGS IN THE SOFTWARE.
 #include "ble.h"
 #include "ble_gatts.h"
 
+namespace codal
+{
+
 typedef uint32_t                     microbit_ble_ret_code_t;
 typedef uint16_t                     microbit_gaphandle_t;
 typedef uint16_t                     microbit_servicehandle_t;
@@ -142,6 +145,8 @@ extern microbit_ble_ret_code_t microbit_ble_on_error( microbit_ble_ret_code_t er
 #define MICROBIT_BLE_ECHK( err) (err)
 #endif
 
-#endif
+} // namespace codal
 
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+
+#endif // MICROBIT_BLE_TYPES_H
diff --git a/inc/bluetooth/MicroBitButtonService.h b/inc/bluetooth/MicroBitButtonService.h
@@ -34,6 +34,8 @@ DEALINGS IN THE SOFTWARE.
 #include "MicroBitBLEService.h"
 #include "EventModel.h"
 
+namespace codal
+{
 
 /**
   * Class definition for a MicroBit BLE Button Service.
@@ -102,6 +104,7 @@ class MicroBitButtonService : public MicroBitBLEService
     MicroBitBLEChar *characteristicPtr( int idx)  { return &chars[ idx]; };
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_BUTTON_SERVICE_H
diff --git a/inc/bluetooth/MicroBitEddystone.h b/inc/bluetooth/MicroBitEddystone.h
@@ -40,6 +40,9 @@ DEALINGS IN THE SOFTWARE.
 
 #include "MicroBitBLEManager.h"
 
+namespace codal
+{
+
 /**
   * Class definition for the MicroBitEddystone.
   *
@@ -109,5 +112,7 @@ class MicroBitEddystone
     static MicroBitEddystone *_instance;
 };
 
-#endif
-#endif
+} // namespace codal
+
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_EDDYSTONE_H
diff --git a/inc/bluetooth/MicroBitEventService.h b/inc/bluetooth/MicroBitEventService.h
@@ -35,6 +35,8 @@ DEALINGS IN THE SOFTWARE.
 #include "MicroBitEvent.h"
 #include "EventModel.h"
 
+namespace codal
+{
 
 struct EventServiceEvent
 {
@@ -121,6 +123,7 @@ class MicroBitEventService : public MicroBitBLEService, MicroBitComponent
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_EVENT_SERVICE_H
diff --git a/inc/bluetooth/MicroBitIOPinService.h b/inc/bluetooth/MicroBitIOPinService.h
@@ -38,6 +38,9 @@ DEALINGS IN THE SOFTWARE.
 #define MICROBIT_IO_PIN_SERVICE_DATA_SIZE      10
 #define MICROBIT_PWM_PIN_SERVICE_DATA_SIZE     2
 
+namespace codal
+{
+
 /**
   * Name value pair definition, as used to read and write pin values over BLE.
   */
@@ -172,5 +175,7 @@ class MicroBitIOPinService : public MicroBitBLEService, MicroBitComponent
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
-#endif
-#endif
+} // namespace codal
+
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_IO_PIN_SERVICE_H
diff --git a/inc/bluetooth/MicroBitLEDService.h b/inc/bluetooth/MicroBitLEDService.h
@@ -38,6 +38,8 @@ DEALINGS IN THE SOFTWARE.
 // the maximum string length that can be scrolled via the BLE service.
 #define MICROBIT_BLE_MAXIMUM_SCROLLTEXT         20
 
+namespace codal
+{
 
 /**
   * Class definition for the custom MicroBit LED Service.
@@ -98,6 +100,7 @@ class MicroBitLEDService : public MicroBitBLEService
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_LED_SERVICE_H
diff --git a/inc/bluetooth/MicroBitMagnetometerService.h b/inc/bluetooth/MicroBitMagnetometerService.h
@@ -40,6 +40,8 @@ DEALINGS IN THE SOFTWARE.
 #define COMPASS_CALIBRATION_COMPLETED_OK   2
 #define COMPASS_CALIBRATION_COMPLETED_ERR  3
 
+namespace codal
+{
 
 /**
   * Class definition for the MicroBit BLE Magnetometer Service.
@@ -138,5 +140,7 @@ class MicroBitMagnetometerService : public MicroBitBLEService
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
-#endif
-#endif
+} // namespace codal
+
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_MAGNETOMETER_SERVICE_H
diff --git a/inc/bluetooth/MicroBitPartialFlashingService.h b/inc/bluetooth/MicroBitPartialFlashingService.h
@@ -51,6 +51,8 @@ DEALINGS IN THE SOFTWARE.
 #define MICROBIT_STATUS 0xEE
 #define MICROBIT_RESET  0xFF
 
+namespace codal
+{
 
 /**
   * Class definition for the custom MicroBit Partial Flash Service.
@@ -129,6 +131,7 @@ class MicroBitPartialFlashingService : public MicroBitBLEService
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
+} // namespace
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_PARTIAL_FLASH_SERVICE_H
diff --git a/inc/bluetooth/MicroBitTemperatureService.h b/inc/bluetooth/MicroBitTemperatureService.h
@@ -35,6 +35,8 @@ DEALINGS IN THE SOFTWARE.
 #include "MicroBitThermometer.h"
 #include "EventModel.h"
 
+namespace codal
+{
 
 /**
   * Class definition for the custom MicroBit Temperature Service.
@@ -106,6 +108,7 @@ class MicroBitTemperatureService : public MicroBitBLEService
     MicroBitBLEChar *characteristicPtr( int idx)    { return &chars[ idx]; };
 };
 
+} // namespace codal
 
-#endif
-#endif
+#endif // CONFIG_ENABLED(DEVICE_BLE)
+#endif // MICROBIT_TEMPERATURE_SERVICE_H
Original file line number	Diff line number	Diff line change
Expand Up		@@ -170,6 +170,4 @@ namespace codal

		extern codal::MicroBitDevice *microbit_device_instance;

		using namespace codal;

		#endif