imagefont.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_IMAGEFONT_HPP_
#define INCLUDE_FIFECHAN_IMAGEFONT_HPP_
 
// Standard library includes
#include <array>
#include <string>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/color.hpp"
#include "fifechan/font.hpp"
#include "fifechan/rectangle.hpp"
 
namespace fcn
{
    class Color;
    class Graphics;
    class Image;

    enum class SeparatorStrategy : std::uint8_t
    {
        PixelAtOrigin,
        BorderDominant,
        ExplicitColor,
        Auto
    };

    struct ImageFontConfig
    {
            SeparatorStrategy strategy = SeparatorStrategy::Auto;

            Color explicitSeparator = Color{255, 0, 255, 255};

            int glyphPadding = 0;

            bool verbose = false;
    };

    class FIFEGUI_API ImageFont : public Font
    {
        public:
            ImageFont(std::string const & filename, std::string const & glyphs);

            ImageFont(std::string const & filename, std::string const & glyphs, ImageFontConfig const & config);

            ImageFont(Image* image, std::string const & glyphs);

            ImageFont(Image* image, std::string const & glyphs, ImageFontConfig const & config);

            explicit ImageFont(
                std::string const & filename, unsigned char glyphsFrom = 32, unsigned char glyphsTo = 126);
            // New constructor with configuration
            ImageFont(
                std::string const & filename,
                unsigned char glyphsFrom,
                unsigned char glyphsTo,
                ImageFontConfig const & config);
 
            ~ImageFont() override;
 
            ImageFont(ImageFont const &)            = delete;
            ImageFont& operator=(ImageFont const &) = delete;
            ImageFont(ImageFont&&)                  = delete;
            ImageFont& operator=(ImageFont&&)       = delete;

            virtual int drawGlyph(Graphics* graphics, unsigned char glyph, int x, int y);

            virtual void setRowSpacing(int spacing);

            virtual int getRowSpacing();

            virtual void setGlyphSpacing(int spacing);

            virtual int getGlyphSpacing();

            virtual int getWidth(unsigned char glyph) const;
 
            // Inherited from Font
 
            int getWidth(std::string const & text) const override;
 
            void drawString(Graphics* graphics, std::string const & text, int x, int y) override;
 
            int getHeight() const override;
 
            int getStringIndexAt(std::string const & text, int x) const override;
 
        protected:
            Rectangle scanForGlyph(unsigned char glyph, int x, int y, Color const & separator);

            std::array<Rectangle, 256> mGlyph;

            int mHeight{0};

            int mGlyphSpacing{0};

            int mRowSpacing{0};

            Image* mImage{nullptr};

            std::string mFilename;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_IMAGEFONT_HPP_