Split out epub+renderer code into sindarin-inc/tiny-epub (#1154)

Author: johnboiles

.gitmodules

@@ -25,3 +25,6 @@
 [submodule "components/cpp-misc"]
 	path = components/cpp-misc
 	url = [email protected]:sindarin-inc/cpp-misc.git
+[submodule "components/tiny-epub"]
+	path = components/tiny-epub
+	url = [email protected]:sindarin-inc/tiny-epub.git

.vscode/c_cpp_properties.json

@@ -73,6 +73,20 @@
             "cStandard": "c17",
             "cppStandard": "c++17",
             "compileCommands": "${workspaceFolder}/components/esp_lcd_seeya103/test_apps/build-esp32p4/compile_commands.json"
+        },
+        {
+            "name": "sim",
+            "includePath": [
+                "${default}"
+            ],
+            "defines": [
+                "_DEBUG",
+                "UNICODE",
+                "_UNICODE"
+            ],
+            "cStandard": "c17",
+            "cppStandard": "c++17",
+            "compileCommands": "${workspaceFolder}/lib/Simulator/build/compile_commands.json"
         }
     ],
     "version": 4

components/cpp-misc

@@ -43,17 +43,36 @@ add_subdirectory(${REPO_ROOT_DIR}/components/miniz ${CMAKE_CURRENT_BINARY_DIR}/m
 
 add_subdirectory(${REPO_ROOT_DIR}/components/Adafruit-GFX-Library ${CMAKE_CURRENT_BINARY_DIR}/Adafruit-GFX-Library)
 
+# Compile configs to have libraries use our esp-idf stubs
+add_library(stubs_config INTERFACE)
+target_compile_definitions(stubs_config INTERFACE
+  CONFIG_LOG_TIMESTAMP_SOURCE_RTOS=1
+  CONFIG_LOG_MAXIMUM_LEVEL=4
+  ESP_PLATFORM=1
+)
+target_include_directories(stubs_config INTERFACE ${REPO_ROOT_DIR}/lib/Simulator/stubs/esp-idf)
+
 add_subdirectory("${REPO_ROOT_DIR}/components/cpp-misc/defer" ${CMAKE_CURRENT_BINARY_DIR}/defer)
 
 add_subdirectory("${REPO_ROOT_DIR}/components/cpp-misc/spiram-cpp" ${CMAKE_CURRENT_BINARY_DIR}/spiram-cpp)
-# Have spiram-cpp use our esp-idf stubs
-target_include_directories(spiram-cpp PUBLIC ${REPO_ROOT_DIR}/lib/Simulator/stubs/esp-idf)
-target_compile_definitions(spiram-cpp PUBLIC ESP_PLATFORM=1)
+target_link_libraries(spiram-cpp PUBLIC stubs_config)
 
 add_subdirectory("${REPO_ROOT_DIR}/components/cpp-misc/stringutil" ${CMAKE_CURRENT_BINARY_DIR}/stringutil)
 
+add_subdirectory("${REPO_ROOT_DIR}/components/cpp-misc/bmpimage" ${CMAKE_CURRENT_BINARY_DIR}/bmpimage)
+target_link_libraries(bmpimage PUBLIC stubs_config)
+
+add_subdirectory("${REPO_ROOT_DIR}/components/cpp-misc/unzipper" ${CMAKE_CURRENT_BINARY_DIR}/unzipper)
+target_link_libraries(unzipper PUBLIC stubs_config)
+
+add_subdirectory("${REPO_ROOT_DIR}/components/cpp-misc/idflog" ${CMAKE_CURRENT_BINARY_DIR}/idflog)
+
 add_subdirectory(${REPO_ROOT_DIR}/components/tiny-font ${CMAKE_CURRENT_BINARY_DIR}/tiny-font)
 
+add_subdirectory(${REPO_ROOT_DIR}/components/tiny-epub/epubfile ${CMAKE_CURRENT_BINARY_DIR}/epubfile)
+
+add_subdirectory(${REPO_ROOT_DIR}/components/tiny-epub/renderer ${CMAKE_CURRENT_BINARY_DIR}/renderer)
+
 # Conditionally link freetype if we're using 8-bit or 16-bit display
 if(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_24BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_SIM_16BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_SIM_8BIT")
     # Set FreeType options before adding the subdirectory
@@ -67,11 +86,19 @@ if(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_24BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_S
         CONFIG_TINYFONT_IBMF=0
         CONFIG_TINYFONT_DISPLAY_DPI=${TTF_SCREEN_RES_PER_INCH}
     )
+    target_compile_definitions(renderer PRIVATE
+        CONFIG_EPUB_RENDERER_REPLACE_SUPERSUBSCRIPT_CHARACTERS=0
+        CONFIG_EPUB_RENDERER_NATIVE_SUPERSUBSCRIPT_CHARACTERS=1
+    )
 else()
     target_compile_definitions(tiny-font PUBLIC
         CONFIG_TINYFONT_TTF=0
         CONFIG_TINYFONT_IBMF=1
     )
+    target_compile_definitions(renderer PRIVATE
+        CONFIG_EPUB_RENDERER_REPLACE_SUPERSUBSCRIPT_CHARACTERS=1
+        CONFIG_EPUB_RENDERER_NATIVE_SUPERSUBSCRIPT_CHARACTERS=0
+    )
 endif()
 
 add_subdirectory(${REPO_ROOT_DIR}/lib/esp_ringbuf ${CMAKE_CURRENT_BINARY_DIR}/esp_ringbuf)
@@ -90,7 +117,16 @@ endif()
 
 add_library(${PROJECT_NAME} STATIC ${SOURCES} ${HTTP_CLIENT_SOURCE})
 
-target_link_libraries(${PROJECT_NAME} PUBLIC pugixml ArduinoJson miniz astubs esp-idf-stubs nvs_flash Adafruit-GFX-Library tiny-font mbedtls mbedx509 mbedcrypto esp_ringbuf defer spiram-cpp stringutil)
+target_link_libraries(${PROJECT_NAME} PUBLIC ArduinoJson miniz astubs esp-idf-stubs nvs_flash Adafruit-GFX-Library tiny-font mbedtls mbedx509 mbedcrypto esp_ringbuf defer spiram-cpp stringutil epubfile renderer)
+
+target_compile_definitions(renderer PUBLIC
+    CONFIG_EPUB_RENDERER_MAX_BYTES_PER_PARAGRAPH=5003
+    CONFIG_EPUB_RENDERER_MAX_BYTES_PER_DISPLAY_PAGE=2400
+    CONFIG_EPUB_RENDERER_CSTR_POOL_SIZE=2000
+    CONFIG_EPUB_RENDERER_TOKENS_SIZE=500
+    CONFIG_EPUB_RENDERER_MAX_BYTES_PER_LINE=200
+    CONFIG_EPUB_RENDERER_LINES_SIZE=36
+)
 
 target_include_directories(${PROJECT_NAME} PUBLIC
     "${REPO_ROOT_DIR}/src"

components/tiny-epub

@@ -1,6 +1,8 @@
 cmake_minimum_required(VERSION 3.5)
 project(esp-idf-stubs)
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
 # Path to the root of the repo
 set(REPO_ROOT_DIR "${PROJECT_SOURCE_DIR}/../../../..")
 

components/tiny-font

@@ -1,5 +1,23 @@
 #include "esp_log.h"
 
+#include <stdio.h>
+#include <time.h>
+
 void esp_log_level_set(const char *tag, esp_log_level_t level) { return; }
 
 esp_log_level_t esp_log_level_get(const char *tag) { return ESP_LOG_DEBUG; }
+
+uint32_t esp_log_timestamp(void) {
+    struct timespec ts;
+    clock_gettime(CLOCK_MONOTONIC, &ts);
+    return (uint32_t)(ts.tv_sec * 1000 + ts.tv_nsec / 1000000);
+}
+
+void esp_log_write(esp_log_level_t level, const char *tag, const char *format, ...) {
+    va_list args;
+    va_start(args, format);
+    char buffer[512];
+    vsnprintf(buffer, sizeof(buffer), format, args);
+    va_end(args);
+    fprintf(stdout, "%s", buffer);
+}

lib/Simulator/Common/CMakeLists.txt

@@ -10,9 +10,12 @@
 #include <stb_image.h>
 #pragma clang diagnostic pop
 
+#include <EPubFile/EPubFile.hpp>
+#include <Renderer/Renderer.hpp>
+#include <Unzipper/UnzipperFileStream.hpp>
+
 #include "DisplayUtil.hpp"
-#include "EPub/EPubFile.hpp"
-#include "Renderers/Renderer.hpp"
+#include "Storage/SFileUnzipperStream.hpp"
 #include "UI/Fonts.hpp"
 
 int main(int argc, char **argv) {
@@ -121,11 +124,14 @@ int main(int argc, char **argv) {
     readable->readableType = readableType;
 
     PreferencesStore prefs;
-    SolDrm solDrm(prefs);
-    auto epubFile = std::make_shared<EPubFile>(file, readable, solDrm);
-
-    Renderer renderer(*display, boundingBoxRect, font);
-    renderer.setStream(epubFile);
+    auto solDrm = std::make_shared<SolDrm>(prefs);
+    auto unzipperStream = std::make_shared<SFileUnzipperStream>(file);
+    auto epubFile = std::make_shared<EPubFile>(unzipperStream, solDrm);
+    epubFile->setIsAnArticle(readable->readableType == "article");
+    auto epubStream = std::make_shared<EPubFileRendererStream>(epubFile);
+
+    Renderer renderer(*display, boundingBoxRect, FontHandle{font});
+    renderer.setStream(epubStream);
     renderer.renderPage(place);
     renderer.setLineSpacing(lineSpacing);
 

lib/Simulator/stubs/esp-idf/CMakeLists.txt

@@ -10,7 +10,6 @@ set(components
     miniz
     ulp
     astubs
-    pugixml
     improv
     ArduinoJson
     Adafruit-GFX-Library