chore: Template NoteSerial

Allows for SoftwareSerial

Author: zfields

src/NoteSerial.hpp

@@ -65,8 +65,7 @@ class NoteSerial
                the platform specific UART implementation.
 */
 /******************************************************************************/
-NoteSerial * make_note_serial (
-    NoteSerial::param_t serial_parameters
-);
+template<typename T> NoteSerial * make_note_serial (T & serial_parameters);
+NoteSerial * make_note_serial (nullptr_t);
 
 #endif // NOTE_SERIAL_HPP

src/NoteSerial_Arduino.cpp

@@ -1,26 +1,61 @@
 #include "NoteSerial_Arduino.hpp"
 
+#ifndef NOTE_MOCK
+#ifdef NOTE_ARDUINO_SOFTWARE_SERIAL_SUPPORT
+#include <SoftwareSerial.h>
+#endif
+#else
+#include "mock/mock-arduino.hpp"
+#endif
+
+// Template Meta-Programming (TMP) to extract the nested template type
+template <typename nested_type>
+struct ExtractNestedTemplateType {
+    // Default case: no extraction
+};
+template <typename nested_type>
+struct ExtractNestedTemplateType<MakeNoteSerial_ArduinoParameters<nested_type>> {
+    using type = nested_type;
+};
+
+// Singleton instance of the NoteSerial_Arduino class
+namespace instance {
+    inline NoteSerial* & note_serial (void) {
+        static NoteSerial* note_serial = nullptr;
+        return note_serial;
+    }
+};
+
 NoteSerial *
 make_note_serial (
-    NoteSerial::param_t serial_parameters_
-)
-{
-    static NoteSerial * note_serial = nullptr;
-    if (!serial_parameters_) {
-        if (note_serial) {
-            delete note_serial;
-            note_serial = nullptr;
-        }
-    } else if (!note_serial) {
-        MakeNoteSerial_ArduinoParameters * arduino_parameters = reinterpret_cast<MakeNoteSerial_ArduinoParameters *>(serial_parameters_);
-        note_serial = new NoteSerial_Arduino(arduino_parameters->hw_serial, arduino_parameters->baud_rate);
+    nullptr_t
+) {
+    NoteSerial* & note_serial = instance::note_serial();
+    if (note_serial) {
+        delete note_serial;
+        note_serial = nullptr;
     }
     return note_serial;
 }
 
-NoteSerial_Arduino::NoteSerial_Arduino
+template <typename T>
+NoteSerial *
+make_note_serial (
+    T & serial_parameters_
+) {
+    NoteSerial* & note_serial = instance::note_serial();
+    if (!note_serial) {
+        using serial_type = typename ExtractNestedTemplateType<T>::type;
+        note_serial = new NoteSerial_Arduino<serial_type>(serial_parameters_.hw_serial, serial_parameters_.baud_rate);
+    }
+
+    return note_serial;
+}
+
+template <typename T>
+NoteSerial_Arduino<T>::NoteSerial_Arduino
 (
-    HardwareSerial & hw_serial_,
+    T & hw_serial_,
     size_t baud_rate_
 ) :
     _notecardSerial(hw_serial_),
@@ -29,31 +64,35 @@ NoteSerial_Arduino::NoteSerial_Arduino
     _notecardSerial.begin(_notecardSerialSpeed);
 }
 
-NoteSerial_Arduino::~NoteSerial_Arduino (
+template <typename T>
+NoteSerial_Arduino<T>::~NoteSerial_Arduino (
     void
 )
 {
     _notecardSerial.end();
 }
 
+template <typename T>
 size_t
-NoteSerial_Arduino::available (
+NoteSerial_Arduino<T>::available (
     void
 )
 {
     return _notecardSerial.available();
 }
 
+template <typename T>
 char
-NoteSerial_Arduino::receive (
+NoteSerial_Arduino<T>::receive (
     void
 )
 {
     return _notecardSerial.read();
 }
 
+template <typename T>
 bool
-NoteSerial_Arduino::reset (
+NoteSerial_Arduino<T>::reset (
     void
 )
 {
@@ -63,8 +102,9 @@ NoteSerial_Arduino::reset (
     return true;
 }
 
+template <typename T>
 size_t
-NoteSerial_Arduino::transmit (
+NoteSerial_Arduino<T>::transmit (
     uint8_t *buffer,
     size_t size,
     bool flush
@@ -77,3 +117,12 @@ NoteSerial_Arduino::transmit (
     }
     return result;
 }
+
+// Explicitly instantiate the classes and methods for the supported types
+template class NoteSerial_Arduino<HardwareSerial>;
+template NoteSerial * make_note_serial<MakeNoteSerial_ArduinoParameters<HardwareSerial>>(MakeNoteSerial_ArduinoParameters<HardwareSerial> &);
+
+#ifdef NOTE_ARDUINO_SOFTWARE_SERIAL_SUPPORT
+template class NoteSerial_Arduino<SoftwareSerial>;
+template NoteSerial * make_note_serial<MakeNoteSerial_ArduinoParameters<SoftwareSerial>>(MakeNoteSerial_ArduinoParameters<SoftwareSerial> &);
+#endif

src/NoteSerial_Arduino.hpp

@@ -9,30 +9,32 @@
 #include "mock/mock-arduino.hpp"
 #endif
 
+template <typename T>
 struct MakeNoteSerial_ArduinoParameters {
     MakeNoteSerial_ArduinoParameters (
-        HardwareSerial & hw_serial_,
+        T & hw_serial_,
         size_t baud_rate_
     ) :
         hw_serial(hw_serial_),
         baud_rate(baud_rate_)
     { }
-    HardwareSerial & hw_serial;
+    T & hw_serial;
     size_t baud_rate;
 };
 
+template <typename T>
 class NoteSerial_Arduino final : public NoteSerial
 {
 public:
-    NoteSerial_Arduino(HardwareSerial & hw_serial_, size_t baud_rate_);
+    NoteSerial_Arduino(T & hw_serial_, size_t baud_rate_);
     ~NoteSerial_Arduino(void);
     size_t available(void) override;
     char receive(void) override;
     bool reset(void) override;
     size_t transmit(uint8_t * buffer, size_t size, bool flush) override;
 
 private:
-    HardwareSerial & _notecardSerial;
+    T & _notecardSerial;
     const int _notecardSerialSpeed;
 };
 

src/NoteTxn.hpp

@@ -38,13 +38,7 @@ class NoteTxn
                the platform specific transaction implementation.
 */
 /******************************************************************************/
-template <typename T>
-NoteTxn * make_note_txn (
-    T & txn_parameters
-);
-
-NoteTxn * make_note_txn (
-    nullptr_t
-);
+template<typename T> NoteTxn * make_note_txn (T & txn_parameters);
+NoteTxn * make_note_txn (nullptr_t);
 
 #endif // NOTE_TXN_HPP

src/NoteTxn_Arduino.cpp

@@ -7,21 +7,32 @@
   #include "mock/mock-parameters.hpp"
 #endif
 
+// Singleton instance of the NoteSerial_Arduino class
+namespace instance {
+    inline NoteTxn* & note_txn (void) {
+        static NoteTxn* note_txn = nullptr;
+        return note_txn;
+    }
+};
+
 NoteTxn *
 make_note_txn (
     nullptr_t
 ) {
-    const uint8_t invoke_deletion[2] = {0, 0}; // Invalid tuple invokes deletion
-    return make_note_txn(invoke_deletion);
+    NoteTxn* & note_txn = instance::note_txn();
+    if (note_txn) {
+        delete note_txn;
+        note_txn = nullptr;
+    }
+    return note_txn;
 }
 
 template <typename T>
 NoteTxn *
 make_note_txn (
     T & txn_pins_
 ) {
-    // Singleton
-    static NoteTxn * note_txn = nullptr;
+    NoteTxn* & note_txn = instance::note_txn();
 
     if (txn_pins_[0] == txn_pins_[1]) {
         // Invalid tuple invokes deletion

src/Notecard.h

@@ -24,6 +24,10 @@
 #ifndef Notecard_h
 #define Notecard_h
 
+#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR) || defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_NRF52) || defined(ARDUINO_ARCH_RP2040)
+#define NOTE_ARDUINO_SOFTWARE_SERIAL_SUPPORT
+#endif
+
 #include <stddef.h>
 #include <stdint.h>
 
@@ -34,6 +38,9 @@
 
 #ifdef ARDUINO
 #include <Arduino.h>
+#ifdef NOTE_ARDUINO_SOFTWARE_SERIAL_SUPPORT
+#include <SoftwareSerial.h>
+#endif
 #include <Wire.h>
 #include "NoteSerial_Arduino.hpp"
 #endif
@@ -77,9 +84,15 @@ class Notecard
         begin(make_note_i2c(&wirePort), i2cAddress, i2cMax);
     }
     inline void begin(HardwareSerial &serial, uint32_t speed = 9600) {
-        MakeNoteSerial_ArduinoParameters arduino_parameters(serial, speed);
-        begin(make_note_serial(&arduino_parameters));
+        MakeNoteSerial_ArduinoParameters<HardwareSerial> arduino_parameters(serial, speed);
+        begin(make_note_serial<MakeNoteSerial_ArduinoParameters<HardwareSerial>>(arduino_parameters));
     }
+#ifdef NOTE_ARDUINO_SOFTWARE_SERIAL_SUPPORT
+    inline void begin(SoftwareSerial &serial, uint32_t speed = 9600) {
+        MakeNoteSerial_ArduinoParameters<SoftwareSerial> arduino_parameters(serial, speed);
+        begin(make_note_serial<MakeNoteSerial_ArduinoParameters<SoftwareSerial>>(arduino_parameters));
+    }
+#endif
     inline void setDebugOutputStream(Stream &dbgserial) {
         setDebugOutputStream(make_note_log(&dbgserial));
     }
@@ -96,8 +109,7 @@ class Notecard
         setDebugOutputStream(nullptr);
     }
     inline void clearTransactionPins(void) {
-        uint8_t txn_pins[2] = {0};
-        setTransactionPins(make_note_txn(txn_pins));
+        setTransactionPins(make_note_txn(nullptr));
     }
     bool debugSyncStatus (int pollFrequencyMs, int maxLevel);
     void deleteResponse(J *rsp) const;