cleanup: Dedupe RingBuffer implementation in mocks

Author: franky47

test/mocks/CMakeLists.txt

@@ -4,8 +4,11 @@ add_library(test-mocks STATIC
     test-mocks.cpp
     test-mocks.h
     test-mocks_Namespace.h
-    test-mocks_Defs.h
     test-mocks_SerialMock.cpp
     test-mocks_SerialMock.hpp
     test-mocks_SerialMock.h
 )
+
+target_link_libraries(test-mocks
+    midi
+)

test/mocks/test-mocks_Defs.h

@@ -1,39 +1,11 @@
 #pragma once
 
 #include "test-mocks.h"
-#include "test-mocks_Defs.h"
+#include <inttypes.h>
+#include <src/midi_RingBuffer.h>
 
 BEGIN_TEST_MOCKS_NAMESPACE
 
-template<typename DataType, int Size>
-class RingBuffer
-{
-public:
-     RingBuffer();
-    ~RingBuffer();
-
-public:
-    int getLength() const;
-    bool isEmpty() const;
-
-public:
-    void write(DataType inData);
-    void write(const DataType* inData, int inSize);
-    void clear();
-
-public:
-    DataType peek() const;
-    DataType read();
-    void read(DataType* outData, int inSize);
-
-private:
-    DataType mData[Size];
-    DataType* mWriteHead;
-    DataType* mReadHead;
-};
-
-// -----------------------------------------------------------------------------
-
 template<int BufferSize>
 class SerialMock
 {
@@ -44,14 +16,14 @@ class SerialMock
 public: // Arduino Serial API
     void begin(int inBaudrate);
     int available() const;
-    void write(uint8 inData);
-    uint8 read();
+    void write(uint8_t inData);
+    uint8_t read();
 
 public: // Test Helpers API
     void moveTxToRx(); // Simulate loopback
 
 public:
-    typedef RingBuffer<uint8, BufferSize> Buffer;
+    typedef midi::RingBuffer<uint8_t, BufferSize> Buffer;
     Buffer mTxBuffer;
     Buffer mRxBuffer;
     int mBaudrate;

test/mocks/test-mocks_SerialMock.h

@@ -2,103 +2,6 @@
 
 BEGIN_TEST_MOCKS_NAMESPACE
 
-template<typename DataType, int Size>
-RingBuffer<DataType, Size>::RingBuffer()
-    : mWriteHead(mData)
-    , mReadHead(mData)
-{
-    memset(mData, DataType(0), Size * sizeof(DataType));
-}
-
-template<typename DataType, int Size>
-RingBuffer<DataType, Size>::~RingBuffer()
-{
-}
-
-// -----------------------------------------------------------------------------
-
-template<typename DataType, int Size>
-int RingBuffer<DataType, Size>::getLength() const
-{
-    if (mReadHead == mWriteHead)
-    {
-        return 0;
-    }
-    else if (mWriteHead > mReadHead)
-    {
-        return int(mWriteHead - mReadHead);
-    }
-    else
-    {
-        return int(mWriteHead - mData) + Size - int(mReadHead - mData);
-    }
-}
-
-template<typename DataType, int Size>
-bool RingBuffer<DataType, Size>::isEmpty() const
-{
-    return mReadHead == mWriteHead;
-}
-
-// -----------------------------------------------------------------------------
-
-template<typename DataType, int Size>
-void RingBuffer<DataType, Size>::write(DataType inData)
-{
-    *mWriteHead++ = inData;
-    if (mWriteHead >= mData + Size)
-    {
-        mWriteHead = mData;
-    }
-}
-
-template<typename DataType, int Size>
-void RingBuffer<DataType, Size>::write(const DataType* inData, int inSize)
-{
-    for (int i = 0; i < inSize; ++i)
-    {
-        write(inData[i]);
-    }
-}
-
-template<typename DataType, int Size>
-void RingBuffer<DataType, Size>::clear()
-{
-    memset(mData, DataType(0), Size * sizeof(DataType));
-    mReadHead  = mData;
-    mWriteHead = mData;
-}
-
-// -----------------------------------------------------------------------------
-
-template<typename DataType, int Size>
-DataType RingBuffer<DataType, Size>::peek() const
-{
-    return *mReadHead;
-}
-
-template<typename DataType, int Size>
-DataType RingBuffer<DataType, Size>::read()
-{
-    const DataType data = *mReadHead++;
-    if (mReadHead >= mData + Size)
-    {
-        mReadHead = mData;
-    }
-    return data;
-}
-
-template<typename DataType, int Size>
-void RingBuffer<DataType, Size>::read(DataType* outData, int inSize)
-{
-    for (int i = 0; i < inSize; ++i)
-    {
-        outData[i] = read();
-    }
-}
-
-// =============================================================================
-
 template<int BufferSize>
 SerialMock<BufferSize>::SerialMock()
 {
@@ -126,13 +29,13 @@ int SerialMock<BufferSize>::available() const
 }
 
 template<int BufferSize>
-void SerialMock<BufferSize>::write(uint8 inData)
+void SerialMock<BufferSize>::write(uint8_t inData)
 {
     mTxBuffer.write(inData);
 }
 
 template<int BufferSize>
-uint8 SerialMock<BufferSize>::read()
+uint8_t SerialMock<BufferSize>::read()
 {
     return mRxBuffer.read();
 }

test/mocks/test-mocks_SerialMock.hpp

@@ -3,14 +3,13 @@ include(CMakeToolsHelpers OPTIONAL)
 project(unit-tests)
 
 include_directories(
-    ${unit-tests_SOURCE_DIR}
-    ${gtest_SOURCE_DIR}/include
-    ${gmock_SOURCE_DIR}/include
-    "../../external/midi-usb/src"
+    "${unit-tests_SOURCE_DIR}"
+    "${gtest_SOURCE_DIR}/include"
+    "${gmock_SOURCE_DIR}/include"
+    "${ROOT_SOURCE_DIR}/external/midi-usb/src"
 )
 
 add_executable(unit-tests
-
     unit-tests.cpp
     unit-tests.h
     unit-tests_Namespace.h
@@ -20,7 +19,6 @@ add_executable(unit-tests
     tests/unit-tests_Settings.h
     tests/unit-tests_SysExCodec.cpp
     tests/unit-tests_RingBuffer.cpp
-    tests/unit-tests_SerialMock.cpp
     tests/unit-tests_MidiInput.cpp
     tests/unit-tests_MidiInputCallbacks.cpp
     tests/unit-tests_MidiOutput.cpp