Editor: per-Font "logical height" property, support custom user value

This moves a "TTF fonts height used in the game logic" from General Settings to Font, therefore allowing to set this value individually per each Font.
Add a new "font definition" type: a custom user-defined value, useful to quickly fixup weird fonts.

Remove "default TTF font adjustment" from General Settings, leave only one in Font.

Author: ivan-mogilko

Common/ac/gamestructdefines.h

@@ -134,17 +134,20 @@ enum SpeechStyle
 // Contemporary font flags
 #define FFLG_SIZEMULTIPLIER        0x01  // size data means multiplier
 #define FFLG_DEFLINESPACING        0x02  // linespacing derived from the font height
-// Font load flags, primarily for backward compatibility:
-// REPORTNOMINALHEIGHT: get_font_height should return nominal font's height,
-// eq to "font size" parameter, otherwise returns real pixel height.
-#define FFLG_REPORTNOMINALHEIGHT   0x04
-// ASCENDFIXUP: do the TTF ascender fixup, where font's ascender is resized
-// to the nominal font's height.
+// Use nominal font's import size as a font's height in all the game logic.
+// If not set will use real font's height reported by the font file.
+#define FFLG_LOGICALNOMINALHEIGHT   0x04
+// Do the TTF ascender fixup, where font's ascender is resized
+// to the nominal font's height. This is primarily for backwards compatibility
+// with older games.
 #define FFLG_ASCENDERFIXUP         0x08
+// Use a user-provided custom value as a font's height in all the game logic.
+// If not set will use real font's height reported by the font file.
+#define FFLG_LOGICALCUSTOMHEIGHT   0x10
 // Collection of flags defining fully backward compatible TTF fixup
-#define FFLG_TTF_BACKCOMPATMASK   (FFLG_REPORTNOMINALHEIGHT | FFLG_ASCENDERFIXUP)
+#define FFLG_TTF_BACKCOMPATMASK   (FFLG_LOGICALNOMINALHEIGHT | FFLG_ASCENDERFIXUP)
 // Collection of flags defining font's load mode
-#define FFLG_LOADMODEMASK         (FFLG_REPORTNOMINALHEIGHT | FFLG_ASCENDERFIXUP)
+#define FFLG_LOADMODEMASK         (FFLG_LOGICALNOMINALHEIGHT | FFLG_LOGICALCUSTOMHEIGHT | FFLG_ASCENDERFIXUP)
 // Font outline types
 #define FONT_OUTLINE_NONE -1
 #define FONT_OUTLINE_AUTO -10
@@ -306,7 +309,10 @@ struct FontInfo
     int           SizeMultiplier;
     // Outlining font index, or auto-outline flag
     int           Outline;
-    // Custom vertical render offset, used mainly for fixing broken fonts
+    // Custom logical height (referred to when measuring text),
+    // used mainly for handling broken fonts
+    int           CustomHeight;
+    // Custom vertical render offset, used mainly for handling broken fonts
     int           YOffset;
     // Custom line spacing between two lines of text (0 = use font height)
     int           LineSpacing;

Common/font/agsfontrenderer.h

@@ -83,10 +83,13 @@ struct FontMetrics
     // Real font's height, equals to reported ascender + descender.
     // This is what you normally think as a font's height.
     int RealHeight = 0;
-    // Compatible height, equals to either NominalHeight or RealHeight,
+    // Custom height value provided by user.
+    // Meant to be used as a "logical height" in case of bad font data.
+    int CustomHeight = 0;
+    // Logical height, equals to either NominalHeight, RealHeight or CustomHeight,
     // selected depending on the game settings.
     // This property is used in calculating linespace, etc.
-    int CompatHeight = 0;
+    int LogicalHeight = 0;
     // Maximal bounding rectangle of a font's glyph, this tells the actual
     // graphical bounds that may be occupied by any font's glyphs.
     // BBox is given in pixels, relative to our "pen" position (top-left).

Common/font/fonts.cpp

@@ -156,10 +156,15 @@ static void font_post_init(int font_number)
         font.Metrics.RealHeight = font.Metrics.NominalHeight;
         font.Metrics.VExtent = std::make_pair(0, font.Metrics.RealHeight - 1);
     }
-    // Use either nominal or real pixel height to define font's logical height
+    // Use either nominal, real pixel height or a user-provided value to define font's logical height
     // and default linespacing; logical height = nominal height is compatible with the old games
-    font.Metrics.CompatHeight = (font.Info.Flags & FFLG_REPORTNOMINALHEIGHT) != 0 ?
-        font.Metrics.NominalHeight : font.Metrics.RealHeight;
+    font.Metrics.CustomHeight = font.Info.CustomHeight;
+    if ((font.Info.Flags & FFLG_LOGICALNOMINALHEIGHT) != 0)
+        font.Metrics.LogicalHeight = font.Metrics.NominalHeight;
+    else if ((font.Info.Flags & FFLG_LOGICALCUSTOMHEIGHT) != 0)
+        font.Metrics.LogicalHeight = font.Metrics.CustomHeight;
+    else
+        font.Metrics.LogicalHeight = font.Metrics.RealHeight;
 
     if (font.Info.Outline != FONT_OUTLINE_AUTO)
     {
@@ -182,7 +187,7 @@ static void font_post_init(int font_number)
         {
             // Calculate default linespacing from the font height + outline thickness.
             font.Info.Flags |= FFLG_DEFLINESPACING;
-            font.LineSpacingCalc = font.Metrics.CompatHeight + 2 * font.Info.AutoOutlineThickness;
+            font.LineSpacingCalc = font.Metrics.LogicalHeight + 2 * font.Info.AutoOutlineThickness;
         }
     }
 
@@ -368,7 +373,7 @@ int get_font_height(int font_number)
 {
     if (!assert_font_number(font_number))
         return 0;
-    return fonts[font_number].Metrics.CompatHeight;
+    return fonts[font_number].Metrics.LogicalHeight;
 }
 
 // Returns a max value between the chosen font height (this may be a compat height,
@@ -377,15 +382,15 @@ static int get_font_height_with_outline(int font_number, bool surf_height = fals
 {
     const int self_height = surf_height ?
         fonts[font_number].Metrics.ExtentHeight() :
-        fonts[font_number].Metrics.CompatHeight;
+        fonts[font_number].Metrics.LogicalHeight;
     const int outline = fonts[font_number].Info.Outline;
     if (outline < 0 || static_cast<uint32_t>(outline) >= fonts.size())
     { // FONT_OUTLINE_AUTO or FONT_OUTLINE_NONE
         return self_height + 2 * fonts[font_number].Info.AutoOutlineThickness;
     }
     const int outline_height = surf_height ?
         fonts[outline].Metrics.ExtentHeight() :
-        fonts[outline].Metrics.CompatHeight;
+        fonts[outline].Metrics.LogicalHeight;
     return std::max(self_height, outline_height);
 }
 
@@ -396,6 +401,13 @@ int get_font_height_outlined(int font_number)
     return get_font_height_with_outline(font_number);
 }
 
+int get_font_real_height(int font_number)
+{
+    if (!assert_font_number(font_number))
+        return 0;
+    return fonts[font_number].Metrics.RealHeight;
+}
+
 int get_font_surface_height(int font_number)
 {
     if (!assert_font_number(font_number))

Common/font/fonts.h

@@ -61,11 +61,13 @@ int get_text_width_outlined(const char *text, int font_number);
 // note that this won't be a nominal font's height, but the max of each met glyph's graphical height.
 int get_text_height(const char *text, int font_number);
 // Get font's height; this value is used for logical arrangement of UI elements;
-// note that this is a "formal" font height, that may have different value
-// depending on compatibility mode (used when running old games);
+// note that this value may depend on font settings, and return either nominal
+// import size, or real font's height, or a user-supplied custom value.
 int get_font_height(int font_number);
 // Get the height of the given font with corresponding outlining
 int get_font_height_outlined(int font_number);
+// Get the real dont's height as reported by the font file
+int get_font_real_height(int font_number);
 // Get font's surface height: this always returns the height enough to accomodate
 // any font's letters (glyphs) on a bitmap or a texture
 int get_font_surface_height(int font_number);

Common/font/ttffontrenderer.cpp

@@ -57,7 +57,7 @@ int TTFFontRenderer::GetTextHeight(const char * /*text*/, int fontNumber)
 {
   // Compatibility mode: if we required to return "nominal font height",
   // then ask alfont to return one the font was loaded with
-  if ((_fontData[fontNumber].Params.LoadMode & FFLG_REPORTNOMINALHEIGHT) != 0)
+  if ((_fontData[fontNumber].Params.LoadMode & FFLG_LOGICALNOMINALHEIGHT) != 0)
     return alfont_get_font_height(_fontData[fontNumber].AlFont);
   else
     return alfont_get_font_real_height(_fontData[fontNumber].AlFont);
@@ -116,7 +116,7 @@ static void FillMetrics(ALFONT_FONT *alfptr, FontMetrics *metrics)
 {
     metrics->NominalHeight = alfont_get_font_height(alfptr);
     metrics->RealHeight = alfont_get_font_real_height(alfptr);
-    metrics->CompatHeight = metrics->NominalHeight; // just set to default here
+    metrics->LogicalHeight = metrics->NominalHeight; // just set to default here
     {
         Rect ttf_bbox;
         alfont_get_font_bbox(alfptr, &ttf_bbox.Left, &ttf_bbox.Top, &ttf_bbox.Right, &ttf_bbox.Bottom);

Common/font/wfnfontrenderer.cpp

@@ -179,7 +179,7 @@ void WFNFontRenderer::GetFontMetrics(int fontNumber, FontMetrics *metrics)
     const char *height_test_string = "ZHwypgfjqhkilIK";
     metrics->NominalHeight = GetTextHeight(height_test_string, fontNumber);
     metrics->RealHeight = font->GetHeight() * size_mult;
-    metrics->CompatHeight = metrics->NominalHeight; // just set to default here
+    metrics->LogicalHeight = metrics->NominalHeight; // just set to default here
     metrics->BBox = font->GetBBox() * size_mult;
     metrics->VExtent = std::make_pair(metrics->BBox.Top, metrics->BBox.Bottom);
     // fix it up to be *not less* than realheight

Common/game/main_game_file.cpp

@@ -863,9 +863,9 @@ HError GameDataExtReader::ReadBlock(Stream *in, int /*block_id*/, const String &
                 static_cast<enum FontInfo::AutoOutlineStyle>(in->ReadInt32());
             // since kGameVersion_363
             finfo.CharacterSpacing = in->ReadInt32();
+            finfo.CustomHeight = in->ReadInt32();
             in->ReadInt32(); // reserved
             in->ReadInt32();
-            in->ReadInt32();
         }
     }
     else if (ext_id.CompareNoCase("v360_cursors") == 0)

Editor/AGS.Editor/AGSEditor.cs

@@ -115,8 +115,9 @@ public class AGSEditor
          * 3.6.2.6        - Settings.GameFPS.
          * 3.6.2.9        - Sprite.TransparentColorIndex (can select transparent palette index).
          * 3.6.3          - Settings.GUIHandleOnlyLeftMouseButton, Font.CharacterSpacing.
+         * 3.6.3.3        - Moved FontHeightDefinition property from General Settings to Font.
         */
-        public const int    LATEST_XML_VERSION_INDEX = 3060300;
+        public const int    LATEST_XML_VERSION_INDEX = 3060303;
         /*
          * LATEST_USER_DATA_VERSION is the last version of the user data file that used a
          * 4-point-4-number string to identify the version of AGS that saved the file.

Editor/AGS.Editor/Components/FontsComponent.cs

@@ -51,7 +51,6 @@ public override void CommandClick(string controlID)
                 newItem.PointSize = copyFrom.PointSize;
                 newItem.SourceFilename = Utilities.GetRelativeToProjectPath(copyFrom.SourceFilename);
                 newItem.ProjectFilename = $"agsfnt{newItem.ID}.{Path.GetExtension(copyFrom.ProjectFilename)}";
-                newItem.TTFMetricsFixup = _agsEditor.CurrentGame.Settings.TTFMetricsFixup; // use defaults
                 items.Add(newItem);
                 Utilities.CopyFont(copyFrom.ID, newItem.ID);
                 Factory.NativeProxy.OnFontAdded(_agsEditor.CurrentGame, newItem.ID);

Editor/AGS.Editor/DataFileWriter.cs

@@ -1484,8 +1484,10 @@ public static bool SaveThisGameToFile(string fileName, Game game, CompileMessage
                 int flags = 0;
                 if (game.Fonts[i].PointSize == 0)
                     flags |= NativeConstants.FFLG_SIZEMULTIPLIER;
-                if (game.Settings.TTFHeightDefinedBy == FontHeightDefinition.NominalHeight)
-                    flags |= NativeConstants.FFLG_REPORTNOMINALHEIGHT;
+                if (game.Fonts[i].HeightDefinedBy == FontHeightDefinition.NominalHeight)
+                    flags |= NativeConstants.FFLG_LOGICALNOMINALHEIGHT;
+                if (game.Fonts[i].HeightDefinedBy == FontHeightDefinition.CustomValue)
+                    flags |= NativeConstants.FFLG_LOGICALCUSTOMHEIGHT;
                 if (game.Fonts[i].TTFMetricsFixup == FontMetricsFixup.SetAscenderToHeight)
                     flags |= NativeConstants.FFLG_ASCENDERFIXUP;
                 writer.Write(flags);
@@ -1838,9 +1840,9 @@ private static void WriteExt_360Fonts(BinaryWriter writer, WriteExtEntities ents
                 writer.Write((int)game.Fonts[i].AutoOutlineStyle);
                 // Since 3.6.3
                 writer.Write(game.Fonts[i].CharacterSpacing);
+                writer.Write(game.Fonts[i].CustomHeightValue);
                 writer.Write((int)0); // reserved
                 writer.Write((int)0);
-                writer.Write((int)0);
             }
         }