CEGUIFont.h

/***********************************************************************
    filename:   CEGUIFont.h
    created:    21/2/2004
    author:     Paul D Turner

    purpose:    Defines interface for the Font class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIFont_h_
#define _CEGUIFont_h_

#include "CEGUIBase.h"
#include "CEGUIPropertySet.h"
#include "CEGUIString.h"
#include "CEGUIRect.h"
#include "CEGUIVector.h"
#include "CEGUIColourRect.h"
#include "CEGUIXMLSerializer.h"
#include "CEGUIImage.h"

#include <map>


#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{

// Forward declarations for font properties
namespace FontProperties
{
    class NativeRes;
    class Name;
    class FileName;
    class ResourceGroup;
    class AutoScaled;
}

enum TextFormatting
{
    LeftAligned,
    RightAligned,
    Centred,
    Justified,
    WordWrapLeftAligned,
    WordWrapRightAligned,
    WordWrapCentred,
    WordWrapJustified
};


class FontGlyph
{
private:
    const Image* d_image;
    float d_advance;

public:
    FontGlyph ()
    { }

    FontGlyph (float advance) : d_image (0), d_advance (advance)
    { }

    FontGlyph (float advance, const Image *image) : d_image (image), d_advance (advance)
    { }

    const Image* getImage () const
    { return d_image; }

    const Imageset* getImageset () const
    { return d_image->getImageset (); }

    Size getSize (float x_scale, float y_scale) const
    { return Size (getWidth (x_scale), getHeight (y_scale)); }

    float getWidth (float x_scale) const
    { return d_image->getWidth () * x_scale; }

    float getHeight (float y_scale) const
    { return d_image->getHeight () * y_scale; }

    float getRenderedAdvance (float x_scale) const
    { return (d_image->getWidth () + d_image->getOffsetX ()) * x_scale; }

    float getAdvance (float x_scale = 1.0) const
    { return d_advance * x_scale; }

    void setAdvance (float advance)
    { d_advance = advance; }

    void setImage (const Image* image)
    { d_image = image; }
};


class CEGUIEXPORT Font : public PropertySet
{
protected:
    /*************************************************************************
        Friends so that only FontManager can create and destroy font objects
    *************************************************************************/
    friend class FontManager;
    friend class Font_xmlHandler;
    friend class FontProperties::NativeRes;
    friend class FontProperties::Name;
    friend class FontProperties::FileName;
    friend class FontProperties::ResourceGroup;
    friend class FontProperties::AutoScaled;

    /*************************************************************************
        Implementation Data
    *************************************************************************/
    typedef std::map<utf32, FontGlyph> CodepointMap;
    CodepointMap d_cp_map;

    String d_name;
    String d_fileName;
    String d_resourceGroup;
    static String d_defaultResourceGroup;

    float d_ascender;
    float d_descender;
    float d_height;

    bool d_autoScale;
    float d_horzScaling;
    float d_vertScaling;
    float d_nativeHorzRes;
    float d_nativeVertRes;

    utf32 d_maxCodepoint;

    uint *d_glyphPageLoaded;

    /*************************************************************************
        Construction & Destruction
    *************************************************************************/
    Font (const String& name, const String& fontname,
          const String& resourceGroup = "");

    Font (const XMLAttributes& attributes);

    virtual ~Font ();

    virtual void defineMapping (const XMLAttributes& attributes);

    virtual void updateFont () = 0;

    size_t drawWrappedText (const String& text, const Rect& draw_area, float z, const Rect& clip_rect, TextFormatting fmt, const ColourRect& colours, float x_scale = 1.0f, float y_scale = 1.0f);

    size_t getNextWord (const String& in_string, size_t start_idx, String& out_string) const;

    void drawTextLine (const String& text, const Vector3& position, const Rect& clip_rect, const ColourRect& colours, float x_scale = 1.0f, float y_scale = 1.0f);

    void drawTextLineJustified (const String& text, const Rect& draw_area, const Vector3& position, const Rect& clip_rect, const ColourRect& colours, float x_scale = 1.0f, float y_scale = 1.0f);

    float getWrappedTextExtent (const String& text, float wrapWidth, float x_scale = 1.0f);

    const FontGlyph* getGlyphData (utf32 codepoint);

    void setMaxCodepoint (utf32 codepoint);

    virtual void rasterize (utf32 start_codepoint, utf32 end_codepoint);

    void writeXMLToStream (XMLSerializer& xml_stream) const;

    virtual void writeXMLToStream_impl (XMLSerializer& xml_stream) const = 0;

    void addFontProperties ();

public:
    static const argb_t DefaultColour;

    virtual void load () = 0;

    bool isCodepointAvailable (utf32 cp) const
    { return (d_cp_map.find(cp) != d_cp_map.end()); }

    /*************************************************************************
        Text drawing methods
    *************************************************************************/
    size_t drawText (const String& text, const Rect& draw_area, float z, const Rect& clip_rect, TextFormatting fmt, const ColourRect& colours, float x_scale = 1.0f, float y_scale = 1.0f);

    size_t drawText (const String& text, const Rect& draw_area, float z, const Rect& clip_rect, TextFormatting fmt, float x_scale = 1.0f, float y_scale = 1.0f)
    { return drawText (text, draw_area, z, clip_rect, fmt, ColourRect (DefaultColour, DefaultColour, DefaultColour, DefaultColour), x_scale, y_scale); }

    void drawText (const String& text, const Rect& draw_area, float z, const Rect& clip_rect, float x_scale = 1.0f, float y_scale = 1.0f)
    { drawText (text, draw_area, z, clip_rect, LeftAligned, ColourRect (DefaultColour, DefaultColour, DefaultColour, DefaultColour), x_scale, y_scale); }

    size_t drawText (const String& text, const Rect& draw_area, float z, TextFormatting fmt, const ColourRect& colours, float x_scale = 1.0f, float y_scale = 1.0f)
    { return drawText (text, draw_area, z, draw_area, fmt, colours, x_scale, y_scale); }

    size_t drawText (const String& text, const Rect& draw_area, float z, TextFormatting fmt, float x_scale = 1.0f, float y_scale = 1.0f)
    { return drawText (text, draw_area, z, draw_area, fmt, ColourRect (DefaultColour, DefaultColour, DefaultColour, DefaultColour), x_scale, y_scale); }

    void drawText (const String& text, const Rect& draw_area, float z, float x_scale = 1.0f, float y_scale = 1.0f)
    { drawText (text, draw_area, z, draw_area, LeftAligned, ColourRect (DefaultColour, DefaultColour, DefaultColour, DefaultColour), x_scale, y_scale); }

    void drawText (const String& text, const Vector3& position, const Rect& clip_rect, const ColourRect& colours, float x_scale = 1.0f, float y_scale = 1.0f)
    { drawText (text, Rect (position.d_x, position.d_y, position.d_x, position.d_y), position.d_z, clip_rect, LeftAligned, colours, x_scale, y_scale); }

    void drawText (const String& text, const Vector3& position, const Rect& clip_rect, float x_scale = 1.0f, float y_scale = 1.0f)
    { drawText (text, Rect (position.d_x, position.d_y, position.d_x, position.d_y), position.d_z, clip_rect, LeftAligned, ColourRect(DefaultColour, DefaultColour, DefaultColour, DefaultColour), x_scale, y_scale); }

    virtual void setNativeResolution (const Size& size);

    virtual void notifyScreenResolution (const Size& size);

    /*************************************************************************
        Informational methods
    *************************************************************************/
    float getLineSpacing (float y_scale = 1.0f) const
    { return d_height * y_scale; }

    float getFontHeight (float y_scale = 1.0f) const
    { return (d_ascender - d_descender) * y_scale; }

    float getBaseline (float y_scale = 1.0f) const
    { return d_ascender * y_scale; }

    float getTextExtent (const String& text, float x_scale = 1.0f);

    size_t getCharAtPixel (const String& text, float pixel, float x_scale = 1.0f)
    { return getCharAtPixel(text, 0, pixel, x_scale); }

    size_t getCharAtPixel (const String& text, size_t start_char, float pixel, float x_scale = 1.0f);

    size_t getFormattedLineCount (const String& text, const Rect& format_area, TextFormatting fmt, float x_scale = 1.0f);

    float getFormattedTextExtent (const String& text, const Rect& format_area, TextFormatting fmt, float x_scale = 1.0f);


    static void setDefaultResourceGroup (const String& resourceGroup)
    { d_defaultResourceGroup = resourceGroup; }


    static const String& getDefaultResourceGroup ()
    { return d_defaultResourceGroup; }
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif


#endif  // end of guard _CEGUIFont_h_