Added a Font Converter and align Font, FontFamily to System.Drawing interface (#13)

* Add GraphicsUnit

* Move installed fonts loading to InstalledFontCollection class

* Upgrade SkiaSharp to 2.88.8

* Move FaceName calculation to Font since FontFamily is not for any particular Style

* Rearrange generic family

* Create same public constructor as System.Drawing for FontFamily
FontFamily represent all possibles styles from a family name.

* Use new factory methods FromFIle, FromStream

* Minor changes

* Add FontStyle to Font

* Fix Clone function
(GetCellDescent will be added back later)

* Fix Dispose, ToString, Equals

* Group static properties

* Fix Metrics

* Add SizeInPoints property

* Add FontConverter to convert from Font to string and back

* Adjust unit tests for fonts

* Fix unit tests in linux

* minor changes

* define Font and FontFamily as sealed

* FromFile should not be public. Use the same way to load from a file as with System.Drawing

* Disable the tests that don't work as expected with skia

* Fix test exclusion for mac

* Throw exceptions as the doc says

* Fix merge of GraphicsUnit

* Add typeface index in Font.ToString()

* Inline GetFontFamilies() since it is only used in the constructor
Make constructor public because it is available in System.Drawing

* add test-cases for InstalledFontCollection and PrivateFontCollection

* Calculate DPI instead of having it hardcoded

* Fix exception message to be consistent with others

* Add default font directory for Linux

* Remove no longer used parameter

* Add Factory region and move methods before Methods region, to be consistent with Image.cs

* Remove Instance property since it is not part of System.Drawing interface and it is only used on FontFamily

* Fix summaries in FontConverter class (use <see> tag and remove System.Drawing references)

* relocate GetGenericFontFamily under Factory region and rename as FromGenericFontFamily

* reuse FontFamily constructor logic

* remove FontFamily(FontFamily[]) private constructor and relocate Match methods to a new Utilitiesregion

* fix enclosed class definition

* add missing Font constrcutors, reuse them, and redefine properties with private set for avoiding extra private property

* define PrivateFontCollection and InstalledFontCollection as sealed

* redefine InstalledFontCollection just based on SKFontManager

* set ownership to false in FromFontCollection method

* set ownership to false in FontFamily(FontFamily) constructor

* redefine FontFamily(string, FontFamily[]) constructor and reuse Families instance (instead of creating a new InstalledFontCollection instance)

* remove m_original property and define OriginalFontName instead (with get and private set)

* add gdiCharSet and gdiVerticalFont param descriptions

* fix comment in SizeInPoints for Display and Pixel values

---------

Co-authored-by: dsalvia <[email protected]>
Co-authored-by: damiansalvia <[email protected]>

Author: 3 people

src/Common/Font.cs

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="SkiaSharp" Version="2.88.7" />
+    <PackageReference Include="SkiaSharp" Version="2.88.8" />
     <PackageReference Include="SkiaSharp.Extended" Version="2.0.0" />
     <PackageReference Include="SkiaSharp.NativeAssets.Linux.NoDependencies" Version="2.88.7" />
     <PackageReference Include="SkiaSharp.Svg" Version="1.60.0" />

src/Common/FontConverter.cs

@@ -1,42 +1,43 @@
 namespace GeneXus.Drawing;
 
 /// <summary>
-///  Specifies the unit of measure for the given data.
+/// Specifies the unit of measure for the given data
 /// </summary>
 public enum GraphicsUnit
 {
 	/// <summary>
-	///  Specifies the world unit as the unit of measure.
+	/// Specifies the world coordinate system unit as the unit of measure.
 	/// </summary>
 	World = 0,
 
 	/// <summary>
-	///  Specifies 1/75 inch as the unit of measure.
+	/// Specifies the unit of measure of the display device. Typically pixels for video
+	/// displays, and 1/100 inch for printers.
 	/// </summary>
 	Display = 1,
 
 	/// <summary>
-	///  Specifies a device pixel as the unit of measure.
+	/// Specifies a device pixel as the unit of measure.
 	/// </summary>
 	Pixel = 2,
 
 	/// <summary>
-	///  Specifies a printer's point (1/72 inch) as the unit of measure.
+	/// Specifies a printer's point (1/72 inch) as the unit of measure.
 	/// </summary>
 	Point = 3,
 
 	/// <summary>
-	///  Specifies the inch as the unit of measure.
+	/// Specifies the inch as the unit of measure.
 	/// </summary>
 	Inch = 4,
 
 	/// <summary>
-	///  Specifies the document unit (1/300 inch) as the unit of measure.
+	/// Specifies the document unit (1/300 inch) as the unit of measure.
 	/// </summary>
 	Document = 5,
 
 	/// <summary>
-	///  Specifies the millimeter as the unit of measure.
+	/// Specifies the millimeter as the unit of measure.
 	/// </summary>
 	Millimeter = 6
 }

src/Common/FontFamily.cs

@@ -5,14 +5,14 @@ namespace GeneXus.Drawing.Text;
 
 public abstract class FontCollection : IDisposable
 {
-	protected List<FontFamily> m_families = new List<FontFamily>();
+	protected readonly List<FontFamily> m_families = new();
 
 	/// <summary>
 	///  Cleans up resources for this <see cref='FontCollection'/>.
 	/// </summary>
 	~FontCollection() => Dispose(false);
 
-
+	
 	#region IDisposable
 
 	/// <summary>
@@ -24,7 +24,7 @@ public void Dispose()
 		Dispose(true);
 	}
 
-	protected virtual void Dispose(bool disposing)
+	private void Dispose(bool disposing)
 	{
 		foreach (FontFamily ff in m_families)
 			ff.Dispose();
@@ -34,7 +34,7 @@ protected virtual void Dispose(bool disposing)
 	#endregion
 
 
-	#region Propertie
+	#region Properties
 
 	/// <summary>
 	///  Gets the array of <see cref='FontFamily'/> objects associated with this <see cref='FontCollection'/>.

src/Common/GeneXus.Drawing.Common.csproj

@@ -1,13 +1,29 @@
-namespace GeneXus.Drawing.Text;
+using SkiaSharp;
+using System.Collections.Generic;
 
-public class InstalledFontCollection : FontCollection
+namespace GeneXus.Drawing.Text;
+
+public sealed class InstalledFontCollection : FontCollection
 {
 	/// <summary>
-	///  Initializes a new instance of the <see cref='InstalledFontCollection'/> class.
+	/// Initializes a new instance of the <see cref='InstalledFontCollection'/> class.
 	/// </summary>
-	public InstalledFontCollection() : base()
+	public InstalledFontCollection() 
 	{
-		foreach (var font in Font.SystemFonts)
-			m_families.Add(font.FontFamily);
+		foreach (string name in SKFontManager.Default.FontFamilies)
+		{
+			List<SKTypeface> typefaces = new();
+			foreach (SKFontStyle style in SKFontManager.Default.GetFontStyles(name))
+			{
+				var typeface = SKFontManager.Default.MatchFamily(name, style);
+				typefaces.Add(typeface);
+			}
+
+			if (typefaces.Count == 0)
+				continue;
+
+			FontFamily fontFamily = new(name, typefaces.ToArray(), true);
+			m_families.Add(fontFamily);
+		}
 	}
 }

src/Common/GraphicsUnit.cs

@@ -4,34 +4,36 @@
 
 namespace GeneXus.Drawing.Text;
 
-public class PrivateFontCollection : FontCollection
+public sealed class PrivateFontCollection : FontCollection
 {
 	/// <summary>
-	///  Initializes a new instance of the <see cref='PrivateFontCollection'/> class.
+	/// Initializes a new instance of the <see cref='PrivateFontCollection'/> class.
 	/// </summary>
-	public PrivateFontCollection() : base()
-	{ }
+	public PrivateFontCollection() { }
+
+
+	#region Methods
 
 	/// <summary>
-	///  Adds a font from the specified file to this <see cref='PrivateFontCollection'/>.
+	/// Adds a font from the specified file to this <see cref='PrivateFontCollection'/>.
 	/// </summary>
-	public void AddFontFile(string filename)
+	public void AddFontFile(string filePath)
 	{
-		var fontFamily = new FontFamily(filename);
-		m_families.Add(fontFamily);
+		m_families.Add(FontFamily.FromFile(filePath));
 	}
 
 	/// <summary>
-	///  Adds a font contained in system memory to this <see cref='PrivateFontCollection'/>.
+	/// Adds a font contained in system memory to this <see cref='PrivateFontCollection'/>.
 	/// </summary>
 	public void AddMemoryFont(IntPtr memory, int length)
 	{
 		byte[] fontData = new byte[length];
 		Marshal.Copy(memory, fontData, 0, length);
 
-		using var stream = new MemoryStream(fontData);
-
-		var fontFamily = new FontFamily(stream);
+		using MemoryStream stream = new(fontData);
+		FontFamily fontFamily = FontFamily.FromStream(stream);
 		m_families.Add(fontFamily);
 	}
+
+	#endregion
 }

src/Common/Text/FontCollection.cs

@@ -0,0 +1,49 @@
+using System;
+using System.ComponentModel;
+
+namespace GeneXus.Drawing.Test;
+
+internal class FontConverterTest
+{
+	[Test]
+	public void Method_ConvertFromString()
+	{
+		Font font = TypeDescriptor.GetConverter(typeof(Font)).ConvertFromString("Verdana,12") as Font;
+		Assert.Multiple(() =>
+		{
+			Assert.That(font?.Name, Is.EqualTo("Verdana"));
+			Assert.That(Math.Abs(font.Size - 12f), Is.LessThan(0.01));
+			Assert.That(font.Unit, Is.EqualTo(GraphicsUnit.Point));
+			Assert.That(font.Style, Is.EqualTo(FontStyle.Regular));
+		});
+	}
+	
+	[Test]
+	public void Method_ConvertToString()
+	{
+		Font font = new("Verdana"); // default size is 12
+		string text = TypeDescriptor.GetConverter(typeof(Font)).ConvertToString(font);
+		Assert.That(text, Is.EqualTo("Verdana, 12pt"));
+	}
+	
+	[Test]
+	public void Method_ConvertFromString_Unknown()
+	{
+		Font font = TypeDescriptor.GetConverter(typeof(Font)).ConvertFromString("UnknownFont,14") as Font;
+		Assert.Multiple(() =>
+		{
+			Assert.That(font?.Name, Is.EqualTo("UnknownFont"));
+			Assert.That(Math.Abs(font.Size - 14f), Is.LessThan(0.01));
+			Assert.That(font.Unit, Is.EqualTo(GraphicsUnit.Point));
+			Assert.That(font.Style, Is.EqualTo(FontStyle.Regular));
+		});
+	}
+	
+	[Test]
+	public void Method_ConvertToString_Unknown()
+	{
+		Font font = new("UnknownFont"); // default size is 12
+		string text = TypeDescriptor.GetConverter(typeof(Font)).ConvertToString(font);
+		Assert.That(text, Is.EqualTo("UnknownFont, 12pt"));
+	}
+}

src/Common/Text/InstalledFontCollection.cs

@@ -1,7 +1,8 @@
 using GeneXus.Drawing.Text;
-using NUnit.Framework;
 using System;
+using System.Collections.Generic;
 using System.IO;
+using System.Runtime.InteropServices;
 
 namespace GeneXus.Drawing.Test;
 
@@ -17,90 +18,67 @@ public void Setup()
 	}
 
 	[Test]
-	[TestCase("Montserrat-Regular.ttf", "Montserrat", 968, 251, 1219, 1000 )]
-	[TestCase("Montserrat-Italic.ttf", "Montserrat", 968, 251, 1219, 1000 )]
-	[TestCase("Montserrat-Bold.ttf", "Montserrat", 968, 251, 1219, 1000 )]
-	[TestCase("Graphik-Regular.otf", "Graphik", 818, 182, 1100, 1000 )]
-	[TestCase("Graphik-Italic.otf", "Graphik", 818, 182, 1100, 1000 )]
-	[TestCase("Graphik-Bold.otf", "Graphik", 825, 175, 1100, 1000 )]
-	[TestCase("EncodeSans-Regular.ttf", "Encode Sans", 2060, 440, 2500, 2000)]
-	[TestCase("EncodeSans-Condensed.ttf", "Encode Sans", 2060, 440, 2500, 2000)]
-	[TestCase("EncodeSans-Expanded.ttf", "Encode Sans", 2060, 440, 2500, 2000)]
-	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", 1000, 366, 1366, 1000 , 7)]
-	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", 1000, 366, 1366, 1000 , 4)]
-	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", 1000, 366, 1366, 1000 , 0)]
-	public void Constructor_FileName(string fileName, string familyName, int ascent, int descent, int lineSpacing, int emHeight, int fontIndex = 0)
+	[TestCase("Montserrat-Regular.ttf", "Montserrat", FontStyle.Regular, 968, 251, 1219, 1000 )]
+	[TestCase("Montserrat-Italic.ttf", "Montserrat", FontStyle.Italic, 968, 251, 1219, 1000 )]
+	[TestCase("Montserrat-Bold.ttf", "Montserrat", FontStyle.Bold, 968, 251, 1219, 1000 )]
+	[TestCase("Graphik-Regular.otf", "Graphik", FontStyle.Regular, 818, 182, 1100, 1000 )]
+	[TestCase("Graphik-Italic.otf", "Graphik", FontStyle.Italic, 818, 182, 1100, 1000 )]
+	[TestCase("Graphik-Bold.otf", "Graphik", FontStyle.Bold, 825, 175, 1100, 1000 )]
+	[TestCase("EncodeSans-Regular.ttf", "Encode Sans", FontStyle.Regular, 2060, 440, 2500, 2000)]
+	[TestCase("EncodeSans-Condensed.ttf", "Encode Sans Condensed", FontStyle.Regular, 2060, 440, 2500, 2000)]
+	[TestCase("EncodeSans-Expanded.ttf", "Encode Sans Expanded", FontStyle.Regular, 2060, 440, 2500, 2000)]
+	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", FontStyle.Regular, 1000, 366, 1366, 1000)]
+	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", FontStyle.Italic, 1000, 366, 1366, 1000)]
+	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", FontStyle.Bold, 1000, 366, 1366, 1000)]
+	public void Constructor_FileName(string fileName, string familyName, FontStyle style, int ascent, int descent, int lineSpacing, int emHeight)
 	{
-		var fontPath = Path.Combine(FONT_PATH, fileName);
-		using var family = new FontFamily(fontPath, fontIndex);
-		Assert.Multiple(() =>
-		{
-			Assert.That(family.Name, Is.EqualTo(familyName));
-			Assert.That(family.GetCellAscent(), Is.EqualTo(ascent));
-			Assert.That(family.GetCellDescent(), Is.EqualTo(descent));
-			Assert.That(family.GetLineSpacing(), Is.EqualTo(lineSpacing));
-			Assert.That(family.GetEmHeight(), Is.EqualTo(emHeight));
-		});
-	}
+		if (fileName.StartsWith("EncodeSans-") && RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+			familyName = "Encode Sans"; // in Windows it doesn't read the correct family name for this font with skia
 
-	[Test]
-	[TestCase("Montserrat-Regular.ttf", "Montserrat", 968, 251, 1219, 1000)]
-	[TestCase("Montserrat-Italic.ttf", "Montserrat", 968, 251, 1219, 1000)]
-	[TestCase("Montserrat-Bold.ttf", "Montserrat", 968, 251, 1219, 1000)]
-	[TestCase("Graphik-Regular.otf", "Graphik", 818, 182, 1100, 1000)]
-	[TestCase("Graphik-Italic.otf", "Graphik", 818, 182, 1100, 1000)]
-	[TestCase("Graphik-Bold.otf", "Graphik", 825, 175, 1100, 1000)]
-	[TestCase("EncodeSans-Regular.ttf", "Encode Sans", 2060, 440, 2500, 2000)]
-	[TestCase("EncodeSans-Condensed.ttf", "Encode Sans", 2060, 440, 2500, 2000)]
-	[TestCase("EncodeSans-Expanded.ttf", "Encode Sans", 2060, 440, 2500, 2000)]
-	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", 1000, 366, 1366, 1000, 7)]
-	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", 1000, 366, 1366, 1000, 4)]
-	[TestCase("AvenirNext-Collection.ttc", "Avenir Next", 1000, 366, 1366, 1000, 0)]
-	public void Constructor_Stream(string fileName, string familyName, int ascent, int descent, int lineSpacing, int emHeight, int fontIndex = 0)
-	{
-		var fontPath = Path.Combine(FONT_PATH, fileName);
-		using var fontStream = File.OpenRead(fontPath);
-		using var family = new FontFamily(fontStream, fontIndex);
+		string fontPath = Path.Combine(FONT_PATH, fileName);
+		using PrivateFontCollection fontCollection = new();
+		fontCollection.AddFontFile(fontPath);
+
+		FontFamily family = fontCollection.Families[0];
 		Assert.Multiple(() =>
 		{
 			Assert.That(family.Name, Is.EqualTo(familyName));
-			Assert.That(family.GetCellAscent(), Is.EqualTo(ascent));
-			Assert.That(family.GetCellDescent(), Is.EqualTo(descent));
-			Assert.That(family.GetLineSpacing(), Is.EqualTo(lineSpacing));
-			Assert.That(family.GetEmHeight(), Is.EqualTo(emHeight));
+			Assert.That(family.GetCellAscent(style), Is.EqualTo(ascent));
+			Assert.That(family.GetCellDescent(style), Is.EqualTo(descent));
+			Assert.That(family.GetLineSpacing(style), Is.EqualTo(lineSpacing));
+			Assert.That(family.GetEmHeight(style), Is.EqualTo(emHeight));
 		});
 	}
 
 	[Test]
 	public void Constructor_FontCollection()
 	{
-		using var pfc = new PrivateFontCollection();
+		using PrivateFontCollection pfc = new();
 		pfc.AddFontFile(Path.Combine(FONT_PATH, "Montserrat-Regular.ttf"));
 		pfc.AddFontFile(Path.Combine(FONT_PATH, "Montserrat-Italic.ttf"));
 		pfc.AddFontFile(Path.Combine(FONT_PATH, "Montserrat-Bold.ttf"));
 		Assert.That(pfc.Families, Has.Length.EqualTo(3));
 
-		using var font = new Font(pfc.Families[1]);
-		using var family = new FontFamily(font.Name, pfc);
+		using FontFamily family = new("Montserrat", pfc);
 		Assert.Multiple(() =>
 		{
 			Assert.That(family.Name, Is.EqualTo("Montserrat"));
 			Assert.That(family.IsStyleAvailable(FontStyle.Regular), Is.True);
-			Assert.That(family.IsStyleAvailable(FontStyle.Italic), Is.EqualTo((font.Style & FontStyle.Italic) == FontStyle.Italic));
-			Assert.That(family.IsStyleAvailable(FontStyle.Bold), Is.EqualTo((font.Style & FontStyle.Bold) == FontStyle.Bold));
+			Assert.That(family.IsStyleAvailable(FontStyle.Italic), Is.True);
+			Assert.That(family.IsStyleAvailable(FontStyle.Bold), Is.True);
 		});
 	}
-
+	
 	[Test]
 	public void Constructor_GenericFont()
 	{
-		using var monospace = new FontFamily(GenericFontFamilies.Monospace);
-		Assert.That(monospace.Name, Is.AnyOf("Courier New", "Consolas", "Courier", "Menlo", "Monaco", "Lucida Console").IgnoreCase);
+		using FontFamily monospace = new(GenericFontFamilies.Monospace);
+		Assert.That(monospace.Name, Is.AnyOf("Courier New", "Consolas", "Courier", "Menlo", "Monaco", "Lucida Console", "DejaVu Sans Mono").IgnoreCase);
 
-		using var sanserif = new FontFamily(GenericFontFamilies.SansSerif);
-		Assert.That(sanserif.Name, Is.AnyOf("Arial", "Helvetica", "Verdana", "Tahoma", "Trebuchet MS", "Gill Sans").IgnoreCase);
+		using FontFamily sanserif = new(GenericFontFamilies.SansSerif);
+		Assert.That(sanserif.Name, Is.AnyOf("Arial", "Helvetica", "Verdana", "Tahoma", "Trebuchet MS", "Gill Sans", "DejaVu Sans").IgnoreCase);
 
-		using var justserif = new FontFamily(GenericFontFamilies.Serif);
-		Assert.That(justserif.Name, Is.AnyOf("Times New Roman", "Georgia", "Garamond", "Palatino", "Book Antiqua", "Baskerville").IgnoreCase);
+		using FontFamily serif = new(GenericFontFamilies.Serif);
+		Assert.That(serif.Name, Is.AnyOf("Times New Roman", "Georgia", "Garamond", "Palatino", "Book Antiqua", "Baskerville", "DejaVu Serif").IgnoreCase);
 	}
 }