chore: renames

Code/CMakeLists.txt

@@ -50,7 +50,7 @@ endif()
 add_subdirectory(Common)
 add_subdirectory(HAL)
 add_subdirectory(Displays)
-add_subdirectory(TextContent)
+add_subdirectory(TextProvider)
 
 if(NOT TEST_ON_PC)
     set(EXECUTABLE_NAME LedDisplayDriverExecutable)
@@ -59,7 +59,7 @@ if(NOT TEST_ON_PC)
         Common
         HAL
         Displays
-        TextContent
+        TextProvider
     )
      if(USE_STM32)
         stm32_print_size_of_target(${EXECUTABLE_NAME})

Code/TextContent/CMakeLists.txt → Code/TextProvider/CMakeLists.txt

@@ -1,5 +1,5 @@
-add_library(TextContent STATIC
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/TextContent.cpp
+add_library(TextProvider STATIC
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/TextBmhFormat.cpp
 )
 
 set(FONT_INCLUDE_DIR "${CMAKE_CURRENT_BINARY_DIR}/Generated/Fonts")
@@ -10,10 +10,10 @@ execute_process(COMMAND ${GENERATE_FONT_SCRIPT} ${FONT_INCLUDE_DIR} "Bitstream V
 execute_process(COMMAND ${GENERATE_FONT_SCRIPT} ${FONT_INCLUDE_DIR} "Bitstream Vera Sans Mono" 12)
 execute_process(COMMAND ${GENERATE_FONT_SCRIPT} ${FONT_INCLUDE_DIR} "Bitstream Vera Sans Mono" 16)
 
-target_include_directories(TextContent PUBLIC ${FONT_INCLUDE_DIR}/../)
+target_include_directories(TextProvider PUBLIC ${FONT_INCLUDE_DIR}/../)
 
-target_include_directories(TextContent PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
-target_link_libraries(TextContent Displays)
+target_include_directories(TextProvider PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+target_link_libraries(TextProvider Displays)
 
 if(TEST_ON_PC)
     add_subdirectory(test)

Code/TextProvider/include/ITextProvider.h

@@ -0,0 +1,34 @@
+#pragma once
+
+#include <stdint.h>
+
+#include "Monochrome.h"
+#include "PixelArea.h"
+#include "VecXD.h"
+
+class ITextProvider {
+   public:
+    virtual ~ITextProvider() = default;
+
+    /*!
+        @return The dimensions required to show the character
+    */
+    virtual auto GetRequiredSizeCharacter(char character) -> Vec2D;
+
+    /*!
+        @param string A null-terminated string
+        @param spacing The amount of pixels between characters in the string
+        @return The dimensions required to show the string
+    */
+    virtual auto GetRequiredSizeString(char* string, uint8_t spacing) -> Vec2D;
+
+    /*!
+        @param string A null-terminated string
+        @param spacing The amount of pixels between characters in the string
+        @param offset The offset from the top-left of the
+        @return success
+    */
+    virtual auto SetString(char* string, uint8_t spacing, Vec2D offset, PixelArea<Monochrome>& pixelArea) -> bool;
+
+    // Note: when new colors are required, copy paste the SetString(...) function interface
+};

Code/TextProvider/src/TextBmhFormat.cpp

@@ -0,0 +1 @@
+#include "TextBmhFormat.h"

Code/TextProvider/test/CMakeLists.txt

@@ -0,0 +1,14 @@
+add_executable(TestTextProvider
+  ${CMAKE_CURRENT_SOURCE_DIR}/TestTextBmhFormat.cpp
+)
+
+link_fuzztest(TestTextProvider)
+
+target_link_libraries(TestTextProvider PRIVATE
+  gtest
+  gmock
+  gtest_main
+  TextProvider
+)
+
+gtest_discover_tests(TestTextProvider)

Code/TextProvider/test/TestTextBmhFormat.cpp

@@ -0,0 +1,14 @@
+#include "TextBmhFormat.h"
+#include "fuzztest/fuzztest.h"
+#include "gmock/gmock.h"
+
+using namespace testing;
+using namespace fuzztest;
+
+namespace TextBmhFormatTesting {
+
+class FixtureTextBmhFormat : public Test {};
+
+TEST_F(FixtureTextBmhFormat, dummy) { ASSERT_TRUE(true); }
+
+}  // namespace TextBmhFormatTesting

Scripts/Test/RunTest.sh

@@ -119,12 +119,12 @@ GenerateTraceFile TestDisplays ${BUILD_DIR_TEST}/Displays/test/
 
 echo
 echo "//========================="
-echo "// Running TestTextContent"
+echo "// Running TestTextProvider"
 echo "//========================="
 echo
 
-RunTests TestTextContent ${BUILD_DIR_TEST}/TextContent/test/
-GenerateTraceFile TestTextContent ${BUILD_DIR_TEST}/TextContent/test/
+RunTests TestTextProvider ${BUILD_DIR_TEST}/TextProvider/test/
+GenerateTraceFile TestTextProvider ${BUILD_DIR_TEST}/TextProvider/test/
 
 echo
 echo "//========================="