OSDLTrueTypeFont.h

Go to the documentation of this file.

/*
 * Copyright (C) 2003-2010 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option)
 * any later version.
 *
 * The OSDL library 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 Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_TRUETYPE_FONT_H_
#define OSDL_TRUETYPE_FONT_H_



#include "OSDLFont.h"           // for inheritance


#include "Ceylan.h"             // for LoadableWithContent


#include <string>

#if ! defined(OSDL_USES_SDL_TTF) || OSDL_USES_SDL_TTF

/*
 * No need to include SDL_ttf header here.
 *
 * 'struct TTF_Font' could not be forward-declared, as SDL_ttf.h defines it as
 * 'typedef struct _TTF_Font TTF_Font;' which leads to the error "'struct
 * TTF_Font' has a previous declaration as 'struct TTF_Font'", as soon as an
 * implementation file includes SDL_ttf.h.
 *
 * So we use _TTF_Font instead of TTF_Font.
 *
 */
struct _TTF_Font ;

#endif // OSDL_USES_SDL_TTF





namespace OSDL
{



  namespace Video
  {



    // Fonts are rendered to surfaces.
    class Surface ;




    namespace TwoDimensional
    {



      namespace Text
      {



        // The internal actual font object.
#if ! defined(OSDL_USES_SDL_TTF) || OSDL_USES_SDL_TTF

        typedef ::_TTF_Font LowLevelTTFFont ;

#else // OSDL_USES_SDL_TTF

        struct LowLevelTTFFont {} ;

#endif // OSDL_USES_SDL_TTF



        // Forward-declaration for next counted pointer:
        class TrueTypeFont ;


        typedef Ceylan::CountedPointer<TrueTypeFont>
          TrueTypeFontCountedPtr ;



        class OSDL_DLL TrueTypeFont : public Font,
          public Ceylan::LoadableWithContent<LowLevelTTFFont>
          {


          public:




            TrueTypeFont(
              const std::string & fontFilename,
              FontIndex index = 0,
              bool convertToDisplay = true,
              RenderCache cacheSettings = GlyphCached,
              bool preload = false ) ;



            virtual ~TrueTypeFont() throw() ;




            // LoadableWithContent template instanciation.



            virtual bool load() ;



            virtual bool unload() ;



            virtual bool load( PointSize newPointSize ) ;




            virtual PointSize getPointSize() const ;



            virtual void setPointSize( PointSize newPointSize ) ;




            virtual RenderingStyle getRenderingStyle() const ;



            virtual void setRenderingStyle(
              RenderingStyle newStyle ) ;




            // Glyph-dependent methods.



            virtual Width getWidth( Ceylan::Latin1Char character )
              const ;



            virtual SignedWidth getWidthOffset(
              Ceylan::Latin1Char character ) const ;



            virtual SignedHeight getHeightAboveBaseline(
              Ceylan::Latin1Char character ) const ;



            virtual SignedLength getAdvance(
              Ceylan::Latin1Char character ) const ;




            // Glyph-independent methods.



            virtual Height getHeight() const ;



            virtual SignedHeight getAscent() const ;



            virtual SignedHeight getDescent() const ;



            virtual Height getLineSkip() const ;



            virtual Ceylan::Uint16 getFacesCount() const ;



            virtual bool isFixedWidth() const ;



            virtual std::string getFaceFamilyName() const ;



            virtual std::string getFaceStyleName() const ;





            // Bounding boxes section.



            virtual UprightRectangle & getBoundingBoxFor(
              Ceylan::Unicode glyph, SignedLength & advance )
              const ;



            virtual UprightRectangle & getBoundingBoxFor(
              const std::string & text ) const ;



            virtual UprightRectangle & getBoundingBoxForUTF8(
              const std::string & text ) const ;



            virtual UprightRectangle & getBoundingBoxForUnicode(
              const Ceylan::Unicode * text ) const ;




            // Render section.



            virtual Surface & renderLatin1Glyph(
              Ceylan::Latin1Char character,
              RenderQuality quality = Solid,
              Pixels::ColorDefinition glyphColor
              = Pixels::White ) ;



            virtual void blitLatin1Glyph(
              Surface & targetSurface,
              Coordinate x, Coordinate y,
              Ceylan::Latin1Char character,
              RenderQuality quality = Solid,
              Pixels::ColorDefinition glyphColor
              = Pixels::White ) ;



            virtual Surface & renderUnicodeGlyph(
              Ceylan::Unicode character,
              RenderQuality quality = Solid,
              Pixels::ColorDefinition textColor
              = Pixels::White ) ;



            virtual Surface & renderLatin1Text(
              const std::string & text,
              RenderQuality quality = Solid,
              Pixels::ColorDefinition textColor
              = Pixels::White ) ;



            virtual Surface & renderUTF8Text(
              const std::string & text,
              RenderQuality quality = Solid,
              Pixels::ColorDefinition textColor
              = Pixels::White ) ;



            virtual Surface & renderUnicodeText(
              const Ceylan::Unicode * text,
              RenderQuality quality = Solid,
              Pixels::ColorDefinition textColor
              = Pixels::Black ) ;




            virtual const std::string toString(
              Ceylan::VerbosityLevels level = Ceylan::high )
              const ;





            // Static section.



            static RenderQuality GetObtainedQualityFor(
              RenderQuality targetedQuality ) ;



            void SetUnicodeSwapStatus( bool newStatus ) ;



            static std::string DescribeLastError() ;



            static std::string FindPathFor(
              const std::string & fontFilename ) ;


            static PointSize DefaultPointSize ;


            static Ceylan::System::FileLocator
              TrueTypeFontFileLocator ;



            static std::string TrueTypeFontFileExtension ;



            static const Ceylan::Float32 SpaceWidthFactor ;





          protected:



            virtual Surface & basicRenderUnicodeGlyph(
              Ceylan::Unicode character,
              RenderQuality quality,
              Pixels::ColorDefinition glyphColor ) ;




            // Font filename is not kept currently.


            PointSize _pointSize ;


            static Ceylan::Uint32 FontCounter ;




          private:



            TrueTypeFont( const TrueTypeFont & source ) ;



            TrueTypeFont & operator = (
              const TrueTypeFont & source ) ;


          } ;


      }

    }

  }

}



#endif // OSDL_TRUETYPE_FONT_H_

---