TrueTypeFont.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
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.
 
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 NOMLIB_SDL2_TRUETYPE_FONT_HEADERS
#define NOMLIB_SDL2_TRUETYPE_FONT_HEADERS
 
#include <iostream>
#include <string>
#include <memory>
 
#include "nomlib/config.hpp"
#include "nomlib/graphics/fonts/IFont.hpp"
#include "nomlib/graphics/fonts/FontMetrics.hpp"
#include "nomlib/graphics/fonts/FontPage.hpp"
 
// Dump glyph bounding coordinates & save source, destination sheets as PNG
// files
//#define NOM_DEBUG_SDL2_TRUE_TYPE_FONT_GLYPHS
 
// Dump the individual glyph bitmaps as PNG files
//#define NOM_DEBUG_SDL2_TRUE_TYPE_FONT_GLYPHS_PNG
 
// Forward declarations (Third-party)
typedef struct _TTF_Font TTF_Font;
 
namespace nom {
 
// Forward declarations
class Image;

class TrueTypeFont: public IFont
{
  public:
    typedef TrueTypeFont self_type;
    typedef self_type* RawPtr;
    typedef std::shared_ptr<self_type> SharedPtr;

    TrueTypeFont ( void );

    ~TrueTypeFont ( void );

    TrueTypeFont ( const TrueTypeFont& copy );

    IFont::raw_ptr clone( void ) const override;

    bool valid ( void ) const override;
 
    enum IFont::FontType type ( void ) const override;
 
    TTF_Font* font ( void ) const;

    const Image* image(uint32 character_size) const override;

    sint spacing ( uint32 character_size ) const override;
 
    int point_size() const;

    int newline( uint32 character_size ) const override;

    int kerning( uint32 first_char, uint32 second_char, uint32 character_size ) const override;

    int hinting( void ) const override;

    const Glyph& glyph ( uint32 codepoint, uint32 character_size ) const override;

    int outline ( /*uint32 character_size*/void ) /*const*/;

    uint32 font_style( void ) const override;

    bool set_point_size( int point_size ) override;

    bool set_hinting( int type ) override;

    bool set_outline( int outline ) override;

    void set_font_style( uint32 style ) override;

    void set_font_kerning( bool state ) override;

    bool load( const std::string& filename ) override;

    const FontMetrics& metrics( void ) const override;
 
  private:
    bool build ( uint32 character_size );
 
    const GlyphPage& pages ( void ) const;
 
    sint sheet_width ( void ) const;
    sint sheet_height ( void ) const;

    const IntRect glyph_rect ( FontPage& page, int width, int height ) const;

    const enum IFont::FontType type_;

    sint sheet_width_;

    sint sheet_height_;

    std::shared_ptr<TTF_Font> font_;

    mutable GlyphPage pages_;

    FontMetrics metrics_;

    std::string filename_;

    sint point_size_;

    bool use_kerning_;
};
 
} // namespace nom
 
#endif // include guard defined