Skip to content

Ensure font fallback is to "font" and not just to "typeface" #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MatteoH2O1999 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Ensure font fallback is to "font" and not just to "typeface" #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5bea09
Encapsulate scaling logic
MatteoH2O1999 Jan 22, 2026
8764c5b
Ensure fallback to font instead of fallback to typeface
MatteoH2O1999 Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/Barcode128ElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
{
// TODO: use font 0, auto scale for Mode D
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
this.DrawInterpretationLine(interpretation, labelFont, x, y, resizedImage.Width, resizedImage.Height, barcode.FieldOrigin != null, barcode.FieldOrientation, barcode.PrintInterpretationLineAboveCode, options);
}
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/Barcode39ElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
this.DrawInterpretationLine(interpretation, labelFont, x, y, resizedImage.Width, resizedImage.Height, barcode.FieldOrigin != null, barcode.FieldOrientation, barcode.PrintInterpretationLineAboveCode, options);
}
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/Barcode93ElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
this.DrawInterpretationLine(content, labelFont, x, y, resizedImage.Width, resizedImage.Height, barcode.FieldOrigin != null, barcode.FieldOrientation, barcode.PrintInterpretationLineAboveCode, options);
}
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/BarcodeAnsiCodabarElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
this.DrawInterpretationLine(interpretation, labelFont, x, y, resizedImage.Width, resizedImage.Height, barcode.FieldOrigin != null, barcode.FieldOrientation, barcode.PrintInterpretationLineAboveCode, options);
}
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/BarcodeEAN13ElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
if (barcode.PrintInterpretationLineAboveCode)
{
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/BarcodeUpcAElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
if (barcode.PrintInterpretationLineAboveCode)
{
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/BarcodeUpcEElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
if (barcode.PrintInterpretationLineAboveCode)
{
Expand Down
2 changes: 1 addition & 1 deletion src/BinaryKits.Zpl.Viewer/ElementDrawers/BarcodeUpcExtensionElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = FontScale.GetBitmappedFontSize("A", Math.Min(barcode.ModuleWidth, 10), printDensityDpmm).Value;
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
this.DrawInterpretationLine(interpretation, labelFont, x, y, resizedImage.Width, resizedImage.Height, barcode.FieldOrigin != null, barcode.FieldOrientation, barcode.PrintInterpretationLineAboveCode, options);
}
Expand Down
8 changes: 5 additions & 3 deletions src/BinaryKits.Zpl.Viewer/ElementDrawers/DrawerOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using SkiaSharp;
using SkiaSharp;

using System;

Expand All @@ -7,7 +7,10 @@ namespace BinaryKits.Zpl.Viewer.ElementDrawers
public class DrawerOptions
{
[Obsolete("Use FontManager.FontLoader instead.")]
public Func<string, SKTypeface> FontLoader { get; set; }
public Func<string, SKTypeface> FontLoader {
get => FontManager.FontLoader;
set => FontManager.FontLoader = value;
}

/// <summary>
/// Gets or sets the image format used when rendering output.
Expand Down Expand Up @@ -51,7 +54,6 @@ public DrawerOptions() : this(new FontManager()) { }
public DrawerOptions(FontManager fontManager)
{
this.FontManager = fontManager;
this.FontLoader = fontManager.FontLoader;
}
}
}
5 changes: 5 additions & 0 deletions src/BinaryKits.Zpl.Viewer/ElementDrawers/ElementDrawerBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ namespace BinaryKits.Zpl.Viewer.ElementDrawers
{
public abstract class ElementDrawerBase : IElementDrawer
{
/// <summary>
/// The font to use if the specified font is not found.
/// </summary>
protected const string FallbackFont = "A";

internal IPrinterStorage printerStorage;
internal SKCanvas skCanvas;

Expand Down
10 changes: 6 additions & 4 deletions src/BinaryKits.Zpl.Viewer/ElementDrawers/FieldBlockElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using BinaryKits.Zpl.Label;
using BinaryKits.Zpl.Label;
using BinaryKits.Zpl.Label.Elements;
using BinaryKits.Zpl.Viewer.Helpers;

Expand Down Expand Up @@ -41,16 +41,18 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
{
ZplFont font = fieldBlock.Font;

(float fontSize, float scaleX) = FontScale.GetFontScaling(font.FontName, font.FontHeight, font.FontWidth, printDensityDpmm);
SKTypeface typeface = options.FontManager.GetFont(font.FontName, FallbackFont, out bool found);
string fontName = found ? font.FontName : FallbackFont;

(float fontSize, float scaleX) = FontScale.GetFontScaling(fontName, font.FontHeight, font.FontWidth, printDensityDpmm);

SKTypeface typeface = options.FontManager.FontLoader(font.FontName);
string text = fieldBlock.Text;
if (fieldBlock.HexadecimalIndicator is char hexIndicator)
{
text = text.ReplaceHexEscapes(hexIndicator, internationalFont);
}

if (font.FontName == "0")
if (fontName == "0")
{
if (options.ReplaceDashWithEnDash)
{
Expand Down
3 changes: 0 additions & 3 deletions src/BinaryKits.Zpl.Viewer/ElementDrawers/GraphicSymbolElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo

(float fontSize, float scaleX) = FontScale.GetFontScaling("GS", graphicSymbol.Height, graphicSymbol.Width, printDensityDpmm);

// remove incorrect scaling
fontSize /= 1.1f;

SKTypeface typeface = options.FontManager.TypefaceGS;

SKFont skFont = new(typeface, fontSize * 1.25f, scaleX);
Expand Down
4 changes: 2 additions & 2 deletions src/BinaryKits.Zpl.Viewer/ElementDrawers/Interleaved2of5BarcodeDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using BinaryKits.Zpl.Label;
using BinaryKits.Zpl.Label;
using BinaryKits.Zpl.Label.Elements;
using BinaryKits.Zpl.Viewer.Helpers;

Expand Down Expand Up @@ -53,7 +53,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
if (barcode.PrintInterpretationLine)
{
float labelFontSize = Math.Min(barcode.ModuleWidth * 10f, 100f);
SKTypeface labelTypeFace = options.FontManager.FontLoader("A");
SKTypeface labelTypeFace = options.FontManager.GetFont("A");
SKFont labelFont = new(labelTypeFace, labelFontSize);
this.DrawInterpretationLine(content, labelFont, x, y, resizedImage.Width, resizedImage.Height, barcode.FieldOrigin != null, barcode.FieldOrientation, barcode.PrintInterpretationLineAboveCode, options);
}
Expand Down
7 changes: 4 additions & 3 deletions src/BinaryKits.Zpl.Viewer/ElementDrawers/TextFieldElementDrawer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,10 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo

ZplFont font = textField.Font;

(float fontSize, float scaleX) = FontScale.GetFontScaling(font.FontName, font.FontHeight, font.FontWidth, printDensityDpmm);
SKTypeface typeface = options.FontManager.GetFont(font.FontName, FallbackFont, out bool found);
string fontName = found ? font.FontName : FallbackFont;

SKTypeface typeface = options.FontManager.FontLoader(font.FontName);
(float fontSize, float scaleX) = FontScale.GetFontScaling(fontName, font.FontHeight, font.FontWidth, printDensityDpmm);

SKFont skFont = new(typeface, fontSize, scaleX);
using SKPaint skPaint = new()
Expand All @@ -62,7 +63,7 @@ public override SKPoint Draw(ZplElementBase element, DrawerOptions options, SKPo
displayText = displayText.ReplaceHexEscapes(hexIndicator, internationalFont);
}

if (font.FontName == "0")
if (fontName == "0")
{
if (options.ReplaceDashWithEnDash)
{
Expand Down
95 changes: 87 additions & 8 deletions src/BinaryKits.Zpl.Viewer/FontManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,20 @@ public class FontManager
];

/// <summary>
/// Gets or sets the delegate used to load a font by name and return an SKTypeface instance.
/// Gets or sets the delegate used to load a font by name and return an <see cref="SKTypeface"/>.
/// </summary>
/// <remarks>The delegate should accept a font name as a string and return the corresponding
/// SKTypeface. This property allows customization of font loading behavior, such as loading fonts from embedded
/// resources or external files.</remarks>
public Func<string, SKTypeface> FontLoader { get; set; }
/// <remarks>
/// The delegate should accept a font name as a string and return the corresponding
/// <see cref="SKTypeface"/>, or <see langword="null"/> if the font is not found. This property allows customization
/// of font loading behavior, such as loading fonts from embedded resources or external files.
/// </remarks>
public Func<string, SKTypeface> FontLoader {
[Obsolete("Use FontManager.GetFont instead")]
get => this.fontLoader;
set => this.fontLoader = value ?? throw new ArgumentNullException(nameof(value));
}

private Func<string, SKTypeface> fontLoader;

private static readonly SKFontStyle fontStyle0 = new(
SKFontStyleWeight.Bold,
Expand Down Expand Up @@ -81,8 +89,9 @@ internal SKTypeface TypefaceA {

internal SKTypeface TypefaceGS { get; } = SKTypeface.FromStream(new MemoryStream(Resources.ZplGS));

public FontManager() {
this.FontLoader = (fontName) => {
public FontManager()
{
this.fontLoader = (fontName) => {
if (fontName == "0")
{
return this.Typeface0;
Expand All @@ -103,7 +112,9 @@ public void RegisterTypeface(SKTypeface typeface)
if (this.registeredTypefaces.TryGetValue(typeface.FamilyName, out IList<SKTypeface> typefaces))
{
typefaces.Add(typeface);
} else {
}
else
{
this.registeredTypefaces[typeface.FamilyName] = [typeface];
}
}
Expand Down Expand Up @@ -157,5 +168,73 @@ private SKTypeface GetTypeFaceByFamily(string familyName, SKFontStyle fontStyle)
return null;
}

/// <summary>
/// Retrieves the typeface for <paramref name="fontName"/>.
/// </summary>
/// <returns>
/// The requested <see cref="SKTypeface"/>.
/// </returns>
/// <exception cref="FontNotFoundException">
/// If <paramref name="fontName"/> is not found.
/// </exception>
/// <inheritdoc cref="GetFont(string, string, out bool)"/>
public SKTypeface GetFont(string fontName)
{
return this.GetFont(fontName, null, out bool _);
}

/// <inheritdoc cref="GetFont(string, string, out bool)"/>
public SKTypeface GetFont(string fontName, string fallbackFont)
{
return this.GetFont(fontName, fallbackFont, out bool _);
}

/// <summary>
/// Tries to retrieve the typeface for <paramref name="fontName"/>, falling back to <paramref name="fallbackFont"/>
/// if not <see langword="null"/>.
/// </summary>
/// <param name="fontName">The name of the font to find</param>
/// <param name="fallbackFont">The fallback font to use if <paramref name="fontName"/> is not found</param>
/// <param name="found">
/// <see langword="true"/> if <paramref name="fontName"/> is found, <see langword="false"/> otherwise.
/// </param>
/// <returns>
/// The requested <see cref="SKTypeface"/> or the fallback one.
/// </returns>
/// <exception cref="FontNotFoundException">
/// If <paramref name="fontName"/> is not found and <paramref name="fallbackFont"/> is <see langword="null"/>
/// or if it is not <see langword="null"/> but not found.
/// </exception>
public SKTypeface GetFont(string fontName, string fallbackFont, out bool found)
{
SKTypeface font = this.fontLoader(fontName);
if (font == null)
{
found = false;
if (fallbackFont == null)
{
throw new FontNotFoundException(fontName);
}

font = this.fontLoader(fallbackFont);
if (font == null)
{
throw new FontNotFoundException(fontName, fallbackFont);
}
}
else
{
found = true;
}

return font;
}
}

public class FontNotFoundException : Exception
{
internal FontNotFoundException(string fontName) : base($"Font '{fontName}' not found") { }

internal FontNotFoundException(string fontName, string fallbackFont) : base($"Font '{fontName}' and fallback font '{fallbackFont}' not found") { }
}
}
10 changes: 8 additions & 2 deletions src/BinaryKits.Zpl.Viewer/Helpers/FontScale.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,11 @@ public static (float fontSize, float scaleX) GetFontScaling(string fontName, int
{
double heightRatio = (double)fontHeight / height;
int intHeightRatio = (int)Math.Max(1, Math.Round(heightRatio));
float emSize = height * intHeightRatio * heightScale;
float emSize = height * intHeightRatio;
if (!fontName.Equals("GS"))
{
emSize *= heightScale;
}

if (fontWidth == 0)
{
Expand All @@ -148,7 +152,9 @@ public static (float fontSize, float scaleX) GetFontScaling(string fontName, int
double widthRatio = (double)fontWidth / width;
int intWidthRatio = (int)Math.Max(1, Math.Round(widthRatio));

return (height * intWidthRatio * heightScale, 1.0f);
return fontName.Equals("GS")
? (height * intWidthRatio, 1.0f)
: (height * intWidthRatio * heightScale, 1.0f);
}
else
{
Expand Down
Loading