Font.h

/* Copyright (C) 2006-2015 Laurentiu-Gheorghe Crisan
   Copyright (C) 2006-2015 Marc Boris Duerner
   Copyright (C) 2010 Aloysius Indrayanto
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  As a special exception, you may use this file as part of a free
  software library without restriction. Specifically, if other files
  instantiate templates or use macros or inline functions from this
  file, or you compile this file and link it with other files to
  produce an executable, this file does not by itself cause the
  resulting executable to be covered by the GNU General Public
  License. This exception does not however invalidate any other
  reasons why the executable file might be covered by the GNU Library
  General Public License.
 
  This 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 for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301 USA
*/
 
#ifndef PT_GFX_FONT_H
#define PT_GFX_FONT_H
 
#include <Pt/Gfx/Api.h>
#include <Pt/System/Path.h>
#include <Pt/SmartPtr.h>
 
#include <cstddef>
#include <string>
 
namespace Pt {
 
namespace Gfx {
 
class FontData;

class PT_GFX_API Font
{
    public:
        enum class Weight
        {
            Thin = 100,
            ExtraLight = 200,
            Light = 300,
            Normal = 400,
            Medium = 500,
            SemiBold = 600,
            Bold = 700,
            ExtraBold = 800,
            Black = 900
        };

        enum class Slant
        {
            Normal,
            Italic,
            Oblique
        };

        enum class Stretch
        {
            UltraCondensed = 1,
            ExtraCondensed = 2,
            Condensed      = 3,
            SemiCondensed  = 4,
            Normal         = 5,
            SemiExpanded   = 6,
            Expanded       = 7,
            ExtraExpanded  = 8,
            UltraExpanded  = 9
        };

        enum class Category
        {
            None,
            Serif,
            SansSerif,
            Monospace,
            Cursive,
            Fantasy
        };

        Font();

        Font(const std::string& family, std::size_t size,
             const std::string& styleName,
             Weight weight = Weight::Normal,
             Slant slant = Slant::Normal,
             Stretch stretch = Stretch::Normal);

        Font(const std::string& family, std::size_t size,
             Weight weight = Weight::Normal,
             Slant slant = Slant::Normal,
             Stretch stretch = Stretch::Normal);

        Font(Category category, std::size_t size,
             Weight weight = Weight::Normal,
             Slant slant = Slant::Normal,
             Stretch stretch = Stretch::Normal);

        const std::string& family() const;

        std::size_t size() const;

        const std::string& styleName() const;

        bool hasStyleName() const;

        Weight weight() const;

        Slant slant() const;

        Stretch stretch() const;

        Category category() const;

        Font withSize(std::size_t size) const;

        Font withWeight(Weight weight) const;

        Font withSlant(Slant slant) const;

        Font withStretch(Stretch stretch) const;
 
    public:
        static void addFonts(const System::Path& path);

        static bool addFont(const System::Path& path);

        static bool removeFont(const System::Path& path);

        static const std::vector<System::Path>& fontFiles();
 
    private:
        SmartPtr<FontData> _fontData;
};
 

inline bool operator==(const Font& a, const Font& b)
{
    return a.family() == b.family() &&
           a.weight() == b.weight() &&
           a.slant()  == b.slant()  &&
           a.stretch() == b.stretch() &&
           a.category() == b.category() &&
           a.size()   == b.size()   &&
           a.styleName() == b.styleName();
}
 

inline bool operator!=(const Font& a, const Font& b)
{
    return a.family() != b.family() ||
           a.weight() != b.weight() ||
           a.slant()  != b.slant()  ||
           a.stretch() != b.stretch() ||
           a.category() != b.category() ||
           a.size()   != b.size()   ||
           a.styleName() != b.styleName();
}
 

inline bool operator<(const Font& a, const Font& b)
{
    if(a.family() != b.family())
        return a.family() < b.family();
 
    if(a.weight() != b.weight())
        return a.weight() < b.weight();
 
    if(a.slant() != b.slant())
        return a.slant() < b.slant();
 
    if(a.stretch() != b.stretch())
        return a.stretch() < b.stretch();
 
    if(a.category() != b.category())
        return a.category() < b.category();
 
    if(a.size() != b.size())
        return a.size() < b.size();
 
    return a.styleName() < b.styleName();
}
 
 
inline Font Font::withSize(std::size_t size) const
{
    if(category() != Category::None)
        return Font(category(), size, weight(), slant(), stretch());
 
    if(hasStyleName())
        return Font(family(), size, styleName(), weight(), slant(), stretch());
 
    return Font(family(), size, weight(), slant(), stretch());
}
 
 
inline Font Font::withWeight(Weight weight) const
{
    if(category() != Category::None)
        return Font(category(), size(), weight, slant(), stretch());
 
    if(hasStyleName())
        return Font(family(), size(), styleName(), weight, slant(), stretch());
 
    return Font(family(), size(), weight, slant(), stretch());
}
 
 
inline Font Font::withSlant(Slant slant) const
{
    if(category() != Category::None)
        return Font(category(), size(), weight(), slant, stretch());
 
    if(hasStyleName())
        return Font(family(), size(), styleName(), weight(), slant, stretch());
 
    return Font(family(), size(), weight(), slant, stretch());
}
 
 
inline Font Font::withStretch(Stretch stretch) const
{
    if(category() != Category::None)
        return Font(category(), size(), weight(), slant(), stretch);
 
    if(hasStyleName())
        return Font(family(), size(), styleName(), weight(), slant(), stretch);
 
    return Font(family(), size(), weight(), slant(), stretch);
}
 
 
class FontData
{
    public:
        FontData()
        : _family()
        , _size(0)
        , _styleName()
        , _weight(Font::Weight::Normal)
        , _slant(Font::Slant::Normal)
        , _stretch(Font::Stretch::Normal)
        , _category(Font::Category::None)
        {
        }
 
        FontData(const std::string& family, std::size_t size,
                 Font::Weight weight = Font::Weight::Normal,
                 Font::Slant slant = Font::Slant::Normal,
                 Font::Stretch stretch = Font::Stretch::Normal,
                 const std::string& styleName = std::string())
        : _family(family)
        , _size(size)
        , _styleName(styleName)
        , _weight(weight)
        , _slant(slant)
        , _stretch(stretch)
        , _category(Font::Category::None)
        {
        }
 
        FontData(Font::Category category, std::size_t size,
                 Font::Weight weight = Font::Weight::Normal,
                 Font::Slant slant = Font::Slant::Normal,
                 Font::Stretch stretch = Font::Stretch::Normal)
        : _family()
        , _size(size)
        , _styleName()
        , _weight(weight)
        , _slant(slant)
        , _stretch(stretch)
        , _category(category)
        {
        }
 
        FontData(const std::string& family, const FontData& font)
        : _family(family)
        , _size(font._size)
        , _styleName(font._styleName)
        , _weight(font._weight)
        , _slant(font._slant)
        , _stretch(font._stretch)
        , _category(font._category)
        {
        }
 
        const std::string& family() const
        {
            return _family;
        }
 
        std::size_t size() const
        {
            return _size;
        }
 
        const std::string& styleName() const
        {
            return _styleName;
        }
 
        bool hasStyleName() const
        {
            return ! _styleName.empty();
        }
 
        Font::Weight weight() const
        {
            return _weight;
        }
 
        Font::Slant slant() const
        {
            return _slant;
        }
 
        Font::Stretch stretch() const
        {
            return _stretch;
        }
 
        Font::Category category() const
        {
            return _category;
        }
 
    private:
        std::string _family;
        std::size_t _size;
        std::string _styleName;
        Font::Weight _weight;
        Font::Slant _slant;
        Font::Stretch _stretch;
        Font::Category _category;
};
 
} //namespace
 
} //namespace
 
#endif