Add a Vertical Text Block to the Windows Community Toolkit

.gitignore

@@ -21,6 +21,7 @@ build/
 bld/
 [Bb]in/
 [Oo]bj/
+Generated Files/
 
 # Visual Studio 2015 cache/options directory
 .vs/

Directory.Build.props

@@ -65,7 +65,7 @@
         <PackageReference Include="StyleCop.Analyzers" Version="1.0.2" PrivateAssets="all" />
 
         <EmbeddedResource Include="**\*.rd.xml" />
-        <Page Include="**\*.xaml" Exclude="**\bin\**\*.xaml;**\obj\**\*.xaml" SubType="Designer" Generator="MSBuild:Compile" />
+        <Page Include="**\*.xaml" Exclude="**\bin\**\*.xaml;**\obj\**\*.xaml;**\Generated Files\**\*.xaml" SubType="Designer" Generator="MSBuild:Compile" />
         <Compile Update="**\*.xaml.cs" DependentUpon="%(Filename)" />
       </ItemGroup>
       <PropertyGroup Condition="'$(Configuration)' == 'Release'">

Microsoft.Toolkit.Uwp.SampleApp/Microsoft.Toolkit.Uwp.SampleApp.csproj

@@ -282,6 +282,7 @@
     <Content Include="Icons\More.png" />
     <Content Include="Icons\Notifications.png" />
     <Content Include="Icons\Services.png" />
+    <Content Include="SamplePages\DirectWriteTextBlock\DirectWriteTextBlock.png" />
     <Content Include="SamplePages\OnDevice\OnDevice.png" />
     <Content Include="SamplePages\RemoteDeviceHelper\RemoteDeviceHelper.png" />
     <Content Include="SamplePages\ImageCropper\ImageCropper.png" />
@@ -524,6 +525,7 @@
     <Content Include="SamplePages\RemoteDevicePicker\RemoteDevicePickerCode.bind" />
     <Content Include="SamplePages\PlannerTaskList\PlannerTaskListXaml.bind" />
     <Content Include="SamplePages\DataGrid\DataGridCode.bind" />
+    <Content Include="SamplePages\DirectWriteTextBlock\DirectWriteTextBlockCode.bind" />
     <Content Include="SamplePages\TabView\TabViewXaml.bind">
       <SubType>Designer</SubType>
     </Content>
@@ -580,6 +582,9 @@
     <Compile Include="Models\LandingPageResource.cs" />
     <Compile Include="Models\LandingPageLink.cs" />
     <Compile Include="Models\PaneState.cs" />
+    <Compile Include="SamplePages\DirectWriteTextBlock\DirectWriteTextBlockPage.xaml.cs">
+      <DependentUpon>DirectWriteTextBlockPage.xaml</DependentUpon>
+    </Compile>
     <Compile Include="SamplePages\TabView\TabViewPage.xaml.cs">
       <DependentUpon>TabViewPage.xaml</DependentUpon>
     </Compile>
@@ -956,6 +961,10 @@
       <SubType>Designer</SubType>
       <Generator>MSBuild:Compile</Generator>
     </Page>
+    <Page Include="SamplePages\DirectWriteTextBlock\DirectWriteTextBlockPage.xaml">
+      <SubType>Designer</SubType>
+      <Generator>MSBuild:Compile</Generator>
+    </Page>
     <Page Include="SamplePages\OnDevice\OnDevicePage.xaml">
       <Generator>MSBuild:Compile</Generator>
       <SubType>Designer</SubType>
@@ -1437,6 +1446,10 @@
       <Project>{d4d78cba-b238-4794-89a0-4f1a2d8fea97}</Project>
       <Name>Microsoft.Toolkit.Uwp.UI.Controls.Graph</Name>
     </ProjectReference>
+    <ProjectReference Include="..\Microsoft.Toolkit.Uwp.UI.Controls.WinRT\Microsoft.Toolkit.Uwp.UI.Controls.WinRT.vcxproj">
+      <Project>{d4c7ac54-826a-4412-8461-a7c7fd86534b}</Project>
+      <Name>Microsoft.Toolkit.Uwp.UI.Controls.WinRT</Name>
+    </ProjectReference>
     <ProjectReference Include="..\Microsoft.Toolkit.Uwp.UI.Controls\Microsoft.Toolkit.Uwp.UI.Controls.csproj">
       <Project>{e9faabfb-d726-42c1-83c1-cb46a29fea81}</Project>
       <Name>Microsoft.Toolkit.Uwp.UI.Controls</Name>

Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DirectWriteTextBlock/DirectWriteTextBlockCode.bind

@@ -0,0 +1,27 @@
+<Page
+    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:controls="using:Microsoft.Toolkit.Uwp.UI.Controls.WinRT"
+    mc:Ignorable="d">
+
+    <Grid>
+        <StackPanel>
+        <TextBlock
+            Text="This is a standard XAML Textblock for comparison."
+            FontFamily="@[FontFamily:String:Segoe UI]"
+            FontWeight="@[FontWeight:String:Normal]"
+            FontStyle="@[FontStyle:Enum:FontStyle.Normal]"
+            FontStretch="@[FontStretch:Enum:FontStretch.Normal]"
+            FontSize="@[FontSize:Slider:15:1-100]" />
+        <controls:DirectWriteTextBlock
+            Text="@[Text:String:Windows Community Toolkit]"
+            FontFamily="@[FontFamily:String:Segoe UI]"
+            FontWeight="@[FontWeight:String:Normal]"
+            FontStyle="@[FontStyle:Enum:FontStyle.Normal]"
+            FontStretch="@[FontStretch:Enum:FontStretch.Normal]"
+            FontSize="@[FontSize:Slider:15:1-100]" />
+        </StackPanel>
+    </Grid>
+</Page>

Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DirectWriteTextBlock/DirectWriteTextBlockPage.xaml

@@ -0,0 +1,19 @@
+<Page
+    x:Class="Microsoft.Toolkit.Uwp.SampleApp.SamplePages.DirectWriteTextBlockPage"
+    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:local="using:Microsoft.Toolkit.Uwp.SampleApp.SamplePages"
+    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:controls="using:Microsoft.Toolkit.Uwp.UI.Controls.WinRT"
+    mc:Ignorable="d"
+    Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
+
+    <Grid>
+        <StackPanel>
+            <!-- Need a custom Design project in order to get my custom enums into the .bind file.-->
+            <TextBlock Text="This is a standard XAML Textblock for comparison."/>
+            <controls:DirectWriteTextBlock />
+        </StackPanel>
+    </Grid>
+</Page>

Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DirectWriteTextBlock/DirectWriteTextBlockPage.xaml.cs

@@ -0,0 +1,32 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Runtime.InteropServices.WindowsRuntime;
+using Windows.Foundation;
+using Windows.Foundation.Collections;
+using Windows.UI.Xaml;
+using Windows.UI.Xaml.Controls;
+using Windows.UI.Xaml.Controls.Primitives;
+using Windows.UI.Xaml.Data;
+using Windows.UI.Xaml.Input;
+using Windows.UI.Xaml.Media;
+using Windows.UI.Xaml.Navigation;
+
+namespace Microsoft.Toolkit.Uwp.SampleApp.SamplePages
+{
+    /// <summary>
+    /// An empty page that can be used on its own or navigated to within a Frame.
+    /// </summary>
+    public sealed partial class DirectWriteTextBlockPage : Page
+    {
+        public DirectWriteTextBlockPage()
+        {
+            this.InitializeComponent();
+        }
+    }
+}

Microsoft.Toolkit.Uwp.SampleApp/SamplePages/samples.json

@@ -438,6 +438,17 @@
         "XamlCodeFile": "FocusTrackerXaml.bind",
         "Icon": "/SamplePages/FocusTracker/FocusTracker.png",
         "DocumentationUrl": "https://raw.githubusercontent.com/MicrosoftDocs/WindowsCommunityToolkitDocs/master/docs/developer-tools/FocusTracker.md"
+      },
+      {
+        "Name": "DirectWriteTextBlock",
+        "Type": "DirectWriteTextBlockPage",
+        "About": "DirectWriteTextBlock is a text block like class which generates an image using the DirectWrite API and displays it. Display vertically oriented text with it.",
+        "CodeUrl": "https://github.com/Microsoft/WindowsCommunityToolkit/tree/master/Microsoft.Toolkit.Uwp.UI.Controls.WinRT/DirectWriteTextBlock",
+        "XamlCodeFile": "DirectWriteTextBlockCode.bind",
+        "Icon": "/SamplePages/DirectWriteTextBlock/DirectWriteTextBlock.png",
+        "ApiCheck": "Windows.UI.Xaml.Controls.ColorPicker",
+        "BadgeUpdateVersionRequired": "April 2018 Update required",
+        "DocumentationUrl": "https://raw.githubusercontent.com/MicrosoftDocs/WindowsCommunityToolkitDocs/master/docs/controls/DirectWriteTextBlock.md"
       }
     ]
   },

Microsoft.Toolkit.Uwp.UI.Controls.WinRT/DirectWriteTextBlock/DirectWriteFontCollectionLoader.cpp

@@ -0,0 +1,108 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+#include "pch.h"
+#include <string>
+#include <sstream>
+#include <iostream>
+#include "DirectWriteFontFileEnumerator.h"
+#include "DirectWriteFontCollectionLoader.h"
+
+BEGIN_NAMESPACE_CONTROLS_WINRT
+
+winrt::com_ptr<IDWriteFontCollectionLoader> DirectWriteFontCollectionLoader::s_comInstance;
+
+DirectWriteFontCollectionLoader::DirectWriteFontCollectionLoader()
+{
+}
+
+DirectWriteFontCollectionLoader::~DirectWriteFontCollectionLoader()
+{
+}
+
+bool DirectWriteFontCollectionLoader::HasCustomFontFamily(Platform::String^ xamlFontFamily)
+{
+    // is there a .ttf in the path?
+    std::wstring wstringPath{ xamlFontFamily->Data() };
+    std::transform(wstringPath.begin(), wstringPath.end(), wstringPath.begin(), towlower);
+    auto foundCustomFontFile = wstringPath.find(L".ttf#", 0);
+    return foundCustomFontFile != std::wstring::npos;
+}
+
+void DirectWriteFontCollectionLoader::ParseXamlFontFamily(_In_ Platform::String^ xamlFontFamily, _Out_ DirectWriteUniversalPackageFontData& parsedFont)
+{
+    parsedFont = {};
+    std::wstring wstringPath{ xamlFontFamily->Data() };
+    auto delimLocation = wstringPath.find(L'#');
+    if (delimLocation != std::wstring::npos)
+    {
+        auto path = wstringPath.substr(0, delimLocation);
+        std::replace(path.begin(), path.end(), L'/', L'\\');
+        parsedFont.packageFontFilePath = path;
+        parsedFont.customFontName = wstringPath.substr(delimLocation + 1);
+    }
+}
+
+bool DirectWriteFontCollectionLoader::FindCachedEnumerator(Platform::String^ xamlFontFamily, winrt::com_ptr<IDWriteFontFileEnumerator>& enumerator)
+{
+    for (auto& entry : m_fontEnumerators)
+    {
+        if (entry.customFont->Equals(xamlFontFamily))
+        {
+            enumerator = entry.enumerator;
+            return true;
+        }
+    }
+
+    return false;
+}
+
+IFACEMETHODIMP DirectWriteFontCollectionLoader::CreateEnumeratorFromKey(_In_ IDWriteFactory* factory, void const* collectionKey, unsigned int collectionKeySize, _Outptr_ IDWriteFontFileEnumerator** fontFileEnumerator)
+try
+{
+    *fontFileEnumerator = nullptr;
+    auto xamlFontFamily = ref new Platform::String(reinterpret_cast<const wchar_t*>(collectionKey), collectionKeySize);
+
+    if (HasCustomFontFamily(xamlFontFamily))
+    {
+        winrt::com_ptr<IDWriteFontFileEnumerator> cachedEnumerator;
+        if (!FindCachedEnumerator(xamlFontFamily, cachedEnumerator))
+        {
+            auto enumerator{ winrt::make_self<DirectWriteFontFileEnumerator>() };
+            DirectWriteUniversalPackageFontData parseData = {};
+            ParseXamlFontFamily(xamlFontFamily, parseData);
+            winrt::check_hresult(enumerator->Initialize(factory, parseData));
+
+            FontEnumeratorEntry entry = {};
+            entry.customFont = xamlFontFamily;
+            entry.enumerator = enumerator;
+            m_fontEnumerators.push_back(std::move(entry));
+            cachedEnumerator = enumerator;
+        }
+
+        winrt::check_hresult(cachedEnumerator->QueryInterface(IID_PPV_ARGS(fontFileEnumerator)));
+    }
+    else
+    {
+        winrt::throw_hresult(E_INVALIDARG);
+    }
+
+    return S_OK;
+}
+catch (...)
+{
+    return winrt::to_hresult();
+}
+
+winrt::com_ptr<IDWriteFontCollectionLoader>& DirectWriteFontCollectionLoader::GetInstance()
+{
+    if (!s_comInstance)
+    {
+        s_comInstance = winrt::make<DirectWriteFontCollectionLoader>();
+    }
+
+    return s_comInstance;
+}
+
+END_NAMESPACE_CONTROLS_WINRT

Microsoft.Toolkit.Uwp.UI.Controls.WinRT/DirectWriteTextBlock/DirectWriteFontCollectionLoader.h

@@ -0,0 +1,61 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+#pragma once
+#include "DirectWriteUniversalPackageFontData.h"
+
+BEGIN_NAMESPACE_CONTROLS_WINRT
+
+/// <summary>
+/// This is just to glue together a custom font file in the Universal Windows app package
+/// to a custom DWrite Font. All it does is provide an enumerator that returns 1 font (the custom font)
+/// and doesn't support things like font fallbacks.
+/// </summary>
+struct DirectWriteFontCollectionLoader : winrt::implements<DirectWriteFontCollectionLoader, IDWriteFontCollectionLoader>
+{
+public:
+    DirectWriteFontCollectionLoader();
+    virtual ~DirectWriteFontCollectionLoader();
+
+    /// <summary>
+    /// Create the enumerator to the Universal Windows Application package.
+    /// </summary>
+    IFACEMETHOD(CreateEnumeratorFromKey)(
+        _In_ IDWriteFactory* factory,
+        void const* collectionKey,                      // XAML FontFamily Syntax (something.ttf)#font
+        unsigned int collectionKeySize,
+        _Outptr_ IDWriteFontFileEnumerator** fontFileEnumerator
+        );
+
+    /// <summary>
+    /// This sees if the incoming XAML FontFamily value has something that looks like
+    /// a custom font file like foo.ttf#bar
+    /// </summary>
+    static bool HasCustomFontFamily(Platform::String^ xamlFontFamily);
+
+    /// <summary>
+    /// This parses something that looks like /foo/bar.ttf#baz into the ttf path and the font name (baz).
+    /// </summary>
+    static void ParseXamlFontFamily(Platform::String^ xamlFontFamily, _Out_ DirectWriteUniversalPackageFontData& parsedFont);
+
+    /// <summary>
+    /// Get the singleton loader.
+    /// </summary>
+    static winrt::com_ptr<IDWriteFontCollectionLoader>& GetInstance();
+
+private:
+    struct FontEnumeratorEntry
+    {
+        Platform::String^ customFont;
+        winrt::com_ptr<IDWriteFontFileEnumerator> enumerator;
+    };
+
+    // enumerators are cached due to memory usages.
+    bool FindCachedEnumerator(Platform::String^ xamlFontFamily, winrt::com_ptr<IDWriteFontFileEnumerator>& enumerator);
+
+    std::vector<FontEnumeratorEntry> m_fontEnumerators;
+    static winrt::com_ptr<IDWriteFontCollectionLoader> s_comInstance;
+};
+
+END_NAMESPACE_CONTROLS_WINRT