#include <cjkcode.h>

Include dependency graph for font.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	_TT_FONT_ENTRY

struct	_FONT_DATA

Macros
#define	INVALID_CP ((UINT)-1)

#define	CP_UTF8 65001

#define	CP_USA 437

#define	IsBoldFont(Weight) ((Weight) >= FW_SEMIBOLD) /* Sometimes, just > FW_MEDIUM */

#define	BOLD_MARK L'*'

#define	IsAdditionalTTFont(FaceName) (FindCachedTTFont((FaceName), INVALID_CP) != NULL)
	Verifies whether the given font is an additional console TrueType font. Wrapper macros around FindCachedTTFont().

#define	IsAdditionalTTFontCP(FaceName, CodePage) (FindCachedTTFont((FaceName), (CodePage)) != NULL)

Typedefs
typedef struct _TT_FONT_ENTRY	TT_FONT_ENTRY

typedef struct _TT_FONT_ENTRY *	PTT_FONT_ENTRY

typedef struct _FONT_DATA	FONT_DATA

typedef struct _FONT_DATA *	PFONT_DATA

Functions
BYTE	CodePageToCharSet (_In_ UINT CodePage)
	Retrieves the character set associated with a given code page.

HFONT	CreateConsoleFontEx (_In_ LONG Height, _In_opt_ LONG Width, _Inout_updates_z_(LF_FACESIZE) PWSTR FaceName, _In_ ULONG FontWeight, _In_ ULONG FontFamily, _In_ UINT CodePage, _In_ BOOL UseDefaultFallback, _Out_ PFONT_DATA FontData)
	Validates and creates a suitable console font based on the font characteristics given in input.

HFONT	CreateConsoleFont2 (_In_ LONG Height, _In_opt_ LONG Width, _Inout_ PCONSOLE_STATE_INFO ConsoleInfo)
	A wrapper for CreateConsoleFontEx().

HFONT	CreateConsoleFont (_Inout_ PCONSOLE_STATE_INFO ConsoleInfo)
	A wrapper for CreateConsoleFontEx().

	_Success_ (return) BOOL GetFontCellSize(_In_opt_ HDC hDC

BOOL	IsValidConsoleFont2 (_In_ PLOGFONTW lplf, _In_ PNEWTEXTMETRICW lpntm, _In_ DWORD FontType, _In_ UINT CodePage)
	Validates whether a given font can be supported in the console, under the specified code page.

BOOL	IsValidConsoleFont (_In_ PCWSTR FaceName, _In_ UINT CodePage)
	Validates whether a given font can be supported in the console, under the specified code page.

VOID	InitTTFontCache (VOID)
	Initializes the console TrueType font cache.

VOID	ClearTTFontCache (VOID)
	Clears the console TrueType font cache.

VOID	RefreshTTFontCache (VOID)
	Refreshes the console TrueType font cache, by clearing and re-initializing it.

PTT_FONT_ENTRY	FindCachedTTFont (_In_reads_or_z_opt_(LF_FACESIZE) PCWSTR FaceName, _In_ UINT CodePage)
	Searches for a font in the console TrueType font cache, with the specified code page.

Variables
_In_ HFONT	hFont

_In_ HFONT _Out_ PUINT	Height

_In_ HFONT _Out_ PUINT _Out_ PUINT	Width

Macro Definition Documentation

◆ BOLD_MARK

#define BOLD_MARK L'*'

Definition at line 33 of file font.h.

◆ CP_USA

#define CP_USA 437

Definition at line 19 of file font.h.

◆ CP_UTF8

#define CP_UTF8 65001

Definition at line 16 of file font.h.

◆ INVALID_CP

#define INVALID_CP ((UINT)-1)

Definition at line 13 of file font.h.

◆ IsAdditionalTTFont

#define IsAdditionalTTFont ( FaceName ) (FindCachedTTFont((FaceName), INVALID_CP) != NULL)

Verifies whether the given font is an additional console TrueType font. Wrapper macros around FindCachedTTFont().

Remarks: These macros are equivalents of the functions IsAvailableTTFont() and IsAvailableTTFontCP() in https://github.com/microsoft/terminal/blob/main/src/propsheet/dbcs.cpp

Definition at line 131 of file font.h.

◆ IsAdditionalTTFontCP

#define IsAdditionalTTFontCP	(	FaceName,
		CodePage
	)	(FindCachedTTFont((FaceName), (CodePage)) != NULL)

Definition at line 134 of file font.h.

◆ IsBoldFont

#define IsBoldFont ( Weight ) ((Weight) >= FW_SEMIBOLD) /* Sometimes, just > FW_MEDIUM */

Definition at line 23 of file font.h.

Typedef Documentation

◆ FONT_DATA

typedef struct _FONT_DATA FONT_DATA

◆ PFONT_DATA

typedef struct _FONT_DATA * PFONT_DATA

◆ PTT_FONT_ENTRY

typedef struct _TT_FONT_ENTRY * PTT_FONT_ENTRY

◆ TT_FONT_ENTRY

typedef struct _TT_FONT_ENTRY TT_FONT_ENTRY

Function Documentation

◆ _Success_()

_Success_ ( return )

◆ ClearTTFontCache()

VOID ClearTTFontCache ( VOID )

Clears the console TrueType font cache.

Returns: None.

Definition at line 1131 of file font.c.

{
    PSINGLE_LIST_ENTRY Entry;
    PTT_FONT_ENTRY FontEntry;
 
    while (TTFontCache.Next != NULL)
    {
        Entry = PopEntryList(&TTFontCache);
        FontEntry = CONTAINING_RECORD(Entry, TT_FONT_ENTRY, Entry);
        RtlFreeHeap(RtlGetProcessHeap(), 0, FontEntry);
    }
    TTFontCache.Next = NULL;
}

Referenced by InitApplet(), and RefreshTTFontCache().

◆ CodePageToCharSet()

BYTE CodePageToCharSet ( _In_ UINT CodePage )

Retrieves the character set associated with a given code page.

Parameters

[in] CodePage The code page to convert.

Returns: The character set corresponding to the code page, or DEFAULT_CHARSET.

Definition at line 51 of file font.c.

{
    CHARSETINFO CharInfo;
    if (TranslateCharsetInfo(UlongToPtr(CodePage), &CharInfo, TCI_SRCCODEPAGE))
        return (BYTE)CharInfo.ciCharset;
    else
        return DEFAULT_CHARSET;
}

Referenced by CON_API(), CreateConsoleFontWorker(), FindSuitableFont(), and IsValidConsoleFont().

◆ CreateConsoleFont()

HFONT CreateConsoleFont ( _Inout_ PCONSOLE_STATE_INFO ConsoleInfo )

A wrapper for CreateConsoleFontEx().

Parameters

[in,out] ConsoleInfo A pointer to console settings information, containing in particular (in input) the face name and characteristics of the font to create with the current console code page. In output, the font information gets updated. Note that a default fallback font is always being used in case neither the specified font nor any substitute font could be found and created for the specified code page.

Returns: A GDI handle to the created font, or NULL in case of failure.

See also: CreateConsoleFontEx(), CreateConsoleFont2()

Definition at line 653 of file font.c.

{
    /*
     * Format:
     * Width  = FontSize.X = LOWORD(FontSize);
     * Height = FontSize.Y = HIWORD(FontSize);
     */
    /* NOTE: FontSize is always in cell height/width units (pixels) */
    return CreateConsoleFont2((LONG)(ULONG)ConsoleInfo->FontSize.Y,
                              (LONG)(ULONG)ConsoleInfo->FontSize.X,
                              ConsoleInfo);
}

Referenced by RefreshFontPreview().

◆ CreateConsoleFont2()

HFONT CreateConsoleFont2	(	_In_ LONG	Height,
		_In_opt_ LONG	Width,
		_Inout_ PCONSOLE_STATE_INFO	ConsoleInfo
	)

A wrapper for CreateConsoleFontEx().

Parameters

[in]	Height	The font height in cell units (pixels).
	[in,opt]	Width The font width in cell units (pixels).
[in,out]	ConsoleInfo	A pointer to console settings information, containing in particular (in input) the face name and characteristics of the font to create with the current console code page. In output, the font information gets updated. Note that a default fallback font is always being used in case neither the specified font nor any substitute font could be found and created for the specified code page.

Returns: A GDI handle to the created font, or NULL in case of failure.

See also: CreateConsoleFontEx(), CreateConsoleFont()

Definition at line 609 of file font.c.

{
    FONT_DATA FontData;
    HFONT hFont;
 
    hFont = CreateConsoleFontEx(Height,
                                Width,
                                ConsoleInfo->FaceName,
                                ConsoleInfo->FontWeight,
                                ConsoleInfo->FontFamily,
                                ConsoleInfo->CodePage,
                                TRUE, // UseDefaultFallback
                                &FontData);
    if (hFont)
    {
        ConsoleInfo->FontWeight = FontData.Weight;
        ConsoleInfo->FontFamily = FontData.Family;
    }
 
    return hFont;
}

Referenced by CreateConsoleFont(), and FontSizeChange().

◆ CreateConsoleFontEx()

HFONT CreateConsoleFontEx	(	_In_ LONG	Height,
		_In_opt_ LONG	Width,
		_Inout_updates_z_(LF_FACESIZE) PWSTR	FaceName,
		_In_ ULONG	FontWeight,
		_In_ ULONG	FontFamily,
		_In_ UINT	CodePage,
		_In_ BOOL	UseDefaultFallback,
		_Out_ PFONT_DATA	FontData
	)

Validates and creates a suitable console font based on the font characteristics given in input.

Parameters

[in]	Height	The font height in cell units (pixels).
	[in,opt]	Width The font width in cell units (pixels).
[in,out]	FaceName	A pointer to a maximally LF_FACESIZE-sized buffer. In input: The buffer contains the face name of the font to try to create. In output: The buffer receives the face name of the font that has been created, in case of success. It may, or may not be, identical to the face name provided in input, in case a substitute font has been chosen.
[in]	FontWeight	The font weight.
[in]	FontFamily	The font family.
[in]	CodePage	The code page the font has to support.
[in]	UseDefaultFallback	Whether (TRUE) or not (FALSE) to use a default fallback font in case neither the specified font nor any substitute font could be found and created for the specified code page.
[out]	FontData	The face name and characteristics of the created font.

Returns: A GDI handle to the created font, or NULL in case of failure.

Remarks

does not support an internal font cache for now;
returns a font handle (and not a font index to the cache).

Definition at line 505 of file font.c.

{
    HFONT hFont;
 
    FontData->FaceName = FaceName;
    FontData->Weight = FontWeight;
    FontData->Family = FontFamily;
    /* NOTE: FontSize is always in cell height/width units (pixels) */
    FontData->Size.X = Width;
    FontData->Size.Y = Height;
    FontData->CharSet = 0; // CodePageToCharSet(CodePage);
 
    if (/* !FaceName || */ !*FaceName || wcscmp(FaceName, DEFAULT_TT_FONT_FACENAME) == 0)
    {
        /* We do not have an actual font face name yet and should find one.
         * Call FindSuitableFont() to determine the default font to use. */
    }
    else
    {
        hFont = CreateConsoleFontWorker(FontData, CodePage);
        if (hFont)
            return hFont;
 
        DBGFNT1("CreateConsoleFont('%S') failed - Try to find a suitable font...\n",
                FaceName);
    }
 
    /*
     * We could not create a font with the default settings.
     * Try to find a suitable font and retry.
     */
    if (!FindSuitableFont(FontData, CodePage))
    {
        /* We could not find any suitable font, fall back
         * to some default one if required to do so. */
        DBGFNT1("FindSuitableFont could not find anything - %s\n",
                UseDefaultFallback ? "Falling back to 'Terminal'"
                                   : "Bailing out");
 
        /* No fallback: no font! */
        if (!UseDefaultFallback)
            return NULL;
 
        //
        // FIXME: See also !*FaceName case in FindSuitableFont().
        //
        /* Use "Terminal" as the fallback */
        StringCchCopyW(FaceName, LF_FACESIZE, TERMINAL_FACENAME);
#if 0
        // FIXME: CJK font choose workaround: Don't choose Asian
        // charset font if there is no preferred font for CJK.
        if (IsCJKCodePage(CodePage))
            FontData->CharSet = ANSI_CHARSET;
#endif
        FontData->Family &= ~TMPF_TRUETYPE;
    }
    else
    {
        DBGFNT1("FindSuitableFont found: '%S', size (%d x %d)\n",
                FaceName, FontData->Size.X, FontData->Size.Y);
    }
 
    /* Retry creating the font */
    hFont = CreateConsoleFontWorker(FontData, CodePage);
    if (!hFont)
        DBGFNT1("CreateConsoleFont('%S') failed\n", FaceName);
 
    return hFont;
}

Referenced by CreateConsoleFont2(), and InitFonts().

◆ FindCachedTTFont()

PTT_FONT_ENTRY FindCachedTTFont	(	_In_reads_or_z_opt_(LF_FACESIZE) PCWSTR	FaceName,
		_In_ UINT	CodePage
	)

Searches for a font in the console TrueType font cache, with the specified code page.

Parameters

[in,opt] FaceName An optional pointer to a maximally LF_FACESIZE-sized buffer. The buffer contains the face name of the font to search for.

If FaceName != NULL, search for the named font that should match the provided code page (when CodePage != INVALID_CP).
If FaceName == NULL, search for a font with the provided code page. In this case, CodePage cannot be == INVALID_CP, otherwise the search fails.

Parameters

[in] CodePage The code page the font has to support, or INVALID_CP when searching a font by face name only.

Returns: A pointer to the cache entry for the font, or NULL if not found.

Definition at line 1183 of file font.c.

{
    PSINGLE_LIST_ENTRY Entry;
    PTT_FONT_ENTRY FontEntry;
 
    if (FaceName)
    {
        /* Search for the named font */
        for (Entry = TTFontCache.Next;
             Entry != NULL;
             Entry = Entry->Next)
        {
            FontEntry = CONTAINING_RECORD(Entry, TT_FONT_ENTRY, Entry);
 
            /* NOTE: The font face names are case-sensitive */
            if ((wcscmp(FontEntry->FaceName   , FaceName) == 0) ||
                (wcscmp(FontEntry->FaceNameAlt, FaceName) == 0))
            {
                /* Return the font if we don't search by code page, or when they match */
                if ((CodePage == INVALID_CP) || (CodePage == FontEntry->CodePage))
                {
                    return FontEntry;
                }
            }
        }
    }
    else if (CodePage != INVALID_CP)
    {
        /* Search for a font with the specified code page */
        for (Entry = TTFontCache.Next;
             Entry != NULL;
             Entry = Entry->Next)
        {
            FontEntry = CONTAINING_RECORD(Entry, TT_FONT_ENTRY, Entry);
 
            /* Return the font if the code pages match */
            if (CodePage == FontEntry->CodePage)
                return FontEntry;
        }
    }
 
    return NULL;
}

Referenced by FindSuitableFont().

◆ InitTTFontCache()

VOID InitTTFontCache ( VOID )

Initializes the console TrueType font cache.

Remarks: To install additional TrueType fonts to be available for the console, add entries of type REG_SZ named "0", "00" etc... in: HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\Console\TrueTypeFont The names of the fonts listed there should match those in: HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\Fonts

Returns: None.

Definition at line 1013 of file font.c.

{
    LRESULT lResult;
    HKEY hKey;
    DWORD dwIndex, dwType;
    WCHAR szValueName[MAX_PATH];
    DWORD cchValueName;
    WCHAR szValue[LF_FACESIZE] = L"";
    DWORD cbValue;
    UINT CodePage;
    PTT_FONT_ENTRY FontEntry;
    PWCHAR pszNext;
 
    if (TTFontCache.Next != NULL)
        return;
    // TTFontCache.Next = NULL;
 
    /* Open the Console\TrueTypeFont key */
    // "\\Registry\\Machine\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont"
    if (RegOpenKeyExW(HKEY_LOCAL_MACHINE,
                      L"Software\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont",
                      0,
                      KEY_QUERY_VALUE,
                      &hKey) != ERROR_SUCCESS)
    {
        return;
    }
 
    /* Enumerate all the available TrueType console fonts */
    for (dwIndex = 0, cchValueName = ARRAYSIZE(szValueName),
                      cbValue = sizeof(szValue);
         (lResult = RegEnumValueW(hKey, dwIndex,
                                  szValueName, &cchValueName,
                                  NULL, &dwType,
                                  (PBYTE)szValue, &cbValue)) != ERROR_NO_MORE_ITEMS;
         ++dwIndex, cchValueName = ARRAYSIZE(szValueName),
                    cbValue = sizeof(szValue))
    {
        /* Ignore if we failed for another reason, e.g. because
         * the value name is too long (and thus, invalid). */
        if (lResult != ERROR_SUCCESS)
            continue;
 
        /* Validate the value name (exclude the unnamed value) */
        if (!cchValueName || (*szValueName == UNICODE_NULL))
            continue;
        /* Too large value names have already been handled with ERROR_MORE_DATA */
        ASSERT((cchValueName < ARRAYSIZE(szValueName)) &&
               (szValueName[cchValueName] == UNICODE_NULL));
 
        /* Only (multi-)string values are supported */
        if ((dwType != REG_SZ) && (dwType != REG_MULTI_SZ))
            continue;
 
        /* The value name is a code page (in decimal), validate it */
        CodePage = wcstoul(szValueName, &pszNext, 10);
        if (*pszNext)
            continue; // Non-numerical garbage followed...
        // IsValidCodePage(CodePage);
 
        FontEntry = RtlAllocateHeap(RtlGetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*FontEntry));
        if (!FontEntry)
        {
            DBGFNT1("InitTTFontCache: Failed to allocate memory, continuing...\n");
            continue;
        }
 
        FontEntry->CodePage = CodePage;
 
        pszNext = szValue;
 
        /* Check whether bold is disabled for this font */
        if (*pszNext == BOLD_MARK)
        {
            FontEntry->DisableBold = TRUE;
            ++pszNext;
        }
        else
        {
            FontEntry->DisableBold = FALSE;
        }
 
        /* Copy the font name */
        StringCchCopyNW(FontEntry->FaceName, ARRAYSIZE(FontEntry->FaceName),
                        pszNext, wcslen(pszNext));
 
        if (dwType == REG_MULTI_SZ)
        {
            /* There may be an alternate face name as the second string */
            pszNext += wcslen(pszNext) + 1;
 
            /* Check whether bold is disabled for this font */
            if (*pszNext == BOLD_MARK)
            {
                FontEntry->DisableBold = TRUE;
                ++pszNext;
            }
            // else, keep the original setting.
 
            /* Copy the alternate font name */
            StringCchCopyNW(FontEntry->FaceNameAlt, ARRAYSIZE(FontEntry->FaceNameAlt),
                            pszNext, wcslen(pszNext));
        }
 
        PushEntryList(&TTFontCache, &FontEntry->Entry);
    }
 
    /* Close the key and quit */
    RegCloseKey(hKey);
}

Referenced by GuiInit(), InitApplet(), and RefreshTTFontCache().

◆ IsValidConsoleFont()

BOOL IsValidConsoleFont	(	_In_ PCWSTR	FaceName,
		_In_ UINT	CodePage
	)

Validates whether a given font can be supported in the console, under the specified code page.

Parameters

[in]	FaceName	The face name of the font to validate.
[in]	CodePage	The code page the font has to support.

Returns: TRUE if the font is valid and supported in the console, FALSE if not.

See also: IsValidConsoleFont2()

Definition at line 974 of file font.c.

{
    IS_VALID_CONSOLE_FONT_PARAM Param;
    HDC hDC;
    LOGFONTW lf;
 
    Param.IsValidFont = FALSE;
    Param.CodePage = CodePage;
 
    RtlZeroMemory(&lf, sizeof(lf));
    lf.lfCharSet = CodePageToCharSet(CodePage);
    // lf.lfPitchAndFamily = FIXED_PITCH | FF_MODERN;
    StringCchCopyW(lf.lfFaceName, ARRAYSIZE(lf.lfFaceName), FaceName);
 
    hDC = GetDC(NULL);
    EnumFontFamiliesExW(hDC, &lf, (FONTENUMPROCW)IsValidConsoleFontProc, (LPARAM)&Param, 0);
    ReleaseDC(NULL, hDC);
 
    return Param.IsValidFont;
}

Referenced by CreateConsoleFontWorker().

◆ IsValidConsoleFont2()

BOOL IsValidConsoleFont2	(	_In_ PLOGFONTW	lplf,
		_In_ PNEWTEXTMETRICW	lpntm,
		_In_ DWORD	FontType,
		_In_ UINT	CodePage
	)

Validates whether a given font can be supported in the console, under the specified code page.

Parameters

[in]	lplf
[in]	lpntm
[in]	FontType	The GDI font characteristics of the font to validate.
[in]	CodePage	The code page the font has to support.

Returns: TRUE if the font is valid and supported in the console, FALSE if not.

Remarks: Equivalent of the font validation tests in FontEnumForV2Console() (or the more restrictive ones in FontEnum()) https://github.com/microsoft/terminal/blob/main/src/propsheet/misc.cpp#L465 https://github.com/microsoft/terminal/blob/main/src/propsheet/misc.cpp#L607

See also: IsValidConsoleFont()

Definition at line 782 of file font.c.

{
    LPCWSTR FaceName = lplf->lfFaceName;
 
    /*
     * According to: https://web.archive.org/web/20140901124501/http://support.microsoft.com/kb/247815
     * "Necessary criteria for fonts to be available in a command window",
     * the criteria for console-eligible fonts are as follows:
     * - The font must be a fixed-pitch font.
     * - The font cannot be an italic font.
     * - The font cannot have a negative A or C space.
     * - If it is a TrueType font, it must be FF_MODERN.
     * - If it is not a TrueType font, it must be OEM_CHARSET.
     *
     * Non documented: vertical fonts are forbidden (their name start with a '@').
     *
     * Additional criteria for Asian installations:
     * - If it is not a TrueType font, the face name must be "Terminal".
     * - If it is an Asian TrueType font, it must also be an Asian character set.
     *
     * See also Raymond Chen's blog: https://devblogs.microsoft.com/oldnewthing/?p=26843
     * and MIT-licensed Microsoft Terminal source code: https://github.com/microsoft/terminal/blob/main/src/propsheet/misc.cpp
     * for other details.
     *
     * To install additional TrueType fonts to be available for the console,
     * add entries of type REG_SZ named "0", "00" etc... in:
     * HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\Console\TrueTypeFont
     * The names of the fonts listed there should match those in:
     * HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\Fonts
     */
 
    /*
     * In ReactOS we relax some of the criteria:
     * - We allow fixed-pitch FF_MODERN (Monospace) TrueType fonts
     *   that can be italic or have negative A or C space.
     * - If it is not a TrueType font, it can be from another character set
     *   than OEM_CHARSET. When an Asian codepage is active however, we require
     *   that this non-TrueType font has an Asian character set.
     */
 
    /* Reject variable-width fonts ... */
    if ( ( ((lplf->lfPitchAndFamily & 0x03) != FIXED_PITCH)
#if 0 /* Reject italic and TrueType fonts with negative A or C space ... */
           || (lplf->lfItalic)
           || !(lpntm->ntmFlags & NTM_NONNEGATIVE_AC)
#endif
         ) &&
        /* ... if they are not in the list of additional TrueType fonts to include */
         !IsAdditionalTTFont(FaceName) )
    {
        DBGFNT("Font '%S' rejected because it%s (lfPitchAndFamily = %d)\n",
               FaceName,
               !(lplf->lfPitchAndFamily & FIXED_PITCH) ? "'s not FIXED_PITCH"
                   : (!(lpntm->ntmFlags & NTM_NONNEGATIVE_AC) ? " has negative A or C space"
                                                              : " is broken"),
               lplf->lfPitchAndFamily);
        return FALSE;
    }
 
    /* Reject TrueType fonts that are not FF_MODERN */
    if ((FontType == TRUETYPE_FONTTYPE) && ((lplf->lfPitchAndFamily & 0xF0) != FF_MODERN))
    {
        DBGFNT("TrueType font '%S' rejected because it's not FF_MODERN (lfPitchAndFamily = %d)\n",
               FaceName, lplf->lfPitchAndFamily);
        return FALSE;
    }
 
    /* Reject vertical fonts (tategaki) */
    if (FaceName[0] == L'@')
    {
        DBGFNT("Font '%S' rejected because it's vertical\n", FaceName);
        return FALSE;
    }
 
    /* Is the current code page Chinese, Japanese or Korean? */
    if (IsCJKCodePage(CodePage))
    {
        /* It's CJK */
 
        if (FontType == TRUETYPE_FONTTYPE)
        {
            /*
             * Here we are inclusive and check for any CJK character set,
             * instead of looking just at the current one via CodePageToCharSet().
             */
            if (!IsCJKCharSet(lplf->lfCharSet))
            {
                DBGFNT("TrueType font '%S' rejected because it's not Asian charset (lfCharSet = %d)\n",
                       FaceName, lplf->lfCharSet);
                return FALSE;
            }
 
            /*
             * If this is a cached TrueType font that is used only for certain
             * code pages, verify that the charset it claims is the correct one.
             *
             * Since there may be multiple entries for a cached TrueType font,
             * a general one (code page == 0) and one or more for explicit
             * code pages, we need to perform two search queries instead of
             * just one and retrieving the code page for this entry.
             */
            if (IsAdditionalTTFont(FaceName) && !IsAdditionalTTFontCP(FaceName, 0) &&
                !IsCJKCharSet(lplf->lfCharSet))
            {
                DBGFNT("Cached TrueType font '%S' rejected because it claims a code page that is not Asian charset (lfCharSet = %d)\n",
                       FaceName, lplf->lfCharSet);
                return FALSE;
            }
        }
        else
        {
            /* Reject non-TrueType fonts that do not have an Asian character set */
            if (!IsCJKCharSet(lplf->lfCharSet) && (lplf->lfCharSet != OEM_CHARSET))
            {
                DBGFNT("Non-TrueType font '%S' rejected because it's not Asian charset or OEM_CHARSET (lfCharSet = %d)\n",
                       FaceName, lplf->lfCharSet);
                return FALSE;
            }
 
            /* Reject non-TrueType fonts that are not Terminal */
            if (wcscmp(FaceName, TERMINAL_FACENAME) != 0)
            {
                DBGFNT("Non-TrueType font '%S' rejected because it's not 'Terminal'\n", FaceName);
                return FALSE;
            }
        }
    }
    else
    {
        /* Not CJK */
 
        /* Reject non-TrueType fonts that are not OEM or similar */
        if ((FontType != TRUETYPE_FONTTYPE) &&
            (lplf->lfCharSet != ANSI_CHARSET) &&
            (lplf->lfCharSet != DEFAULT_CHARSET) &&
            (lplf->lfCharSet != OEM_CHARSET))
        {
            DBGFNT("Non-TrueType font '%S' rejected because it's not ANSI_CHARSET or DEFAULT_CHARSET or OEM_CHARSET (lfCharSet = %d)\n",
                   FaceName, lplf->lfCharSet);
            return FALSE;
        }
    }
 
    /* All good */
    return TRUE;
}

Referenced by EnumFaceNamesProc(), FindSuitableFontProc(), and IsValidConsoleFontProc().

◆ RefreshTTFontCache()

VOID RefreshTTFontCache ( VOID )

Refreshes the console TrueType font cache, by clearing and re-initializing it.

Returns: None.

Definition at line 1153 of file font.c.

{
    ClearTTFontCache();
    InitTTFontCache();
}

Referenced by GuiApplyUserSettings().

Variable Documentation

◆ Height

_In_ HFONT _Out_ PUINT Height

Definition at line 88 of file font.h.

Referenced by _Success_(), BaseControlVideoImpl_SetDestinationPosition(), BaseControlVideoImpl_SetSourcePosition(), BaseControlWindowImpl_put_Height(), BaseControlWindowImpl_SetWindowPosition(), BaseWindowImpl_OnSize(), BasicVideo_SetDestinationPosition(), BasicVideo_SetSourcePosition(), BitBlt(), BlDisplayValidOemBitmap(), cdtInit(), ChangeView(), co_IntShowDesktop(), ConioCopyRegion(), ConsolepClearBuffer(), ConvertBmpToGopBlt(), ConWndProc(), CreateBitmap(), CreateCompatibleBitmap(), CreateConsoleFont2(), CreateConsoleFontEx(), CreateD3D9MipMap(), CreateDIBitmap(), CreateDiscardableBitmap(), CreatePopupWindow(), DECLARE_INTERFACE_(), DIB_1BPP_BitBltSrcCopy_From1BPP(), DisplayCharacter(), draw_diag_edge(), DrawBox(), DrawClassicFrame(), DrawPartitionList(), FromMouseCoordinates(), GdipAddPathRectangles(), GdipAddPathRectanglesI(), GdipDrawRectanglesI(), GdipFillRectanglesI(), CAppScrnshotPreview::GetRequestedWidth(), GuiGetLargestConsoleWindowSize(), HistoryDisplayCurrentHistory(), IDirect3DDevice9Base_CreateTexture(), InbvBufferToScreenBlt(), InbvScreenToBufferBlt(), InitGL(), InitImageList(), InitMetrics(), IntCreateCompatibleBitmap(), IntDrawArc(), IntDrawDiagEdge(), IntDrawEllipse(), IntEngFillBox(), InternetExplorer_put_Height(), IntFillArc(), IntFillEllipse(), IntFillRect(), IntGdiCreateMaskFromRLE(), IntPatBlt(), LISTVIEW_Size(), LlbFwVideoGetDisplaySize(), CGridView::MapWndProc(), MediaDet_GetBitmapBits(), MediaDet_WriteBitmapBits(), MENU_DrawMenuItem(), metafile_deserialize_image(), METAFILE_FillRectangles(), MiniTuiDrawProgressBarCenter(), MyMakeSquareRect(), NC_DrawFrame(), NtGdiBitBlt(), NtGdiCreateCompatibleBitmap(), NtGdiRoundRect(), NtGdiSetBitmapDimension(), NtGdiSetDIBitsToDeviceInternal(), CDeviceManager::OnCommand(), Pc98VideoGetDisplaySize(), PcVideoGetDisplaySize(), PopupError(), PrintDiskData(), PrintEmptyLine(), PrintPartitionData(), ProcessDisplayRegistry(), CAppInfoDisplay::ResizeChildren(), ResizeControls(), ResizeConWnd(), ReSizeGLScene(), ResizeTextConsole(), RleBitBlt(), set_client_height(), SetDIBitsToDevice(), ShellUIHelper2_AddDesktopComponent(), test_D3DXCreateRenderToSurface(), test_excludeinfinite(), test_Get_Release_DC(), test_ID3DXRenderToSurface(), test_scans(), ToMouseCoordinates(), TuiCalcMenuBoxSize(), TuiDrawProgressBarCenter(), UefiConsPutChar(), UefiVideoGetDisplaySize(), UITOOLS95_DFC_ButtonCheckRadio(), UITOOLS_MakeSquareRect(), VgaConsoleCreateGraphicsScreen(), VgaWriteTextModeFont(), VidBufferToScreenBlt(), VideoRenderer_OnSize(), VideoWindow_put_Height(), VideoWindow_SetWindowPosition(), VidScreenToBufferBlt(), VMR9_OnSize(), WebBrowser_put_Height(), wWinMain(), XboxConsPutChar(), and XboxVideoGetDisplaySize().

◆ hFont

_In_ HFONT hFont

Definition at line 87 of file font.h.

Referenced by _Success_(), add_ruler_units(), AddCharToSelection(), AddDialogControl(), BUTTON_CalcLabelRect(), C1_SetData(), CB_Paint(), check_height_font_enumproc(), ChildWndProc(), COMBO_Font(), COMCTL32_GetFontMetrics(), create_tabcontrol(), CreateConsoleFont2(), CreateConsoleFontEx(), CreateFontset(), CreateLayoutIcon(), CreateMonospaceFont(), CreateTitleFont(), CreateTrayIcon(), CUIFToolbarMenuButton::CUIFToolbarMenuButton(), D3DXCreateTextTest(), dialog_get_sans_serif_height(), DlgProc(), DoEntry(), DoTestEntry(), DrawCaptionTempA(), DrawCaptionTempW(), DrawProc(), DrawThemeTextEx(), DumpFont(), EditTypeDlg_OnDrawItem(), EMFDRV_CreateFontIndirect(), EMFDRV_SelectFont(), EnumEnhMetaFile(), EnumMetaFile(), FillFontStyleComboList(), fnIMLangFontLink2_ReleaseFont(), fnIMLangFontLink_ReleaseFont(), font_height(), FontSizeChange(), ftGdiGetGlyphOutline(), ftGdiGetTextCharsetInfo(), GB_Paint(), get_font_height(), GetButtonHeight(), GetFontMetrics(), GetPhysicalFontHeight(), CTipbarThread::GetTextSize(), GetThemeTextExtent(), GetThemeTextMetrics(), HEADER_CreateDragImage(), HEADER_Refresh(), HEADER_SetFont(), HEXEDIT_WM_SETFONT(), HOTKEY_SetFont(), InatCreateIconBySize(), InitFonts(), InitInstance(), InternalSelectEx(), IPADDRESS_Create(), LISTVIEW_Command(), LISTVIEW_GetItemMetrics(), LISTVIEW_GetStringWidthT(), LISTVIEW_SaveTextMetrics(), LISTVIEW_SetFont(), LISTVIEW_ShowFocusRect(), LoadIniFile(), LrgCellWndProc(), MainFrameBase::MainFrameBase(), MainWndProc(), ME_DebugWrite(), MENU_DrawPopupGlyph(), MFDRV_CreateFontIndirect(), MonSelChangeFont(), MonSelGetMonitorFont(), MonSelPaintMonitor(), MonthCalChangeFont(), MyDrawCaptionTemp(), MyDrawFrameCaption(), MyDrawFrameScroll(), MyEnumFontFamExProc(), NOTEPAD_LoadSettingsFromRegistry(), NT5_DrawLogoffCaptionText(), NtGdiGetCharABCWidthsW(), NtGdiGetCharWidthW(), NtGdiGetFontData(), NtGdiGetFontUnicodeRanges(), NtGdiGetGlyphIndicesW(), NtGdiGetOutlineTextMetricsInternalW(), NtGdiGetTextFaceW(), NtUserDrawCaptionTemp(), NtUserDrawMenuBarTemp(), OB_Paint(), OnMeasureItem(), OSK_ChooseFont(), PB_Paint(), PlotCharacter(), PROGRESS_SetFont(), RealizeFontInit(), RefreshFontPreview(), RetChangeControlFont(), RosImageProc(), CACListView::SetFont(), ATL::CWindow::SetFont(), SetLrgFont(), CUIFMenu::SetMenuFont(), SetMessageFont(), SetupControls(), SoftModalMessageBox(), START_TEST(), STATIC_PaintTextfn(), SYSLINK_SetFont(), T1_GetTextMetric(), T1_SetData(), TAB_DrawItemInterior(), TAB_SetItemBounds(), test_bitmap_font_glyph_index(), test_combo_setfont(), test_combo_setitemheight(), Test_CreateFontA(), Test_CreateFontIndirectA(), Test_CreateFontIndirectExA(), Test_CreateFontIndirectExW(), Test_CreateFontIndirectW(), test_DrawTextCalcRect(), test_emf_ExtTextOut_on_path(), test_ExtTextOut(), Test_Font(), Test_FontSelectionEntry(), Test_GdiGetCharDimensions(), Test_GetTextFaceAliasW(), test_height(), test_MessageBoxFontTest(), test_mf_SaveDC(), test_SaveDC(), test_setfont(), ThemeDrawCaptionText(), TOOLBAR_SetFont(), TOOLTIPS_SetFont(), TreeListEditLabel(), TreeListProc(), TREEVIEW_Command(), TREEVIEW_SetFont(), UB_Paint(), UITOOLS95_DFC_ButtonCheckRadio(), UITOOLS95_DrawFrameCaption(), UITOOLS95_DrawFrameMenu(), UITOOLS95_DrawFrameScroll(), UpdateFontPreview(), UserDrawCaption(), UserDrawCaptionText(), and WndProc().

◆ Width

_In_ HFONT _Out_ PUINT _Out_ PUINT Width

Definition at line 89 of file font.h.

Referenced by _Success_(), AcpiHwReadPort(), AcpiHwWritePort(), AcpiOsReadMemory(), AcpiOsReadPciConfiguration(), AcpiOsReadPort(), AcpiOsWriteMemory(), AcpiOsWritePciConfiguration(), AcpiOsWritePort(), AcpiUtFormatNumber(), CAppsListView::AddColumn(), CDowloadingAppsListView::AddColumn(), BaseControlVideoImpl_SetDestinationPosition(), BaseControlVideoImpl_SetSourcePosition(), BaseControlWindowImpl_put_Width(), BaseControlWindowImpl_SetWindowPosition(), BaseWindowImpl_OnSize(), BasicVideo_SetDestinationPosition(), BasicVideo_SetSourcePosition(), BitBlt(), BlDisplayValidOemBitmap(), cdtInit(), ChangeView(), co_IntShowDesktop(), ConioCopyRegion(), ConsolepClearBuffer(), ConvertBmpToGopBlt(), ConWndProc(), copy_interlaced_pixels(), CreateBitmap(), CreateCompatibleBitmap(), CreateConsoleFont2(), CreateConsoleFontEx(), CreateD3D9MipMap(), CreateDIBitmap(), CreateDiscardableBitmap(), CreatePopupWindow(), DECLARE_INTERFACE_(), DIB_1BPP_BitBltSrcCopy_From1BPP(), draw_diag_edge(), DrawBox(), DrawClassicFrame(), DrawListEntries(), DrawPartitionList(), FromMouseCoordinates(), GdipAddPathRectangles(), GdipAddPathRectanglesI(), GdipDrawRectanglesI(), GdipFillRectanglesI(), GuiGetLargestConsoleWindowSize(), HardwareDlgResize(), HistoryDisplayCurrentHistory(), i386PrintText(), IDirect3DDevice9Base_CreateTexture(), InbvBufferToScreenBlt(), InbvScreenToBufferBlt(), InitGL(), InitImageList(), InitMetrics(), IntCreateCompatibleBitmap(), IntDrawArc(), IntDrawDiagEdge(), IntDrawEllipse(), IntEngEnter(), IntEngFillBox(), InternetExplorer_put_Width(), IntFillArc(), IntFillEllipse(), IntFillRect(), IntGdiCreateMaskFromRLE(), IntPatBlt(), LISTVIEW_Size(), LlbFwVideoGetDisplaySize(), CGridView::MapWndProc(), MediaDet_GetBitmapBits(), MediaDet_WriteBitmapBits(), METAFILE_FillRectangles(), MiniTuiDrawProgressBarCenter(), MirrorRgnByWidth(), MyMakeSquareRect(), NC_DrawFrame(), NtGdiBitBlt(), NtGdiCreateCompatibleBitmap(), NtGdiCreatePen(), NtGdiRoundRect(), NtGdiSetBitmapDimension(), NtGdiSetDIBitsToDeviceInternal(), Pc98VideoGetDisplaySize(), PcVideoGetDisplaySize(), PopupError(), PrintDiskData(), PrintEmptyLine(), PrintPartitionData(), ProcessDisplayRegistry(), CAppInfoDisplay::ResizeChildren(), ResizeControls(), ResizeConWnd(), ReSizeGLScene(), ResizeTextConsole(), RleBitBlt(), SetDIBitsToDevice(), ShellUIHelper2_AddDesktopComponent(), Defragment::Start(), test_D3DXCreateRenderToSurface(), test_excludeinfinite(), test_Get_Release_DC(), test_ID3DXRenderToSurface(), test_scans(), ToMouseCoordinates(), TuiCalcMenuBoxSize(), TuiDrawProgressBarCenter(), UefiConsPutChar(), UefiVideoGetDisplaySize(), UITOOLS95_DFC_ButtonCheckRadio(), UITOOLS_MakeSquareRect(), VgaConsoleCreateGraphicsScreen(), VidBufferToScreenBlt(), VideoRenderer_OnSize(), VideoWindow_put_Width(), VideoWindow_SetWindowPosition(), VidScreenToBufferBlt(), VMR9_OnSize(), vsnprintf(), WebBrowser_put_Width(), wWinMain(), XboxConsPutChar(), and XboxVideoGetDisplaySize().

Classes

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ BOLD_MARK

◆ CP_USA

◆ CP_UTF8

◆ INVALID_CP

◆ IsAdditionalTTFont

◆ IsAdditionalTTFontCP

◆ IsBoldFont

Typedef Documentation

◆ FONT_DATA

◆ PFONT_DATA

◆ PTT_FONT_ENTRY

◆ TT_FONT_ENTRY

Function Documentation

◆ _Success_()

◆ ClearTTFontCache()

◆ CodePageToCharSet()

◆ CreateConsoleFont()

◆ CreateConsoleFont2()

◆ CreateConsoleFontEx()

◆ FindCachedTTFont()

◆ InitTTFontCache()

◆ IsValidConsoleFont()

◆ IsValidConsoleFont2()

◆ RefreshTTFontCache()

Variable Documentation

◆ Height

◆ hFont

◆ Width