InkHUD refactoring (#6216)

* chore: todo.txt
* chore: comments
* fix: no fast refresh on VME290
Reverts a line of code which was accidentally committed
* refactor: god class
Divide the behavior from the old WindowManager class into several subclasses which each have a clear role.
* refactor: cppcheck medium warnings
Enough to pass github CI for now
* refactor: updateType selection
* refactor: don't use a setter for the shared AppletFonts
* fix: update prioritization
forceUpdate calls weren't being prioritized
* refactor: remove unhelpful logging
getTimeString is used for parsing our own time, but also the timestamps of messages. The "one time only" log printing will likely fire in unhelpful situations.
* fix: " "
* refactor: get rid of types.h file for enums
* Keep that sneaky todo file out of commits

src/graphics/niche/InkHUD/AppletFont.cpp

@@ -12,7 +12,7 @@ InkHUD::AppletFont::AppletFont()
 InkHUD::AppletFont::AppletFont(const GFXfont &adafruitGFXFont) : gfxFont(&adafruitGFXFont)
 {
     // AdafruitGFX fonts are drawn relative to a "cursor line";
-    // they print as if the glyphs resting on the line of piece of ruled paper.
+    // they print as if the glyphs are resting on the line of piece of ruled paper.
     // The glyphs also each have a different height.
 
     // To simplify drawing, we will scan the entire font now, and determine an appropriate height for a line of text
@@ -42,6 +42,19 @@ InkHUD::AppletFont::AppletFont(const GFXfont &adafruitGFXFont) : gfxFont(&adafru
     spaceCharWidth = gfxFont->glyph[(uint8_t)' ' - gfxFont->first].xAdvance;
 }
 
+/*
+
+             ▲    #####  #         ▲
+             │    #      #         │
+  lineHeight │    ###    #         │
+             │    #      #  #   #  │ heightAboveCursor
+             │    #      #  #   #  │
+             │    #      #   ####  │
+             │ -----------------#----
+             │                 #   │ heightBelowCursor
+             ▼               ###   ▼
+*/
+
 uint8_t InkHUD::AppletFont::lineHeight()
 {
     return this->height;
@@ -78,7 +91,7 @@ void InkHUD::AppletFont::addSubstitution(const char *from, const char *to)
     substitutions.push_back({.from = from, .to = to});
 }
 
-// Run all registered subtitutions on a string
+// Run all registered substitutions on a string
 // Used to swap out UTF8 special chars
 void InkHUD::AppletFont::applySubstitutions(std::string *text)
 {
@@ -87,7 +100,7 @@ void InkHUD::AppletFont::applySubstitutions(std::string *text)
 
         // Find and replace
         // - search for Substitution::from
-        // - replace with Subsitution::to
+        // - replace with Substitution::to
         size_t i = text->find(s.from);
         while (i != std::string::npos) {
             text->replace(i, strlen(s.from), s.to);
@@ -97,7 +110,7 @@ void InkHUD::AppletFont::applySubstitutions(std::string *text)
 }
 
 // Apply a set of substitutions which remap UTF8 for a Windows-1251 font
-// Windows-1251 is an 8-bit character encoding, designed to cover languages that use the Cyrillic script
+// Windows-1251 is an 8-bit character encoding, suitable for several languages which use the Cyrillic script
 void InkHUD::AppletFont::addSubstitutionsWin1251()
 {
     addSubstitution("Ђ", "\x80");