Move font.cpp/h into fonts directory.

2 files changed, 871 insertions, 0 deletions

diff --git a/src/gui/fonts/font.cpp b/src/gui/fonts/font.cpp
new file mode 100644
index 000000000..d8abc1dcf
--- /dev/null
+++ b/src/gui/fonts/font.cpp
@@ -0,0 +1,657 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2009  Aethyra Development Team
+ *  Copyright (C) 2011-2014  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  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 2 of the License, or
+ *  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/>.
+ */
+
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "gui/fonts/font.h"
+
+#include "logger.h"
+#include "main.h"
+
+#include "render/sdlgraphics.h"
+
+#include "resources/image.h"
+#include "resources/imagehelper.h"
+#include "resources/resourcemanager.h"
+#include "resources/surfaceimagehelper.h"
+
+#include "utils/delete2.h"
+#include "utils/paths.h"
+#include "utils/sdlcheckutils.h"
+#include "utils/stringutils.h"
+#include "utils/timer.h"
+
+#include "debug.h"
+
+const unsigned int CACHE_SIZE = 256;
+const unsigned int CACHE_SIZE_SMALL1 = 2;
+const unsigned int CACHE_SIZE_SMALL2 = 50;
+const unsigned int CACHE_SIZE_SMALL3 = 170;
+const unsigned int CLEAN_TIME = 7;
+const int OUTLINE_SIZE = 1;
+
+bool Font::mSoftMode(false);
+
+char *strBuf = nullptr;
+
+#ifdef UNITTESTS
+int sdlTextChunkCnt = 0;
+#endif
+
+SDLTextChunkSmall::SDLTextChunkSmall(const std::string &text0,
+                                     const Color &color0,
+                                     const Color &color1) :
+    text(text0),
+    color(color0),
+    color2(color1)
+{
+}
+
+SDLTextChunkSmall::SDLTextChunkSmall(const SDLTextChunkSmall &old) :
+    text(old.text),
+    color(old.color),
+    color2(old.color2)
+{
+}
+
+bool SDLTextChunkSmall::operator==(const SDLTextChunkSmall &chunk) const
+{
+    return (chunk.text == text && chunk.color == color
+            && chunk.color2 == color2);
+}
+
+bool SDLTextChunkSmall::operator<(const SDLTextChunkSmall &chunk) const
+{
+    if (chunk.text != text)
+        return chunk.text > text;
+
+    const Color &c = chunk.color;
+    if (c.r != color.r)
+        return c.r > color.r;
+    if (c.g != color.g)
+        return c.g > color.g;
+    if (c.b != color.b)
+        return c.b > color.b;
+
+    const Color &c2 = chunk.color2;
+    if (c2.r != color2.r)
+        return c2.r > color2.r;
+    if (c2.g != color2.g)
+        return c2.g > color2.g;
+    if (c2.b != color2.b)
+        return c2.b > color2.b;
+
+    if (c.a != color.a && Font::mSoftMode)
+        return c.a > color.a;
+
+    return false;
+}
+
+SDLTextChunk::SDLTextChunk(const std::string &text0, const Color &color0,
+                           const Color &color1) :
+    img(nullptr),
+    text(text0),
+    color(color0),
+    color2(color1),
+    prev(nullptr),
+    next(nullptr)
+{
+#ifdef UNITTESTS
+    sdlTextChunkCnt ++;
+#endif
+}
+
+SDLTextChunk::~SDLTextChunk()
+{
+    delete2(img);
+#ifdef UNITTESTS
+    sdlTextChunkCnt --;
+#endif
+}
+
+bool SDLTextChunk::operator==(const SDLTextChunk &chunk) const
+{
+    return (chunk.text == text && chunk.color == color
+            && chunk.color2 == color2);
+}
+
+void SDLTextChunk::generate(TTF_Font *const font, const float alpha)
+{
+    BLOCK_START("SDLTextChunk::generate")
+    SDL_Color sdlCol;
+    sdlCol.b = static_cast<uint8_t>(color.b);
+    sdlCol.r = static_cast<uint8_t>(color.r);
+    sdlCol.g = static_cast<uint8_t>(color.g);
+#ifdef USE_SDL2
+    sdlCol.a = 255;
+#else
+    sdlCol.unused = 0;
+#endif
+
+    getSafeUtf8String(text, strBuf);
+
+    SDL_Surface *surface = MTTF_RenderUTF8_Blended(
+        font, strBuf, sdlCol);
+
+    if (!surface)
+    {
+        img = nullptr;
+        BLOCK_END("SDLTextChunk::generate")
+        return;
+    }
+
+    const int width = surface->w;
+    const int height = surface->h;
+
+    if (color.r != color2.r || color.g != color2.g
+        || color.b != color2.b)
+    {   // outlining
+        SDL_Color sdlCol2;
+        SDL_Surface *const background = imageHelper->create32BitSurface(
+            width, height);
+        if (!background)
+        {
+            img = nullptr;
+            MSDL_FreeSurface(surface);
+            BLOCK_END("SDLTextChunk::generate")
+            return;
+        }
+        sdlCol2.b = static_cast<uint8_t>(color2.b);
+        sdlCol2.r = static_cast<uint8_t>(color2.r);
+        sdlCol2.g = static_cast<uint8_t>(color2.g);
+#ifdef USE_SDL2
+        sdlCol2.a = 255;
+#else
+        sdlCol2.unused = 0;
+#endif
+        SDL_Surface *const surface2 = MTTF_RenderUTF8_Blended(
+            font, strBuf, sdlCol2);
+        if (!surface2)
+        {
+            img = nullptr;
+            MSDL_FreeSurface(surface);
+            BLOCK_END("SDLTextChunk::generate")
+            return;
+        }
+        SDL_Rect rect =
+        {
+            OUTLINE_SIZE,
+            0,
+            static_cast<Uint16>(surface->w),
+            static_cast<Uint16>(surface->h)
+        };
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
+        rect.x = -OUTLINE_SIZE;
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
+        rect.x = 0;
+        rect.y = -OUTLINE_SIZE;
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
+        rect.y = OUTLINE_SIZE;
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
+        rect.x = 0;
+        rect.y = 0;
+        SurfaceImageHelper::combineSurface(surface, nullptr,
+            background, &rect);
+        MSDL_FreeSurface(surface);
+        MSDL_FreeSurface(surface2);
+        surface = background;
+    }
+    img = imageHelper->createTextSurface(
+        surface, width, height, alpha);
+    MSDL_FreeSurface(surface);
+
+    BLOCK_END("SDLTextChunk::generate")
+}
+
+
+TextChunkList::TextChunkList() :
+    start(nullptr),
+    end(nullptr),
+    size(0),
+    search(),
+    searchWidth()
+{
+}
+
+void TextChunkList::insertFirst(SDLTextChunk *const item)
+{
+    SDLTextChunk *const oldFirst = start;
+    if (start)
+        start->prev = item;
+    item->prev = nullptr;
+    if (oldFirst)
+        item->next = oldFirst;
+    else
+        end = item;
+    start = item;
+    size ++;
+    search[SDLTextChunkSmall(item->text, item->color, item->color2)] = item;
+    searchWidth[item->text] = item;
+}
+
+void TextChunkList::moveToFirst(SDLTextChunk *const item)
+{
+    if (item == start)
+        return;
+
+    SDLTextChunk *oldPrev = item->prev;
+    if (oldPrev)
+        oldPrev->next = item->next;
+    SDLTextChunk *oldNext = item->next;
+    if (oldNext)
+        oldNext->prev = item->prev;
+    else
+        end = oldPrev;
+    SDLTextChunk *const oldFirst = start;
+    if (start)
+        start->prev = item;
+    item->prev = nullptr;
+    item->next = oldFirst;
+    start = item;
+}
+
+void TextChunkList::removeBack()
+{
+    SDLTextChunk *oldEnd = end;
+    if (oldEnd)
+    {
+        end = oldEnd->prev;
+        if (end)
+            end->next = nullptr;
+        else
+            start = nullptr;
+        search.erase(SDLTextChunkSmall(oldEnd->text,
+            oldEnd->color, oldEnd->color2));
+        searchWidth.erase(oldEnd->text);
+        delete oldEnd;
+        size --;
+    }
+}
+
+void TextChunkList::removeBack(int n)
+{
+    SDLTextChunk *item = end;
+    while (n && item)
+    {
+        n --;
+        SDLTextChunk *oldEnd = item;
+        item = item->prev;
+        search.erase(SDLTextChunkSmall(oldEnd->text,
+            oldEnd->color, oldEnd->color2));
+        searchWidth.erase(oldEnd->text);
+        delete oldEnd;
+        size --;
+    }
+    if (item)
+    {
+        item->next = nullptr;
+        end = item;
+    }
+    else
+    {
+        start = nullptr;
+        end = nullptr;
+    }
+}
+
+void TextChunkList::clear()
+{
+    search.clear();
+    searchWidth.clear();
+    SDLTextChunk *item = start;
+    while (item)
+    {
+        SDLTextChunk *item2 = item->next;
+        delete item;
+        item = item2;
+    }
+    start = nullptr;
+    end = nullptr;
+    size = 0;
+}
+
+static int fontCounter;
+
+Font::Font(std::string filename,
+           const int size,
+           const int style) :
+    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(TTF_GetError()));
+        }
+    }
+
+    if (!fontCounter)
+    {
+        strBuf = new char[65535];
+        memset(strBuf, 0, 65535);
+    }
+
+    ++fontCounter;
+
+    fixDirSeparators(filename);
+    mFont = openFont(filename.c_str(), size);
+
+    if (!mFont)
+    {
+        logger->log("Error finding font " + filename);
+        std::string backFile("fonts/dejavusans.ttf");
+        mFont = openFont(fixDirSeparators(backFile).c_str(), size);
+        if (!mFont)
+        {
+            logger->error("Font::Font: " +
+                          std::string(TTF_GetError()));
+        }
+    }
+
+    TTF_SetFontStyle(mFont, style);
+}
+
+Font::~Font()
+{
+    TTF_CloseFont(mFont);
+    mFont = nullptr;
+    --fontCounter;
+    clear();
+
+    if (fontCounter == 0)
+    {
+        TTF_Quit();
+        delete []strBuf;
+    }
+}
+
+TTF_Font *Font::openFont(const char *const name, const int size)
+{
+// disabled for now because some systems like gentoo cant use it
+// #ifdef USE_SDL2
+//    SDL_RWops *const rw = MPHYSFSRWOPS_openRead(name);
+//    if (!rw)
+//        return nullptr;
+//    return TTF_OpenFontIndexRW(rw, 1, size, 0);
+// #else
+    return TTF_OpenFontIndex(ResourceManager::getPath(name).c_str(),
+        size, 0);
+// #endif
+}
+
+void Font::loadFont(std::string filename,
+                    const int size,
+                    const int style)
+{
+    if (fontCounter == 0 && TTF_Init() == -1)
+    {
+        logger->log("Unable to initialize SDL_ttf: " +
+                    std::string(TTF_GetError()));
+        return;
+    }
+
+    fixDirSeparators(filename);
+    TTF_Font *const font = openFont(filename.c_str(), size);
+
+    if (!font)
+    {
+        logger->log("Font::Font: " +
+                    std::string(TTF_GetError()));
+        return;
+    }
+
+    if (mFont)
+        TTF_CloseFont(mFont);
+
+    mFont = font;
+    TTF_SetFontStyle(mFont, style);
+    clear();
+}
+
+void Font::clear()
+{
+    for (size_t f = 0; f < CACHES_NUMBER; f ++)
+        mCache[f].clear();
+}
+
+void Font::drawString(Graphics *const graphics,
+                      const std::string &text,
+                      const int x, const int y)
+{
+    BLOCK_START("Font::drawString")
+    if (text.empty())
+    {
+        BLOCK_END("Font::drawString")
+        return;
+    }
+
+    Graphics *const g = dynamic_cast<Graphics *const>(graphics);
+    if (!g)
+        return;
+
+    Color col = g->getColor();
+    const Color &col2 = g->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<SDLTextChunkSmall, SDLTextChunk*> &search = cache->search;
+    std::map<SDLTextChunkSmall, SDLTextChunk*>::iterator i
+        = search.find(SDLTextChunkSmall(text, col, col2));
+    if (i != search.end())
+    {
+        SDLTextChunk *const chunk2 = (*i).second;
+        cache->moveToFirst(chunk2);
+        Image *const image = chunk2->img;
+        if (image)
+        {
+            image->setAlpha(alpha);
+            g->drawImage(image, x, y);
+        }
+    }
+    else
+    {
+        if (cache->size >= CACHE_SIZE)
+        {
+#ifdef DEBUG_FONT_COUNTERS
+            mDeleteCounter ++;
+#endif
+            cache->removeBack();
+        }
+#ifdef DEBUG_FONT_COUNTERS
+        mCreateCounter ++;
+#endif
+        SDLTextChunk *chunk2 = new SDLTextChunk(text, col, col2);
+
+        chunk2->generate(mFont, alpha);
+        cache->insertFirst(chunk2);
+
+        const Image *const image = chunk2->img;
+        if (image)
+            g->drawImage(image, x, y);
+    }
+    BLOCK_END("Font::drawString")
+}
+
+void Font::slowLogic(const int rnd)
+{
+    BLOCK_START("Font::slowLogic")
+    if (!mCleanTime)
+    {
+        mCleanTime = cur_time + CLEAN_TIME + rnd;
+    }
+    else if (mCleanTime < cur_time)
+    {
+        doClean();
+        mCleanTime = cur_time + CLEAN_TIME + rnd;
+    }
+    BLOCK_END("Font::slowLogic")
+}
+
+int Font::getWidth(const std::string &text) const
+{
+    if (text.empty())
+        return 0;
+
+    const unsigned char chr = text[0];
+    TextChunkList *const cache = &mCache[chr];
+
+    std::map<std::string, SDLTextChunk*> &search = cache->searchWidth;
+    std::map<std::string, SDLTextChunk*>::iterator i = search.find(text);
+    if (i != search.end())
+    {
+        SDLTextChunk *const chunk = (*i).second;
+        cache->moveToFirst(chunk);
+        const Image *const image = chunk->img;
+        if (image)
+            return image->getWidth();
+        else
+            return 0;
+    }
+
+    // if string was not drawed
+    int w, h;
+    getSafeUtf8String(text, strBuf);
+    TTF_SizeUTF8(mFont, strBuf, &w, &h);
+    return w;
+}
+
+int Font::getHeight() const
+{
+    return TTF_FontHeight(mFont);
+}
+
+void Font::doClean()
+{
+    for (unsigned int f = 0; f < CACHES_NUMBER; f ++)
+    {
+        TextChunkList *const cache = &mCache[f];
+        const size_t size = static_cast<size_t>(cache->size);
+#ifdef DEBUG_FONT_COUNTERS
+        logger->log("ptr: %d, size: %d", f, size);
+#endif
+        if (size > CACHE_SIZE_SMALL3)
+        {
+#ifdef DEBUG_FONT_COUNTERS
+            mDeleteCounter += 100;
+#endif
+            cache->removeBack(100);
+#ifdef DEBUG_FONT_COUNTERS
+            logger->log("delete3");
+#endif
+        }
+        else if (size > CACHE_SIZE_SMALL2)
+        {
+#ifdef DEBUG_FONT_COUNTERS
+            mDeleteCounter += 20;
+#endif
+            cache->removeBack(20);
+#ifdef DEBUG_FONT_COUNTERS
+            logger->log("delete2");
+#endif
+        }
+        else if (size > CACHE_SIZE_SMALL1)
+        {
+#ifdef DEBUG_FONT_COUNTERS
+            mDeleteCounter ++;
+#endif
+            cache->removeBack();
+#ifdef DEBUG_FONT_COUNTERS
+            logger->log("delete1");
+#endif
+        }
+    }
+}
+
+int Font::getStringIndexAt(const std::string& text, const int x) const
+{
+    const size_t sz = text.size();
+    for (size_t i = 0; i < sz; ++i)
+    {
+        if (getWidth(text.substr(0, i)) > x)
+            return static_cast<int>(i);
+    }
+
+    return static_cast<int>(sz);
+}
+
+const TextChunkList *Font::getCache() const
+{
+    return mCache;
+}
diff --git a/src/gui/fonts/font.h b/src/gui/fonts/font.h
new file mode 100644
index 000000000..f6a64a2d8
--- /dev/null
+++ b/src/gui/fonts/font.h
@@ -0,0 +1,214 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2014  The ManaPlus Developers
+ *  Copyright (C) 2009  Aethyra Development Team
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  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 2 of the License, or
+ *  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/>.
+ */
+
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef GUI_FONTS_FONT_H
+#define GUI_FONTS_FONT_H
+
+#include "gui/color.h"
+
+#include <SDL_ttf.h>
+
+#include <map>
+#include <string>
+
+#include "localconsts.h"
+
+class Color;
+class Graphics;
+class Image;
+
+const unsigned int CACHES_NUMBER = 256;
+
+class SDLTextChunkSmall
+{
+    public:
+        SDLTextChunkSmall(const std::string &text0, const Color &color0,
+                          const Color &color1);
+
+        SDLTextChunkSmall(const SDLTextChunkSmall &old);
+
+        bool operator==(const SDLTextChunkSmall &chunk) const;
+        bool operator<(const SDLTextChunkSmall &chunk) const;
+
+        std::string text;
+        Color color;
+        Color color2;
+};
+
+class SDLTextChunk final
+{
+    public:
+        SDLTextChunk(const std::string &text0, const Color &color0,
+                     const Color &color1);
+
+        A_DELETE_COPY(SDLTextChunk)
+
+        ~SDLTextChunk();
+
+        bool operator==(const SDLTextChunk &chunk) const;
+
+        void generate(TTF_Font *const font, const float alpha);
+
+        Image *img;
+        std::string text;
+        Color color;
+        Color color2;
+        SDLTextChunk *prev;
+        SDLTextChunk *next;
+};
+
+
+class TextChunkList final
+{
+    public:
+        TextChunkList();
+
+        A_DELETE_COPY(TextChunkList)
+
+        void insertFirst(SDLTextChunk *const item);
+
+        void moveToFirst(SDLTextChunk *const item);
+
+        void removeBack();
+
+        void removeBack(int n);
+
+        void clear();
+
+        SDLTextChunk *start;
+        SDLTextChunk *end;
+        uint32_t size;
+        std::map<SDLTextChunkSmall, SDLTextChunk*> search;
+        std::map<std::string, SDLTextChunk*> searchWidth;
+};
+
+/**
+ * A wrapper around SDL_ttf for allowing the use of TrueType fonts.
+ *
+ * <b>NOTE:</b> This class initializes SDL_ttf as necessary.
+ */
+class Font final
+{
+    public:
+        Font(std::string filename,
+             const int size,
+             const int style = 0);
+
+        A_DELETE_COPY(Font)
+
+        ~Font();
+
+        void loadFont(std::string filename,
+                      const int size,
+                      const int style = 0);
+
+        int getWidth(const std::string &text) const A_WARN_UNUSED;
+
+        int getHeight() const A_WARN_UNUSED;
+
+        const TextChunkList *getCache() const A_WARN_UNUSED;
+
+        /**
+         * @see Font::drawString
+         */
+        void drawString(Graphics *const graphics,
+                        const std::string &text,
+                        const int x, const int y);
+
+        void clear();
+
+        void doClean();
+
+        void slowLogic(const int rnd);
+
+        int getCreateCounter() const A_WARN_UNUSED
+        { return mCreateCounter; }
+
+        int getDeleteCounter() const A_WARN_UNUSED
+        { return mDeleteCounter; }
+
+        int getStringIndexAt(const std::string& text,
+                             const int x) const A_WARN_UNUSED;
+
+        static bool mSoftMode;
+
+    private:
+        static TTF_Font *openFont(const char *const name, const int size);
+
+        TTF_Font *mFont;
+        unsigned mCreateCounter;
+        unsigned mDeleteCounter;
+
+        // Word surfaces cache
+        int mCleanTime;
+        mutable TextChunkList mCache[CACHES_NUMBER];
+};
+
+#ifdef UNITTESTS
+extern int sdlTextChunkCnt;
+#endif
+
+#endif  // GUI_FONTS_FONT_H