Skip to content

Commit

Permalink
New built-in plugin FontViewer
Browse files Browse the repository at this point in the history
  • Loading branch information
emako committed Dec 29, 2024
1 parent 9f74be0 commit ffecab9
Show file tree
Hide file tree
Showing 11 changed files with 671 additions and 3 deletions.
8 changes: 8 additions & 0 deletions QuickLook.Plugin/QuickLook.Plugin.FontViewer/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Ignore HTML files in Resources and subdirectories
Resources/**/*.html linguist-vendored

# Ignore CSS files in Resources and subdirectories
Resources/**/*.css linguist-vendored

# Ignore JS files in Resources and subdirectories
Resources/**/*.js linguist-vendored
51 changes: 51 additions & 0 deletions QuickLook.Plugin/QuickLook.Plugin.FontViewer/FreeTypeApi.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Copyright © 2024 QL-Win Contributors
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

using FreeTypeSharp;
using System;
using System.IO;
using System.Runtime.InteropServices;
using static FreeTypeSharp.FT;

namespace QuickLook.Plugin.FontViewer;

internal unsafe static class FreeTypeApi
{
static FreeTypeApi()
{
FreeTypeDllMap.LoadNativeLibrary();
}

public static string GetFontFamilyName(string path)
{
if (!File.Exists(path)) return null;

FT_LibraryRec_* lib;
FT_FaceRec_* face;
FT_Error error = FT_Init_FreeType(&lib);

error = FT_New_Face(lib, (byte*)Marshal.StringToHGlobalAnsi(path), IntPtr.Zero, &face);

if (error == FT_Error.FT_Err_Ok)
{
var familyName = Marshal.PtrToStringAnsi((nint)face->family_name);
return familyName;
}

return null;
}
}
71 changes: 71 additions & 0 deletions QuickLook.Plugin/QuickLook.Plugin.FontViewer/FreeTypeDllMap.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// Copyright © 2024 QL-Win Contributors
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

using System;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;

namespace QuickLook.Plugin.FontViewer;

/// <summary>
/// To implement a similar architecture detection logic in .NET Framework
/// https://github.com/ryancheung/FreeTypeSharp/blob/main/FreeTypeSharp/FT.DllMap.cs
/// </summary>
internal static class FreeTypeDllMap
{
public static void LoadNativeLibrary()
{
_ = ImportResolver();
}

private static nint ImportResolver()
{
string actualLibraryName = "freetype.dll";
string rootDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
string arch = (RuntimeInformation.OSArchitecture == Architecture.Arm64)
? "arm64"
: (Environment.Is64BitProcess ? "x64" : "x86");

var searchPaths = new[]
{
// This is where native libraries in our nupkg should end up
Path.Combine(rootDirectory, "runtimes", "win-" + arch, "native"),
Path.Combine(rootDirectory, "runtimes", "win-" + arch),
Path.Combine(rootDirectory, "win-" + arch),
Path.Combine(rootDirectory, arch),
Path.Combine(rootDirectory)
};

foreach (var searchPath in searchPaths)
{
SetDllDirectory(searchPath);
nint handle = LoadLibrary(Path.Combine(searchPath, actualLibraryName));

if (handle != IntPtr.Zero)
return handle;
}

return IntPtr.Zero;
}

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]
private static extern nint LoadLibrary(string lpFileName);

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]
private static extern bool SetDllDirectory(string lpPathName);
}
176 changes: 176 additions & 0 deletions QuickLook.Plugin/QuickLook.Plugin.FontViewer/Plugin.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
// Copyright © 2024 QL-Win Contributors
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

using QuickLook.Common.Helpers;
using QuickLook.Common.Plugin;
using QuickLook.Plugin.HtmlViewer;
using System;
using System.IO;
using System.IO.Packaging;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Windows;
using System.Windows.Resources;

namespace QuickLook.Plugin.FontViewer;

public class Plugin : IViewer
{
private static readonly string _resourcePath = Path.Combine(SettingHelper.LocalDataPath, "QuickLook.Plugin.FontViewer");

private WebpagePanel _panel;

public int Priority => int.MaxValue;

public void Init()
{
}

public bool CanHandle(string path)
{
// The `*.eot` and `*.svg` font types are not supported
return !Directory.Exists(path) && new string[] { ".ttf", ".otf", ".woff", ".woff2" }.Any(path.ToLower().EndsWith);
}

public void Prepare(string path, ContextObject context)
{
context.PreferredSize = new Size { Width = 1300, Height = 650 };
}

public void View(string path, ContextObject context)
{
_panel = new WebpagePanel();

if (OSThemeHelper.AppsUseDarkTheme())
{
// Invoke using reflection: WebView2.CreationProperties.AdditionalBrowserArguments
// This approach allows the library to avoid direct dependency on WebView2
if (typeof(WebpagePanel).GetField("_webView", BindingFlags.NonPublic | BindingFlags.Instance) is FieldInfo fieldInfo)
{
object webView2 = fieldInfo.GetValue(_panel);

if (webView2?.GetType().GetProperty("CreationProperties", BindingFlags.Public | BindingFlags.Instance) is PropertyInfo creationPropertiesProperty)
{
object creationProperties = creationPropertiesProperty.GetValue(webView2);

if (creationProperties?.GetType().GetProperty("AdditionalBrowserArguments", BindingFlags.Public | BindingFlags.Instance) is PropertyInfo additionalBrowserArgumentsProperty)
{
string additionalBrowserArguments = (additionalBrowserArgumentsProperty.GetValue(creationProperties) as string) ?? string.Empty;
additionalBrowserArgumentsProperty.SetValue(creationProperties, additionalBrowserArguments + " --enable-features=WebContentsForceDark");
}
}
}
}

context.ViewerContent = _panel;
context.Title = Path.GetFileName(path);

var html = GenerateFontHtml(path);
var htmlPath = Path.Combine(_resourcePath, "font2html.html");

if (!Directory.Exists(Path.GetDirectoryName(htmlPath)))
{
Directory.CreateDirectory(Path.GetDirectoryName(htmlPath));
}
File.WriteAllText(htmlPath, html);

_panel.FallbackPath = Path.GetDirectoryName(path);
_panel.NavigateToFile(htmlPath);

context.IsBusy = false;
}

private string GenerateFontHtml(string path)
{
string fontFamilyName = FreeTypeApi.GetFontFamilyName(path);
StreamResourceInfo info = Application.GetResourceStream(new Uri($"pack://application:,,,/QuickLook.Plugin.FontViewer;component/Resources/font2html.html"));
using Stream stream = info?.Stream;
using StreamReader streamReader = new(stream, Encoding.UTF8);
string html = streamReader.ReadToEnd();

// src: url('xxx.eot');
// src: url('xxx?#iefix') format('embedded-opentype'),
// url('xxx.woff') format('woff'),
// url('xxx.ttf') format('truetype'),
// url('xxx.svg#xxx') format('svg');
var fileName = Path.GetFileName(path);
var fileExt = Path.GetExtension(fileName);
static string GenerateRandomString(int length)
{
const string chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
Random random = new();
char[] result = new char[length];

for (int i = 0; i < length; i++)
{
result[i] = chars[random.Next(chars.Length)];
}

return new string(result);
}

string cssUrl = $"src: url('{fileName}'), url('{fileName.Substring(0, fileExt.Length)}?#{GenerateRandomString(5)}{fileExt}')"
+ Path.GetExtension(path)
switch
{
".eot" => " format('embedded-opentype');",
".woff" => " format('woff');",
".woff2" => " format('woff2');",
".ttf" => " format('truetype');",
".otf" => " format('opentype');",
_ => ";",
};

html = html.Replace("--font-family;", $"font-family: '{fontFamilyName}';")
.Replace("--font-url;", cssUrl)
.Replace("{{h1}}", fontFamilyName ?? fileName);

return html;
}

public void Cleanup()
{
GC.SuppressFinalize(this);
}
}

file static class ResourcesProvider
{
static ResourcesProvider()
{
if (!UriParser.IsKnownScheme("pack"))
{
_ = PackUriHelper.UriSchemePack;
}
}

public static bool TryGetStream(Uri uri, out Stream stream)
{
try
{
StreamResourceInfo info = Application.GetResourceStream(uri);
stream = info?.Stream;
return true;
}
catch
{
}
stream = null;
return false;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
// Copyright © 2024 QL-Win Contributors
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

using System.Reflection;
using System.Runtime.InteropServices;
using System.Windows;

// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("QuickLook.Plugin.FontViewer")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("pooi.moe")]
[assembly: AssemblyProduct("QuickLook.Plugin.FontViewer")]
[assembly: AssemblyCopyright("Copyright © QL-Win Contributors")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]

//In order to begin building localizable applications, set
//<UICulture>CultureYouAreCodingWith</UICulture> in your .csproj file
//inside a <PropertyGroup>. For example, if you are using US english
//in your source files, set the <UICulture> to en-US. Then uncomment
//the NeutralResourceLanguage attribute below. Update the "en-US" in
//the line below to match the UICulture setting in the project file.

//[assembly: NeutralResourcesLanguage("en-US", UltimateResourceFallbackLocation.Satellite)]

[assembly: ThemeInfo(
ResourceDictionaryLocation.None, //where theme specific resource dictionaries are located
//(used if a resource is not found in the page,
// or application resource dictionaries)
ResourceDictionaryLocation.SourceAssembly //where the generic resource dictionary is located
//(used if a resource is not found in the page,
// app, or any theme specific resource dictionaries)
)]

// Version information for an assembly consists of the following four values:
//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
Loading

0 comments on commit ffecab9

Please sign in to comment.