add StreamTape class

Author: ianfixes

CHANGELOG.md

@@ -7,8 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
-
 - Minimal Wire mocks. Will not provide support for unit testing I2C communication yet, but will allow compilation of libraries that use I2C.
+- `StreamTape` class now bridges `Stream` and `HardwareSerial` to allow general-purpose stream mocking & history
 
 ### Changed
 - Arduino command failures (to read preferences) now causes a fatal error, with help for troubleshooting the underlying command
@@ -25,19 +25,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.2.0] - 2019-02-20
 ### Added
-* `release-new-version.sh` script
-* outputs for `PinHistory` can now report timestamps
-* Fibonacci Clock for clock testing purposes (internal to this library)
+- `release-new-version.sh` script
+- outputs for `PinHistory` can now report timestamps
+- Fibonacci Clock for clock testing purposes (internal to this library)
 
 ### Changed
-* Shortened `ArduinoQueue` push and pop operations
-* `ci/Queue.h` is now `MockEventQueue.h`, with timing data
-* `MockEventQueue::Node` now contains struct `MockEventQueue::Event`, which contains both the templated type `T` and a field for a timestamp.
-* Construction of `MockEventQueue` now includes a constructor argument for the time-fetching function
-* Construction of `PinHistory` now includes a constructor argument for the time-fetching function
-* `PinHistory` can now return an array of timestamps for its events
-* `GodmodeState` is now a singleton pattern, which is necessary to support the globality of Arduino functions
-* `GodmodeState` now uses timestamped PinHistory for Analog and Digital
+- Shortened `ArduinoQueue` push and pop operations
+- `ci/Queue.h` is now `MockEventQueue.h`, with timing data
+- `MockEventQueue::Node` now contains struct `MockEventQueue::Event`, which contains both the templated type `T` and a field for a timestamp.
+- Construction of `MockEventQueue` now includes a constructor argument for the time-fetching function
+- Construction of `PinHistory` now includes a constructor argument for the time-fetching function
+- `PinHistory` can now return an array of timestamps for its events
+- `GodmodeState` is now a singleton pattern, which is necessary to support the globality of Arduino functions
+- `GodmodeState` now uses timestamped PinHistory for Analog and Digital
 
 ### Fixed
 * `ArduinoQueue` no longer leaks memory

cpp/arduino/HardwareSerial.h

@@ -1,7 +1,7 @@
 #pragma once
 
 //#include <inttypes.h>
-#include "Stream.h"
+#include "ci/StreamTape.h"
 
 // definitions neeeded for Serial.begin's config arg
 #define SERIAL_5N1 0x00
@@ -29,38 +29,19 @@
 #define SERIAL_7O2 0x3C
 #define SERIAL_8O2 0x3E
 
-class HardwareSerial : public Stream, public ObservableDataStream
+class HardwareSerial : public StreamTape
 {
-  protected:
-    String* mGodmodeDataOut;
-
   public:
-    HardwareSerial(String* dataIn, String* dataOut, unsigned long* delay): Stream(), ObservableDataStream() {
-      mGodmodeDataIn      = dataIn;
-      mGodmodeDataOut     = dataOut;
-      mGodmodeMicrosDelay = delay;
-    }
+    HardwareSerial(String* dataIn, String* dataOut, unsigned long* delay): StreamTape(dataIn, dataOut, delay) {}
+
     void begin(unsigned long baud) { begin(baud, SERIAL_8N1); }
     void begin(unsigned long baud, uint8_t config) {
       *mGodmodeMicrosDelay = 1000000 / baud;
     }
     void end() {}
 
-    // virtual int available(void);
-    // virtual int peek(void);
-    // virtual int read(void);
-    // virtual int availableForWrite(void);
-    // virtual void flush(void);
-    virtual size_t write(uint8_t aChar) {
-      mGodmodeDataOut->append(String((char)aChar));
-      advertiseByte((unsigned char)aChar);
-      return 1;
-    }
-
-    // https://stackoverflow.com/a/4271276
-    using Print::write; // pull in write(str) and write(buf, size) from Print
+    // support "if (Serial1) {}" sorts of things
     operator bool() { return true; }
-
 };
 
 #if defined(UBRRH) || defined(UBRR0H)

cpp/arduino/ci/StreamTape.h

@@ -0,0 +1,36 @@
+#pragma once
+
+#include "../Stream.h"
+
+/**
+ * Stream with godmode-controlled input and godmode-persisted output
+ */
+class StreamTape : public Stream, public ObservableDataStream
+{
+  protected:
+    String* mGodmodeDataOut;
+    // mGodmodeDataIn is provided by Stream
+
+  public:
+    StreamTape(String* dataIn, String* dataOut, unsigned long* delay): Stream(), ObservableDataStream() {
+      mGodmodeDataIn      = dataIn;
+      mGodmodeDataOut     = dataOut;
+      mGodmodeMicrosDelay = delay;
+    }
+
+    // virtual int available(void);
+    // virtual int peek(void);
+    // virtual int read(void);
+    // virtual int availableForWrite(void);
+    // virtual void flush(void);
+    virtual size_t write(uint8_t aChar) {
+      mGodmodeDataOut->append(String((char)aChar));
+      advertiseByte((unsigned char)aChar);
+      return 1;
+    }
+
+    // https://stackoverflow.com/a/4271276
+    using Print::write; // pull in write(str) and write(buf, size) from Print
+
+};
+