font.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 of the License, or
 * (at your option) 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/>.
 *
 */

#ifndef GRAPHICS_FONT_H
#define GRAPHICS_FONT_H

#include "common/str.h"
#include "common/ustr.h"
#include "common/rect.h"

namespace Common {
template<class T> class Array;
}

namespace Graphics {

struct Surface;
class ManagedSurface;

enum TextAlign {
    kTextAlignInvalid,  
    kTextAlignStart,    
    kTextAlignLeft,     
    kTextAlignCenter,   
    kTextAlignEnd,      
    kTextAlignRight     
};

enum WordWrapMode {
    kWordWrapDefault                 = 0,       
    kWordWrapEvenWidthLines          = 1 << 0,  
    kWordWrapOnExplicitNewLines      = 1 << 1,  
    kWordWrapAllowTrailingWhitespace = 1 << 2   
};

TextAlign convertTextAlignH(TextAlign alignH, bool rtl);

class Font {
public:
    Font() {}
    virtual ~Font() {}

    virtual int getFontHeight() const = 0;

    virtual Common::String getFontName() const { return ""; }

    virtual int getFontAscent() const;

    virtual int getFontDescent() const;

    virtual int getFontLeading() const;

    virtual int getMaxCharWidth() const = 0;

    virtual int getCharWidth(uint32 chr) const = 0;

    virtual int getKerningOffset(uint32 left, uint32 right) const;

    virtual Common::Rect getBoundingBox(uint32 chr) const;

    Common::Rect getBoundingBox(const Common::String &str, int x = 0, int y = 0, const int w = 0, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const;
    Common::Rect getBoundingBox(const Common::U32String &str, int x = 0, int _y = 0, const int w = 0, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const;

    virtual void drawChar(Surface *dst, uint32 chr, int x, int y, uint32 color) const = 0;
    virtual void drawChar(ManagedSurface *dst, uint32 chr, int x, int y, uint32 color) const;

    void drawString(Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const;
    void drawString(Surface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const;
    void drawString(ManagedSurface *dst, const Common::String &str, int x, int _y, int w, uint32 color, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const;
    void drawString(ManagedSurface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const;

    int getStringWidth(const Common::String &str) const;
    int getStringWidth(const Common::U32String &str) const;

    int wordWrapText(const Common::String &str, int maxWidth, Common::Array<Common::String> &lines, int initWidth = 0, uint32 mode = kWordWrapOnExplicitNewLines) const;
    int wordWrapText(const Common::U32String &str, int maxWidth, Common::Array<Common::U32String> &lines, int initWidth = 0, uint32 mode = kWordWrapOnExplicitNewLines) const;
    int wordWrapText(const Common::U32String &str, int maxWidth, Common::Array<Common::U32String> &lines, Common::Array<bool> &lineContinuation, int initWidth = 0, uint32 mode = kWordWrapOnExplicitNewLines) const;

    void scaleSingleGlyph(Surface *scaleSurface, int *grayScaleMap, int grayScaleMapSize, int width, int height, int xOffset, int yOffset, int grayLevel, int chr, int srcheight, int srcwidth, float scale) const;

};
} // End of namespace Graphics

#endif