[fix] fix OpenFontRender.cpp

- patch for #45
- update github-actions
- update library version
- fix example bug
- modify document
- tweak fix

Author: takkaO

.github/workflows/gh-pages.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+  workflow_dispatch:
 
 env:
   ## コンテキスト
@@ -16,16 +17,17 @@ jobs:
       actions: write
       checks: write
       contents: write
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Set current datetime as env variable
         env:
           TZ: 'Asia/Tokyo' # Set timezone
         run: echo "CURRENT_DATETIME=$(date +'%Y-%m-%d %H:%M:%S')" >> $GITHUB_ENV
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
+          submodules: recursive
           fetch-depth: 0
 
       - name: Set git-configs
@@ -34,36 +36,20 @@ jobs:
           git config user.email [email protected]
           git config push.default current
 
-      - name: Set whether the branch is already existing to GITHUB_ENV
-        run: |
-          branch_is_existing=$(
-            git fetch origin ${{ env.DOCUMENT_BRANCH }} &&
-            echo true ||
-            echo false
-          )
-          echo "BRANCH_IS_EXISTING=${branch_is_existing}" >> $GITHUB_ENV
-
-      - name: Create branch if not exist
-        if: env.BRANCH_IS_EXISTING == 'false'
-        run: | 
-          git switch --orphan ${{ env.DOCUMENT_BRANCH }}
-          touch .gitkeep
-          git add .gitkeep
-          git commit -m "initial commit"
-          git push
-          git switch master
-
       - name: Load environment variables from .env file
         run: |
           for line in $(grep -v '^#' ./doxygen/.env.pages); do
             echo $line >> $GITHUB_ENV
           done
       
       # - name: check env
-      #   run: printenv
+      #   run: ls -a
+      
+      # - name: check env
+      #   run: cat .gitmodules
 
-      - name: Update submodules
-        run: git submodule update --init -- "doxygen/doxygen-awesome-css"
+      # - name: Update submodules
+      #   run: git submodule update --init "jothepro/doxygen-awesome-css"
 
       - name: Make document (run docker compose) 
         run: docker compose --env-file .env.pages up && docker compose down
@@ -77,26 +63,19 @@ jobs:
           sudo chown -R runner:docker ./$DOXYGEN_HTML_OUTPUT_DIR
           sudo chown -R runner:docker ./xml
 
-      - name: Add Stash
-        run: |
-          git add ./$DOXYGEN_HTML_OUTPUT_DIR
-          git stash push -- ./$DOXYGEN_HTML_OUTPUT_DIR
+      - name: Back directory
+        run: cp -r ./$DOXYGEN_HTML_OUTPUT_DIR ~/backup
 
-      - name: Reset changes
-        run: git reset --hard
-      
-      - name: Switch to document branch
-        run: git switch ${{ env.DOCUMENT_BRANCH }}
-            
-      - name: Remove unnecessary files
-        run: git clean -df
-      
-      # - name: ls
-      #   run: ls -all
-      
-      - name: Apply stash
-        run: git checkout stash -- ./$DOXYGEN_HTML_OUTPUT_DIR
-      
+      - name: Reset All
+        run: git checkout .
+
+      - name: Switch branch
+        run: | # ブランチが無い場合は新規作成し、ある場合は切り替える
+          git switch ${{ env.DOCUMENT_BRANCH }} 2>/dev/null || git switch --orphan ${{ env.DOCUMENT_BRANCH }}
+
+      - name: Restore directory
+        run: cp -rf ~/backup/* ./$DOXYGEN_HTML_OUTPUT_DIR
+          
       - name: Commit and push
         continue-on-error: true
         run: |
@@ -117,7 +96,7 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -131,21 +110,21 @@ jobs:
         run: git switch ${{ env.DOCUMENT_BRANCH }}
 
       - name: Setup Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
 
       # - name: check env
       #   run: printenv
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           # Upload entire repository
           path: ${{ env.DOXYGEN_HTML_OUTPUT_DIR }}
           #path: "./testpages"
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4
 
 
 

README.md

@@ -231,6 +231,8 @@ We would be happy to receive reports on hardware not listed here.
   - M5Stack (Board Manager v2.0.4)
     - M5Stack Basic (Library v0.1.4)
     - M5Stack Core2 (Library v0.4.0)
+  - STM32
+    - STM32H750 (by wystewart #34)
 - PlatformIO
   - M5Stack Basic (Library v2.0.4)
   - M5Stack Core2 (Library v2.0.4)

doxygen/.env.pages

@@ -1 +1 @@
-DOXYGEN_HTML_OUTPUT_DIR=testpages
+DOXYGEN_HTML_OUTPUT_DIR=docs

examples/WioTerminal/alignment_string/alignment_string.ino

@@ -110,11 +110,11 @@ void loop()
 
 void refreshGridLine()
 {
-	M5.Lcd.fillScreen(TFT_BLACK);
-	M5.Lcd.drawFastVLine(10, 0, 240, TFT_DARKGREY);
-	M5.Lcd.drawFastVLine(160, 0, 240, TFT_DARKGREY);
-	M5.Lcd.drawFastVLine(310, 0, 240, TFT_DARKGREY);
-	M5.Lcd.drawFastHLine(0, 30, 320, TFT_DARKGREY);
-	M5.Lcd.drawFastHLine(0, 120, 320, TFT_DARKGREY);
-	M5.Lcd.drawFastHLine(0, 210, 320, TFT_DARKGREY);
+	tft.fillScreen(TFT_BLACK);
+	tft.drawFastVLine(10, 0, 240, TFT_DARKGREY);
+	tft.drawFastVLine(160, 0, 240, TFT_DARKGREY);
+	tft.drawFastVLine(310, 0, 240, TFT_DARKGREY);
+	tft.drawFastHLine(0, 30, 320, TFT_DARKGREY);
+	tft.drawFastHLine(0, 120, 320, TFT_DARKGREY);
+	tft.drawFastHLine(0, 210, 320, TFT_DARKGREY);
 }

manuals/HOW_TO_OVERWRITE_FS_FUNC.md

@@ -1,5 +1,5 @@
 
-# How to load font files from file system {#tests_testa}
+# How to load font files from file system {#how_to_load_font_files_from_file_system}
 
 Control of file systems such as SD/TF cards and SPIFFS is strongly hardware-dependent.  
 OpenFontRender supports the following reads as presets.  

manuals/pages.md

@@ -1,3 +1,3 @@
 # Manuals
 
-@subpage tests_testa
+@subpage how_to_load_font_files_from_file_system

src/OpenFontRender.cpp

@@ -435,16 +435,16 @@ FT_Error OpenFontRender::loadFont(const unsigned char *data, size_t size, uint8_
  * @param[in] (target_face_index) Load font index. Default is 0.
  * @return FreeType error code. 0 is success.
  * @ingroup rendering_api
- * @note SD card access is strongly hardware dependent, so for hardware other than M5Stack and Wio Terminal,
- * @note you will need to add file manipulation functions to FileSupport.cpp/.h.
+ * @note SD card access is strongly hardware dependent, so you will need to include preset in `ofrfs` or
+ * @note implement custom file I/O code (see Manuals).
  * @note Any better solutions are welcome.
  */
 FT_Error OpenFontRender::loadFont(const char *fpath, uint8_t target_face_index) {
-	size_t len = strlen(fpath);
+	size_t len = strlen(fpath) + 1; // +1 is for NULL character because strlen do not include NULL character
 
-	_face_id.filepath = new char[len + 1]; // Release on unloadFont method
+	_face_id.filepath = new char[len](); // Release on unloadFont method
 	strncpy(_face_id.filepath, fpath, len);
-	_face_id.filepath[len] = '\0';
+	_face_id.filepath[len - 1] = '\0'; // Not required but explicitly stated.
 
 	_face_id.face_index = target_face_index;
 	return loadFont(OFR::FROM_FILE);
@@ -650,7 +650,7 @@ uint16_t OpenFontRender::drawHString(
 			break;
 	}
 
-	abbox.yMin = std::min(abbox.yMin, baseline_y - ascender);
+	abbox.yMin = std::min(abbox.yMin, static_cast<FT_Pos>(baseline_y - ascender));
 	std::vector<std::pair<int32_t, int32_t>> linePositions; // To store starting positions for each line
 
 	// calculate x postion for each line.
@@ -768,7 +768,7 @@ uint16_t OpenFontRender::drawHString(
 			}
 
 		}
-		abbox.yMax = std::max(abbox.yMax, baseline_y + descender);
+		abbox.yMax = std::max(abbox.yMax, static_cast<FT_Pos>(baseline_y + descender));
 	}
     return chars_written;
 }

src/OpenFontRender.h

@@ -182,8 +182,8 @@ namespace OFR {
 
 class OpenFontRender {
 public:
-	static const unsigned char MAIN_VERSION  = 1; ///< Open Font Render library main version.
-	static const unsigned char MINOR_VERSION = 2; ///< Open Font Render library minor version.
+	static const unsigned char MAIN_VERSION  = 2; ///< Open Font Render library main version.
+	static const unsigned char MINOR_VERSION = 0; ///< Open Font Render library minor version.
 
 	static const unsigned char CACHE_SIZE_NO_LIMIT    = 0;   ///< FreeType cache size alias.
 	static const unsigned char CACHE_SIZE_MINIMUM     = 1;   ///< FreeType cache size alias.