C4FontLoader Class Reference

#include <C4FontLoader.h>

Collaboration diagram for C4FontLoader:

Public Types
enum	FontType {   C4FT_Log , C4FT_MainSmall , C4FT_Main , C4FT_Caption ,   C4FT_Title }

Public Member Functions
	C4FontLoader ()=default
	~C4FontLoader ()
void	Clear ()
bool	InitFont (CStdFont *Font, const char *szFontName, FontType eType, int32_t iSize, C4GroupSet *pGfxGroups, bool fDoShadow=true)

Protected Member Functions
CStdVectorFont *	CreateFont (StdBuf &Data)
CStdVectorFont *	CreateFont (const char *szFaceName)
void	DestroyFont (CStdVectorFont *pFont)

Protected Attributes
CStdVectorFont *	pLastUsedFont {nullptr}
StdCopyStrBuf	LastUsedName
int32_t	LastUsedGrpID {0}

Friends
class	CStdFont

Detailed Description

Definition at line 46 of file C4FontLoader.h.

Member Enumeration Documentation

FontType

enum C4FontLoader::FontType

Enumerator
C4FT_Log
C4FT_MainSmall
C4FT_Main
C4FT_Caption
C4FT_Title

Definition at line 50 of file C4FontLoader.h.

{ C4FT_Log, C4FT_MainSmall, C4FT_Main, C4FT_Caption, C4FT_Title };

Constructor & Destructor Documentation

C4FontLoader()

C4FontLoader::C4FontLoader ( )

default

~C4FontLoader()

C4FontLoader::~C4FontLoader ( )

inline

Definition at line 53 of file C4FontLoader.h.

{ Clear(); } // dtor

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4FontLoader::Clear

(

)

Definition at line 172 of file C4FontLoader.cpp.

{
#ifndef USE_CONSOLE
    // delete vector font cache
    DestroyFont(pLastUsedFont);
    pLastUsedFont = nullptr;
#endif
}

References DestroyFont(), and pLastUsedFont.

Referenced by C4Game::Clear(), and ~C4FontLoader().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateFont() [1/2]

CStdVectorFont * C4FontLoader::CreateFont ( const char *  szFaceName )

protected

Definition at line 259 of file C4FontLoader.cpp.

{
    return new CStdVectorFont(szFaceName);
}

CreateFont() [2/2]

CStdVectorFont * C4FontLoader::CreateFont ( StdBuf &  Data )

protected

Definition at line 263 of file C4FontLoader.cpp.

{
    return new CStdVectorFont(Data);
}

Referenced by InitFont().

Here is the caller graph for this function:

DestroyFont()

void C4FontLoader::DestroyFont ( CStdVectorFont *  pFont )

protected

Definition at line 267 of file C4FontLoader.cpp.

{
    if (!pFont) return;
    --(pFont->RefCnt);
    if (!pFont->RefCnt)
        delete pFont;
}

References CStdVectorFont::RefCnt.

Referenced by Clear(), CStdFont::Clear(), and InitFont().

Here is the caller graph for this function:

InitFont()

bool C4FontLoader::InitFont	(	CStdFont *	Font,
		const char *	szFontName,
		FontType	eType,
		int32_t	iSize,
		C4GroupSet *	pGfxGroups,
		bool	fDoShadow = true
	)

Definition at line 40 of file C4FontLoader.cpp.

{
#ifdef USE_CONSOLE
    return true;
#else
    // safety
    assert(szFontName);
    if (!szFontName || !*szFontName)
    {
        LogFatal(FormatString(R"(%s ("%s"))", LoadResStr("IDS_ERR_INITFONTS"), szFontName ? szFontName : "(null)").getData());
        return false;
    }
    // if def has not been found, use the def as font name
    // determine font def string
    const char *szFontString = szFontName;
    // font not assigned?
    assert(*szFontString);
    if (!*szFontString)
    {
        // invalid call or spec
        LogFatal(LoadResStr("IDS_ERR_INITFONTS")); return false;
    }
    // get font name
    char FontFaceName[C4MaxName+1], FontParam[C4MaxName+1];
    SCopyUntil(szFontString, FontFaceName, ',', C4MaxName);
    // is it an image file?
    int32_t iDefFontSize; DWORD dwDefWeight=FW_NORMAL;
    switch (eType)
    {
    case C4FT_Log:     iDefFontSize = iSize*12/14; break;
    case C4FT_MainSmall:iDefFontSize = iSize*13/14; break;
    case C4FT_Main:    iDefFontSize = iSize; break;
    case C4FT_Caption: iDefFontSize = iSize*16/14; break;
    case C4FT_Title:   iDefFontSize = iSize*22/14; break;
    default: assert(false); LogFatal(LoadResStr("IDS_ERR_INITFONTS")); return false; // invalid call
    }
    // regular font name: let WinGDI or Freetype draw a font with the given parameters
    // font size given?
    if (SCopySegment(szFontString, 1, FontParam, ',', C4MaxName))
        sscanf(FontParam, "%i", &iDefFontSize);
    // font weight given?
    if (SCopySegment(szFontString, 2, FontParam, ',', C4MaxName))
    {
        int iDefWeight;
        sscanf(FontParam, "%i", &iDefWeight);
        dwDefWeight = iDefWeight;
    }
    // check if it's already loaded from that group with that parameters
    if (rFont->IsSameAs(FontFaceName, iDefFontSize, dwDefWeight))
        return true;
    // it's not; so (re-)load it now!
    if (rFont->IsInitialized())
    {
        // reloading
        rFont->Clear();
        LogF(LoadResStr("IDS_PRC_UPDATEFONT"), FontFaceName, iDefFontSize, dwDefWeight);
    }
    // check if one of the internally listed fonts should be used
    const char * const extensions[] = { "ttf", "otf", "ttc", "fon", "fnt", "fot", nullptr };
    char FileName[_MAX_PATH_LEN];
    int32_t ID;
    C4Group * pGrp = pGfxGroups->FindSuitableFile(FontFaceName, extensions, FileName, &ID);
    if (pGrp)
    {
        if (LastUsedGrpID != ID || LastUsedName != FontFaceName)
        {
            DestroyFont(pLastUsedFont);
            pLastUsedFont = nullptr;
        }
        if (!pLastUsedFont)
        {
            StdBuf Data;
            if (pGrp->LoadEntry(FileName, &Data))
            {
                try
                {
                    pLastUsedFont = CreateFont(Data);
                    LastUsedGrpID = ID;
                    LastUsedName = FontFaceName;
                }
                catch (std::runtime_error & e)
                {
                    LogFatal(e.what());
                    pGrp = nullptr;
                }
            }
        }
    }
    // no internal font match? Then create one using the given face/filename (using a system font)
    if (!pGrp)
    {
        if (LastUsedGrpID != -1 || LastUsedName != FontFaceName)
        {
            DestroyFont(pLastUsedFont);
            pLastUsedFont = nullptr;
        }
        if (!pLastUsedFont)
        {
            try
            {
                pLastUsedFont = CreateFont(FontFaceName);
                if (!pLastUsedFont)
                    // no match for font face found
                    throw std::runtime_error(FormatString("Font face %s undefined", FontFaceName).getData());
                LastUsedGrpID = -1;
                LastUsedName = FontFaceName;
            }
            catch (std::runtime_error & e)
            {
                LogFatal(e.what());
            }
        }
    }
    if (!pLastUsedFont)
    {
        LogFatal(LoadResStr("IDS_ERR_INITFONTS"));
        return false;
    }
    try
    {
        rFont->Init(*pLastUsedFont, FontFaceName, iDefFontSize, dwDefWeight, fDoShadow); // throws exception on error
        return true;
    }
    catch (std::runtime_error & e)
    {
        LogFatal(e.what());
        LogFatal(LoadResStr("IDS_ERR_INITFONTS"));
        return false;
    }
#endif
}

References _MAX_PATH_LEN, C4FT_Caption, C4FT_Log, C4FT_Main, C4FT_MainSmall, C4FT_Title, C4MaxName, CStdFont::Clear(), CreateFont(), DestroyFont(), C4GroupSet::FindSuitableFile(), FormatString(), FW_NORMAL, CStdFont::Init(), CStdFont::IsInitialized(), iSize, CStdFont::IsSameAs(), LastUsedGrpID, LastUsedName, C4Group::LoadEntry(), LoadResStr(), LogF(), LogFatal(), pLastUsedFont, SCopySegment(), and SCopyUntil().

Referenced by C4GraphicsResource::InitFonts(), C4StartupGraphics::InitFonts(), and C4Application::SetGameFont().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

CStdFont

friend class CStdFont

friend

Definition at line 69 of file C4FontLoader.h.

Member Data Documentation

LastUsedGrpID

int32_t C4FontLoader::LastUsedGrpID {0}

protected

Definition at line 64 of file C4FontLoader.h.

Referenced by InitFont().

LastUsedName

StdCopyStrBuf C4FontLoader::LastUsedName

protected

Definition at line 63 of file C4FontLoader.h.

Referenced by InitFont().

pLastUsedFont

CStdVectorFont* C4FontLoader::pLastUsedFont {nullptr}

protected

Definition at line 62 of file C4FontLoader.h.

Referenced by Clear(), and InitFont().

---

The documentation for this class was generated from the following files:

• C4FontLoader.h
• C4FontLoader.cpp