Font Class Reference

#include <font.h>

Public Member Functions
	Font (std::string filename, int size, const int style)
	~Font ()
void	loadFont (std::string filename, const int size, const int style)
int	getWidth (const std::string &text) const
int	getHeight () const
const TextChunkList *	getCache () const A_CONST
void	drawString (Graphics *const graphics, Color col, const Color &col2, const std::string &text, const int x, const int y)
void	clear ()
void	doClean ()
void	slowLogic (const int rnd)
unsigned int	getCreateCounter () const
unsigned int	getDeleteCounter () const
int	getStringIndexAt (const std::string &text, const int x) const
void	generate (TextChunk &chunk)
void	insertChunk (TextChunk *const chunk)

Static Public Attributes
static bool	mSoftMode

Static Private Member Functions
static TTF_Font *	openFont (const char *const name, const int size)

Private Attributes
TTF_Font *	mFont
unsigned int	mCreateCounter
unsigned int	mDeleteCounter
time_t	mCleanTime
TextChunkList	mCache [CACHES_NUMBER]

Detailed Description

A wrapper around SDL_ttf for allowing the use of TrueType fonts.

NOTE: This class initializes SDL_ttf as necessary.

Definition at line 89 of file font.h.

Constructor & Destructor Documentation

Font()

Font::Font	(	std::string	filename,
		int	size,
		const int	style
	)

Definition at line 106 of file font.cpp.

                            :
    mFont(nullptr),
    mCreateCounter(0),
    mDeleteCounter(0),
    mCleanTime(cur_time + CLEAN_TIME)
{
    if (fontCounter == 0)
    {
        mSoftMode = imageHelper->useOpenGL() == RENDER_SOFTWARE;
        if (TTF_Init() == -1)
        {
            logger->error("Unable to initialize SDL_ttf: " +
                std::string(SDL_GetError()));
        }
    }
 
    if (size < 4)
    {
        reportAlways("Error: requested load font %s with size %d",
            filename.c_str(),
            size)
        size = 4;
    }
 
    if (fontCounter == 0)
    {
        strBuf = new char[65535];
        memset(strBuf, 0, 65535);
    }
 
    ++fontCounter;
 
    fixDirSeparators(filename);
    logger->log("Attempt to load font: %s",
        filename.c_str());
    mFont = openFont(filename.c_str(), size);
 
    if (mFont == nullptr)
    {
        logger->log("Error normal loading font " + filename);
 
        filename = "fonts/dejavusans.ttf";
        mFont = openFont(fixDirSeparators(filename).c_str(), size);
        if (mFont == nullptr)
        {
#ifdef UNITTESTS
            reportAlways("Font load failed %s",
                filename.c_str())
#endif  // UNITTESTS
            logger->error("Font::Font: " +
                std::string(SDL_GetError()));
        }
        else
        {
            logger->log("Loaded fallback font %s, %d",
                filename.c_str(),
                size);
        }
    }
    else
    {
        logger->log("Loaded font %s, %d",
            filename.c_str(),
            size);
    }
 
    TTF_SetFontStyle(mFont, style);
}

References Logger::error(), fixDirSeparators(), fontCounter, imageHelper, Logger::log(), logger, mFont, mSoftMode, openFont(), RENDER_SOFTWARE, reportAlways, EmoteDB::size(), strBuf, and ImageHelper::useOpenGL().

~Font()

Font::~Font

(

)

Definition at line 177 of file font.cpp.

{
    TTF_CloseFont(mFont);
    mFont = nullptr;
    --fontCounter;
    clear();
 
    if (fontCounter == 0)
    {
        TTF_Quit();
        delete []strBuf;
    }
}

References clear(), fontCounter, mFont, and strBuf.

Member Function Documentation

clear()

void Font::clear

(

)

Definition at line 248 of file font.cpp.

{
    for (size_t f = 0; f < CACHES_NUMBER; f ++)
        mCache[f].clear();
}

References CACHES_NUMBER, and mCache.

Referenced by Gui::clearFonts(), loadFont(), and ~Font().

doClean()

void Font::doClean

(

)

Definition at line 367 of file font.cpp.

{
    for (unsigned int f = 0; f < CACHES_NUMBER; f ++)
    {
        TextChunkList *const cache = &mCache[f];
        const size_t size = CAST_SIZE(cache->size);
#ifdef DEBUG_FONT_COUNTERS
        logger->log("ptr: %u, size: %ld", f, size);
#endif  // DEBUG_FONT_COUNTERS
 
        if (size > CACHE_SIZE_SMALL3)
        {
#ifdef DEBUG_FONT_COUNTERS
            mDeleteCounter += 100;
#endif  // DEBUG_FONT_COUNTERS
 
            cache->removeBack(100);
#ifdef DEBUG_FONT_COUNTERS
            logger->log("delete3");
#endif  // DEBUG_FONT_COUNTERS
        }
        else if (size > CACHE_SIZE_SMALL2)
        {
#ifdef DEBUG_FONT_COUNTERS
            mDeleteCounter += 20;
#endif  // DEBUG_FONT_COUNTERS
 
            cache->removeBack(20);
#ifdef DEBUG_FONT_COUNTERS
            logger->log("delete2");
#endif  // DEBUG_FONT_COUNTERS
        }
        else if (size > CACHE_SIZE_SMALL1)
        {
#ifdef DEBUG_FONT_COUNTERS
            mDeleteCounter ++;
#endif  // DEBUG_FONT_COUNTERS
 
            cache->removeBack();
#ifdef DEBUG_FONT_COUNTERS
            logger->log("delete1");
#endif  // DEBUG_FONT_COUNTERS
        }
    }
}

References CACHE_SIZE_SMALL1, CACHE_SIZE_SMALL2, CACHE_SIZE_SMALL3, CACHES_NUMBER, CAST_SIZE, Logger::log(), logger, mCache, mDeleteCounter, TextChunkList::removeBack(), TextChunkList::size, and EmoteDB::size().

Referenced by slowLogic().

drawString()

void Font::drawString	(	Graphics *const	graphics,
		Color	col,
		const Color &	col2,
		const std::string &	text,
		const int	x,
		const int	y
	)

See also

Font::drawString

Definition at line 254 of file font.cpp.

{
    BLOCK_START("Font::drawString")
    if (text.empty())
    {
        BLOCK_END("Font::drawString")
        return;
    }
 
//    Color col = graphics->getColor();
//    const Color &col2 = graphics->getColor2();
    const float alpha = static_cast<float>(col.a) / 255.0F;
 
    /* The alpha value is ignored at string generation so avoid caching the
     * same text with different alpha values.
     */
    col.a = 255;
 
    const unsigned char chr = text[0];
    TextChunkList *const cache = &mCache[chr];
 
    std::map<TextChunkSmall, TextChunk*> &search = cache->search;
    std::map<TextChunkSmall, TextChunk*>::iterator i
        = search.find(TextChunkSmall(text, col, col2));
    if (i != search.end())
    {
        TextChunk *const chunk2 = (*i).second;
        cache->moveToFirst(chunk2);
        Image *const image = chunk2->img;
        if (image != nullptr)
        {
            image->setAlpha(alpha);
            graphics->drawImage(image, x, y);
        }
    }
    else
    {
        if (cache->size >= CACHE_SIZE)
        {
#ifdef DEBUG_FONT_COUNTERS
            mDeleteCounter ++;
#endif  // DEBUG_FONT_COUNTERS
 
            cache->removeBack();
        }
#ifdef DEBUG_FONT_COUNTERS
        mCreateCounter ++;
#endif  // DEBUG_FONT_COUNTERS
 
        TextChunk *chunk2 = new TextChunk(text, col, col2, this);
 
        chunk2->generate(mFont, alpha);
        cache->insertFirst(chunk2);
 
        const Image *const image = chunk2->img;
        if (image != nullptr)
            graphics->drawImage(image, x, y);
    }
    BLOCK_END("Font::drawString")
}

References Color::a, BLOCK_END, BLOCK_START, CACHE_SIZE, Graphics::drawImage(), TextChunk::generate(), TextChunk::img, TextChunkList::insertFirst(), mCache, mCreateCounter, mDeleteCounter, mFont, TextChunkList::moveToFirst(), TextChunkList::removeBack(), TextChunkList::search, TextChunkList::size, x, and y.

Referenced by Game::addWatermark(), Gui::draw(), BrowserBox::draw(), ColorPage::draw(), DropDown::draw(), ExtendedListBox::draw(), ItemContainer::draw(), ItemShortcutContainer::draw(), ListBox::draw(), ServersListBox::draw(), ShopListBox::draw(), SkillListBox::draw(), SkillRectangleListBox::draw(), SpellShortcutContainer::draw(), StaticBrowserBox::draw(), TextBox::draw(), TextPreview::draw(), VirtShortcutContainer::draw(), EquipmentWindow::draw(), FloorItem::draw(), MapItem::draw(), AvatarListBox::draw(), EmoteShortcutContainer::draw(), Viewport::drawPath(), Being::drawPortalSpriteAt(), TouchManager::drawText(), ItemContainer::safeDraw(), ItemShortcutContainer::safeDraw(), SpellShortcutContainer::safeDraw(), VirtShortcutContainer::safeDraw(), EquipmentWindow::safeDraw(), AvatarListBox::safeDraw(), EmoteShortcutContainer::safeDraw(), and TestLauncher::testDraw().

generate()

void Font::generate

(

TextChunk &

chunk

)

Definition at line 430 of file font.cpp.

{
    const std::string &text = chunk.text;
    if (text.empty())
        return;
 
    const unsigned char chr = text[0];
    TextChunkList *const cache = &mCache[chr];
    Color &col = chunk.color;
    Color &col2 = chunk.color2;
    const int oldAlpha = col.a;
    col.a = 255;
 
    TextChunkSmall key(text, col, col2);
    std::map<TextChunkSmall, TextChunk*> &search = cache->search;
    std::map<TextChunkSmall, TextChunk*>::iterator i = search.find(key);
    if (i != search.end())
    {
        TextChunk *const chunk2 = (*i).second;
        cache->moveToFirst(chunk2);
//        search.erase(key);
        cache->remove(chunk2);
        chunk.img = chunk2->img;
        chunk2->img = nullptr;
        delete chunk2;
//        logger->log("cached image: " + chunk.text);
    }
    else
    {
        if (cache->size >= CACHE_SIZE)
        {
#ifdef DEBUG_FONT_COUNTERS
            mDeleteCounter ++;
#endif  // DEBUG_FONT_COUNTERS
 
            cache->removeBack();
        }
#ifdef DEBUG_FONT_COUNTERS
        mCreateCounter ++;
#endif  // DEBUG_FONT_COUNTERS
 
        const float alpha = static_cast<float>(chunk.color.a) / 255.0F;
        chunk.generate(mFont, alpha);
//        logger->log("generate image: " + chunk.text);
    }
    col.a = oldAlpha;
}

References Color::a, CACHE_SIZE, TextChunk::color, TextChunk::color2, TextChunk::generate(), TextChunk::img, mCache, mCreateCounter, mDeleteCounter, mFont, TextChunkList::moveToFirst(), TextChunkList::remove(), TextChunkList::removeBack(), TextChunkList::search, TextChunkList::size, and TextChunk::text.

Referenced by Button::draw(), CheckBox::draw(), Label::draw(), ProgressBar::draw(), RadioButton::draw(), TextField::draw(), Window::draw(), Text::draw(), Button::safeDraw(), ProgressBar::safeDraw(), and Window::safeDraw().

getCache()

const TextChunkList * Font::getCache

(

)

const

Definition at line 425 of file font.cpp.

{
    return mCache;
}

References mCache.

getCreateCounter()

unsigned int Font::getCreateCounter ( ) const

inline

Definition at line 127 of file font.h.

        { return mCreateCounter; }

References mCreateCounter.

getDeleteCounter()

unsigned int Font::getDeleteCounter ( ) const

inline

Definition at line 130 of file font.h.

        { return mDeleteCounter; }

References mDeleteCounter.

getHeight()

int Font::getHeight

(

)

const

Definition at line 362 of file font.cpp.

{
    return TTF_FontHeight(mFont);
}

References mFont.

Referenced by BrowserBox::addRow(), StaticBrowserBox::addRow(), Button::adjustSize(), Label::adjustSize(), RadioButton::adjustSize(), TextBox::adjustSize(), BrowserBox::calcHeight(), ColorPage::ColorPage(), Button::draw(), ExtendedListBox::draw(), Label::draw(), ProgressBar::draw(), ServersListBox::draw(), ShopListBox::draw(), SkillListBox::draw(), TextBox::draw(), TextPreview::draw(), EquipmentWindow::draw(), AvatarListBox::draw(), TouchManager::drawText(), ServersListBox::getRowHeight(), ItemPopup::ItemPopup(), TextBox::keyPressed(), Label::Label(), ListBox::ListBox(), AvatarListBox::mousePressed(), SkillRectangleListBox::mousePressed(), TextBox::mousePressed(), NpcDialog::NpcDialog(), StatusPopup::postInit(), TextBoxPopup::postInit(), TextPopup::postInit(), ConfirmDialog::postInit(), QuestsWindow::QuestsWindow(), Label::resizeTo(), Button::safeDraw(), ProgressBar::safeDraw(), EquipmentWindow::safeDraw(), AvatarListBox::safeDraw(), TextBox::scrollToCaret(), ItemPopup::setItem(), ShopListBox::ShopListBox(), BeingPopup::show(), SkillPopup::show(), SkillListBox::SkillListBox(), SkillPopup::SkillPopup(), SkillRectangleListBox::SkillRectangleListBox(), StaticBrowserBox::updateHeight(), and Window::Window().

getStringIndexAt()

int Font::getStringIndexAt	(	const std::string &	text,
		const int	x
	)		const

Definition at line 413 of file font.cpp.

{
    const size_t sz = text.size();
    for (size_t i = 0; i < sz; ++i)
    {
        if (getWidth(text.substr(0, i)) > x)
            return CAST_S32(i);
    }
 
    return CAST_S32(sz);
}

References CAST_S32, getWidth(), and x.

Referenced by TextBox::mousePressed(), and TextField::mousePressed().

getWidth()

int Font::getWidth

(

const std::string &

text

)

const

Definition at line 334 of file font.cpp.

{
    if (text.empty())
        return 0;
 
    const unsigned char chr = text[0];
    TextChunkList *const cache = &mCache[chr];
 
    std::map<std::string, TextChunk*> &search = cache->searchWidth;
    std::map<std::string, TextChunk*>::iterator i = search.find(text);
    if (i != search.end())
    {
        TextChunk *const chunk = (*i).second;
        cache->moveToFirst(chunk);
        const Image *const image = chunk->img;
        if (image != nullptr)
            return image->getWidth();
        return 0;
    }
 
    // if string was not drawed
    int w;
    int h;
    getSafeUtf8String(text, strBuf);
    TTF_SizeUTF8(mFont, strBuf, &w, &h);
    return w;
}

References getSafeUtf8String(), TextChunk::img, mCache, mFont, TextChunkList::moveToFirst(), TextChunkList::searchWidth, and strBuf.

Referenced by BrowserBox::addRow(), StaticBrowserBox::addRow(), Button::adjustSize(), Label::adjustSize(), RadioButton::adjustSize(), TextBox::adjustSize(), BrowserBox::calcHeight(), Gui::draw(), Button::draw(), ColorPage::draw(), ExtendedListBox::draw(), ItemContainer::draw(), ItemShortcutContainer::draw(), Label::draw(), ListBox::draw(), ProgressBar::draw(), ServersListBox::draw(), SkillListBox::draw(), SkillRectangleListBox::draw(), TextBox::draw(), TextField::draw(), TextPreview::draw(), VirtShortcutContainer::draw(), Window::draw(), EquipmentWindow::draw(), Viewport::drawPath(), TouchManager::drawText(), TextField::fixScroll(), SliderList::getMaxLabelWidth(), SetupItemSlider2::getMaxWidth(), getStringIndexAt(), InventoryWindow::InventoryWindow(), Label::Label(), ServerDialog::loadServers(), NpcDialog::NpcDialog(), OkDialog::OkDialog(), PincodeDialog::PincodeDialog(), ConfirmDialog::postInit(), Label::resizeTo(), Button::safeDraw(), ItemContainer::safeDraw(), ItemShortcutContainer::safeDraw(), ProgressBar::safeDraw(), VirtShortcutContainer::safeDraw(), Window::safeDraw(), EquipmentWindow::safeDraw(), TextBox::scrollToCaret(), TextBox::setTextWrapped(), Setup_Colors::Setup_Colors(), ServersListModel::setVersionString(), SkillRectangleListBox::SkillRectangleListBox(), TextDialog::TextDialog(), TradeWindow::TradeWindow(), and StaticBrowserBox::updateHeight().

insertChunk()

void Font::insertChunk

(

TextChunk *const

chunk

)

Definition at line 478 of file font.cpp.

{
    if ((chunk == nullptr) || chunk->text.empty() || (chunk->img == nullptr))
        return;
//    logger->log("insert chunk: text=%s, color: %d,%d,%d",
//        chunk->text.c_str(), chunk->color.r, chunk->color.g, chunk->color.b);
    const unsigned char chr = chunk->text[0];
    TextChunkList *const cache = &mCache[chr];
 
    std::map<TextChunkSmall, TextChunk*> &search = cache->search;
    std::map<TextChunkSmall, TextChunk*>::iterator i
        = search.find(TextChunkSmall(chunk->text,
        chunk->color, chunk->color2));
    if (i != search.end())
    {
        delete2(chunk->img)
        return;
    }
 
    TextChunk *const chunk2 = new TextChunk(chunk->text,
        chunk->color, chunk->color2, chunk->textFont);
    chunk2->img = chunk->img;
    cache->insertFirst(chunk2);
}

References TextChunk::color, TextChunk::color2, delete2, TextChunk::img, TextChunkList::insertFirst(), mCache, TextChunkList::search, TextChunk::text, and TextChunk::textFont.

Referenced by TextChunk::deleteImage().

loadFont()

void Font::loadFont	(	std::string	filename,
		const int	size,
		const int	style
	)

Definition at line 219 of file font.cpp.

{
    if (fontCounter == 0 && TTF_Init() == -1)
    {
        logger->log("Unable to initialize SDL_ttf: " +
                    std::string(SDL_GetError()));
        return;
    }
 
    fixDirSeparators(filename);
    TTF_Font *const font = openFont(filename.c_str(), size);
 
    if (font == nullptr)
    {
        logger->log("Font::Font: " +
                    std::string(SDL_GetError()));
        return;
    }
 
    if (mFont != nullptr)
        TTF_CloseFont(mFont);
 
    mFont = font;
    TTF_SetFontStyle(mFont, style);
    clear();
}

References clear(), fixDirSeparators(), fontCounter, Logger::log(), logger, mFont, openFont(), and EmoteDB::size().

Referenced by Gui::updateFonts().

openFont()

TTF_Font * Font::openFont ( const char *const  name, const int  size  )

staticprivate

Definition at line 191 of file font.cpp.

{
#ifdef USE_SDL2
    SDL_RWops *const rw = VirtFs::rwopsOpenRead(name);
    if (rw)
    {
        logger->log("Loading virtfs font file: %s",
            name);
        return TTF_OpenFontIndexRW(rw, 1, size, 0);
    }
#endif
    const std::string path = VirtFs::getPath(name);
    if (Files::existsLocal(path) == false)
    {
#ifndef UNITTESTS
        // +++ in future need trigger assert in unit tests here too
        reportAlways("Font::openFont font not exists: %s",
            path.c_str())
#endif  // UNITTESTS
        return nullptr;
    }
    logger->log("Loading physical font file: %s",
        path.c_str());
    return TTF_OpenFontIndex(path.c_str(),
        size, 0);
}

References Files::existsLocal(), VirtFs::getPath(), Logger::log(), logger, reportAlways, VirtFs::rwopsOpenRead(), and EmoteDB::size().

Referenced by Font(), and loadFont().

slowLogic()

void Font::slowLogic

(

const int

rnd

)

Definition at line 319 of file font.cpp.

{
    BLOCK_START("Font::slowLogic")
    if (mCleanTime == 0)
    {
        mCleanTime = cur_time + CLEAN_TIME + rnd;
    }
    else if (mCleanTime < cur_time)
    {
        doClean();
        mCleanTime = cur_time + CLEAN_TIME + rnd;
    }
    BLOCK_END("Font::slowLogic")
}

References BLOCK_END, BLOCK_START, CLEAN_TIME, cur_time, doClean(), and mCleanTime.

Referenced by Gui::slowLogic().

Field Documentation

mCache

TextChunkList Font::mCache[CACHES_NUMBER]

mutableprivate

Definition at line 152 of file font.h.

Referenced by clear(), doClean(), drawString(), generate(), getCache(), getWidth(), and insertChunk().

mCleanTime

time_t Font::mCleanTime

private

Definition at line 151 of file font.h.

Referenced by slowLogic().

mCreateCounter

unsigned int Font::mCreateCounter

private

Definition at line 147 of file font.h.

Referenced by drawString(), generate(), and getCreateCounter().

mDeleteCounter

unsigned int Font::mDeleteCounter

private

Definition at line 148 of file font.h.

Referenced by doClean(), drawString(), generate(), and getDeleteCounter().

mFont

TTF_Font* Font::mFont

private

Definition at line 146 of file font.h.

Referenced by drawString(), Font(), generate(), getHeight(), getWidth(), loadFont(), and ~Font().

mSoftMode

bool Font::mSoftMode

static

Definition at line 140 of file font.h.

Referenced by Font(), and TextChunkSmall::operator<().

---

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

• src/gui/fonts/font.h (986a3bf)
• src/gui/fonts/font.cpp (986a3bf)