File: System\Drawing\FontFamilyTests.cs
Web Access
Project: src\src\System.Drawing.Common\tests\System.Drawing.Common.Tests.csproj (System.Drawing.Common.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Drawing.Text;
using Windows.Win32.Foundation;
 
namespace System.Drawing.Tests;
 
public class FontFamilyTests
{
    [Theory]
    [InlineData(GenericFontFamilies.Serif - 1, "Courier New")] // Value is outside the enum range.
    [InlineData(GenericFontFamilies.Monospace + 1, "Courier New")] // Value is outside the enum range.
    [InlineData(GenericFontFamilies.Monospace, "Courier New")]
    [InlineData(GenericFontFamilies.SansSerif, "Microsoft Sans Serif")]
    [InlineData(GenericFontFamilies.Serif, "Times New Roman")]
    public void Ctor_GenericFamily(GenericFontFamilies genericFamily, string expectedName)
    {
        using FontFamily fontFamily = new(genericFamily);
        Assert.Equal(expectedName, fontFamily.Name);
    }
 
    [Theory]
    [InlineData("Courier New", "Courier New")]
    [InlineData("Microsoft Sans Serif", "Microsoft Sans Serif")]
    [InlineData("Times New Roman", "Times New Roman")]
    [InlineData("times new roman", "Times New Roman")]
    public void Ctor_Name(string name, string expectedName)
    {
        using FontFamily fontFamily = new(name);
        Assert.Equal(expectedName, fontFamily.Name);
    }
 
    [Fact]
    public void Ctor_Name_FontCollection()
    {
        using PrivateFontCollection fontCollection = new();
        fontCollection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        using FontFamily fontFamily = new("Code New Roman", fontCollection);
        Assert.Equal("Code New Roman", fontFamily.Name);
    }
 
    [Theory]
    [InlineData("NoSuchFont")]
    [InlineData("Serif")]
    public void Ctor_NoSuchFontName_ThrowsArgumentException(string? name)
    {
        AssertExtensions.Throws<ArgumentException>(null, () => new FontFamily(name));
        AssertExtensions.Throws<ArgumentException>(null, () => new FontFamily(name, null));
    }
 
    [Fact]
    public void Ctor_NullFontName_ThrowsArgumentNullException()
    {
        AssertExtensions.Throws<ArgumentNullException>("name", () => new FontFamily(null!));
        AssertExtensions.Throws<ArgumentNullException>("name", () => new FontFamily(null!, null));
    }
 
    [Fact]
    public void Ctor_NoSuchFontNameInCollection_ThrowsArgumentException()
    {
        using PrivateFontCollection fontCollection = new();
        AssertExtensions.Throws<ArgumentException>(null, () => new FontFamily("Times New Roman", fontCollection));
    }
 
    public static IEnumerable<object[]> Equals_TestData()
    {
        FontFamily fontFamily = FontFamily.GenericMonospace;
        yield return new object[] { fontFamily, fontFamily, true };
        yield return new object[] { FontFamily.GenericMonospace, FontFamily.GenericMonospace, true };
        yield return new object[] { FontFamily.GenericMonospace, FontFamily.GenericSansSerif, false };
 
        yield return new object[] { FontFamily.GenericSansSerif, new(), false };
        yield return new object[] { FontFamily.GenericSansSerif, null, false };
    }
 
    [Theory]
    [MemberData(nameof(Equals_TestData))]
    public void Equals_Object_ReturnsExpected(FontFamily fontFamily, object other, bool expected)
    {
        try
        {
            Assert.Equal(expected, fontFamily.Equals(other));
        }
        finally
        {
            fontFamily.Dispose();
            (other as IDisposable)?.Dispose();
        }
    }
 
    [Fact]
    public void Families_Get_ReturnsExpected()
    {
#pragma warning disable 0618 // FontFamily.GetFamilies is deprecated.
        using Bitmap image = new(10, 10);
        using var graphics = Graphics.FromImage(image);
        FontFamily[] families = FontFamily.Families;
        FontFamily[] familiesWithGraphics = FontFamily.GetFamilies(graphics);
 
        // FontFamily.Equals uses the native handle to determine equality. However, GDI+ does not always
        // cache handles, so we cannot just Assert.Equal(families, familiesWithGraphics);
        Assert.Equal(families.Length, familiesWithGraphics.Length);
 
        for (int i = 0; i < families.Length; i++)
        {
            Assert.Equal(families[i].Name, familiesWithGraphics[i].Name);
        }
 
        foreach (FontFamily fontFamily in families)
        {
            using FontFamily copy = new(fontFamily.Name);
            Assert.Equal(fontFamily.Name, copy.Name);
        }
#pragma warning restore 0618
    }
 
    [Fact]
    public void GenericMonospace_Get_ReturnsExpected()
    {
        using FontFamily fontFamily1 = FontFamily.GenericMonospace;
        using FontFamily fontFamily2 = FontFamily.GenericMonospace;
        Assert.NotSame(fontFamily1, fontFamily2);
        Assert.Equal("Courier New", fontFamily2.Name);
    }
 
    [Fact]
    public void GenericSansSerif_Get_ReturnsExpected()
    {
        using FontFamily fontFamily1 = FontFamily.GenericSansSerif;
        using FontFamily fontFamily2 = FontFamily.GenericSansSerif;
        Assert.NotSame(fontFamily1, fontFamily2);
        Assert.Equal("Microsoft Sans Serif", fontFamily2.Name);
    }
 
    [Fact]
    public void GenericSerif_Get_ReturnsExpected()
    {
        using FontFamily fontFamily1 = FontFamily.GenericSerif;
        using FontFamily fontFamily2 = FontFamily.GenericSerif;
        Assert.NotSame(fontFamily1, fontFamily2);
        Assert.Equal("Times New Roman", fontFamily2.Name);
    }
 
    [Fact]
    public void GetFamilies_NullGraphics_ThrowsArgumentNullException()
    {
#pragma warning disable 0618 // FontFamily.GetFamilies is deprecated.
        AssertExtensions.Throws<ArgumentNullException>("graphics", () => FontFamily.GetFamilies(null));
#pragma warning restore 0618
    }
 
    [Fact]
    public void GetHashCode_Invoke_ReturnsNameHashCode()
    {
        using FontFamily fontFamily = FontFamily.GenericSansSerif;
        Assert.Equal(fontFamily.GetName(0).GetHashCode(), fontFamily.GetHashCode());
    }
 
    public static IEnumerable<object[]> FontStyle_TestData()
    {
        yield return new object[] { FontStyle.Bold };
        yield return new object[] { FontStyle.Italic };
        yield return new object[] { FontStyle.Regular };
        yield return new object[] { FontStyle.Strikeout };
        yield return new object[] { FontStyle.Strikeout };
        yield return new object[] { FontStyle.Regular - 1 };
        yield return new object[] { FontStyle.Strikeout + 1 };
    }
 
    [Theory]
    [MemberData(nameof(FontStyle_TestData))]
    public void FontFamilyProperties_CustomFont_ReturnsExpected(FontStyle style)
    {
        using PrivateFontCollection fontCollection = new();
        fontCollection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        using FontFamily fontFamily = new("Code New Roman", fontCollection);
        Assert.True(fontFamily.IsStyleAvailable(style));
        Assert.Equal(1884, fontFamily.GetCellAscent(style));
        Assert.Equal(514, fontFamily.GetCellDescent(style));
        Assert.Equal(2048, fontFamily.GetEmHeight(style));
        Assert.Equal(2398, fontFamily.GetLineSpacing(style));
    }
 
    [Fact]
    public void IsStyleAvailable_Disposed_ThrowsArgumentException()
    {
        using PrivateFontCollection collection = new();
        collection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        FontFamily family = new("Code New Roman", collection);
        family.Dispose();
 
        AssertExtensions.Throws<ArgumentException>(null, () => family.IsStyleAvailable(FontStyle.Italic));
    }
 
    [Fact]
    public void GetEmHeight_Disposed_ThrowsArgumentException()
    {
        using PrivateFontCollection collection = new();
        collection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        FontFamily family = new("Code New Roman", collection);
        family.Dispose();
 
        AssertExtensions.Throws<ArgumentException>(null, () => family.GetEmHeight(FontStyle.Italic));
    }
 
    private const int FrenchLCID = 1036;
 
    [Theory]
    [InlineData(-1, "Code New Roman")]
    [InlineData(0, "Code New Roman")]
    [InlineData(int.MaxValue, "Code New Roman")]
    // This font has been modified to change the name to "Bonjour" if the language is French.
    [InlineData(FrenchLCID, "Bonjour")]
    public void GetName_LanguageCode_ReturnsExpected(int languageCode, string expectedName)
    {
        using PrivateFontCollection fontCollection = new();
        fontCollection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.ttf"));
 
        using FontFamily fontFamily = new("Code New Roman", fontCollection);
        Assert.Equal(expectedName, fontFamily.GetName(languageCode));
    }
 
    [Fact]
    public void GetName_Disposed_ThrowsArgumentException()
    {
        using PrivateFontCollection collection = new();
        collection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        FontFamily family = new("Code New Roman", collection);
        family.Dispose();
 
        AssertExtensions.Throws<ArgumentException>(null, () => family.GetName(0));
    }
 
    [Fact]
    public void GetCellAscent_Disposed_ThrowsArgumentException()
    {
        using PrivateFontCollection collection = new();
        collection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        FontFamily family = new("Code New Roman", collection);
        family.Dispose();
 
        AssertExtensions.Throws<ArgumentException>(null, () => family.GetCellAscent(FontStyle.Italic));
    }
 
    [Fact]
    public void GetCellDescent_Disposed_ThrowsArgumentException()
    {
        using PrivateFontCollection collection = new();
        collection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        FontFamily family = new("Code New Roman", collection);
        family.Dispose();
 
        AssertExtensions.Throws<ArgumentException>(null, () => family.GetCellDescent(FontStyle.Italic));
    }
 
    [Fact]
    public void GetLineSpacing_Disposed_ThrowsArgumentException()
    {
        using PrivateFontCollection collection = new();
        collection.AddFontFile(Helpers.GetTestFontPath("CodeNewRoman.otf"));
 
        FontFamily family = new("Code New Roman", collection);
        family.Dispose();
 
        AssertExtensions.Throws<ArgumentException>(null, () => family.GetLineSpacing(FontStyle.Italic));
    }
 
    [Fact]
    public void Dispose_MultipleTimes_Nop()
    {
        FontFamily fontFamily = FontFamily.GenericMonospace;
        fontFamily.Dispose();
        fontFamily.Dispose();
    }
 
    [Fact]
    public unsafe void MultipleInstancesHaveSameHandle()
    {
        using FontFamily fontFamily1 = new("Calibri");
        using FontFamily fontFamily2 = new("Calibri");
        Assert.Equal(
            (nint)fontFamily1.GetPointer(),
            (nint)fontFamily2.GetPointer());
    }
}