BMFont.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_GRAPHICS_FONTS_BMFONT_HPP
#define NOMLIB_GRAPHICS_FONTS_BMFONT_HPP
 
#include <fstream>
#include <sstream>
#include <vector>
 
#include "nomlib/config.hpp"
#include "nomlib/graphics/fonts/IFont.hpp"
#include "nomlib/graphics/fonts/FontMetrics.hpp"
#include "nomlib/graphics/fonts/FontPage.hpp"
 
namespace nom {

struct BMFontKerningPair
{
  int first_char_id = 0;

  int second_char_id = 0;

  int x_offset = 0;
};
 
std::ostream& operator <<(std::ostream& os, const BMFontKerningPair& k);
 
struct BMFontPage
{
  int id = 0;

  std::string filename;
};
 
class BMFont: public IFont
{
  public:
    typedef BMFont self_type;

    BMFont();

    virtual ~BMFont();
 
    IFont* clone() const override;
 
    bool valid() const override;
 
    IFont::FontType type() const override;

    const Image* image(uint32 character_size) const override;

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

    int spacing(uint32 character_size) const override;

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

    int hinting() const override;

    uint32 font_style() const override;

    const Size2i& page_size(uint32 page) const;

    int newline(uint32 character_size) const override;
 
    const FontMetrics& metrics() const override;
 
    int point_size() const;
 
    bool use_kerning() const;

    bool set_point_size(int) override;

    bool set_hinting(int) override;

    bool set_outline(int) override;

    void set_font_style(uint32) override;

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

    bool parse_ascii_file(std::istream& fp);
 
  private:
    bool build(uint32 character_size);

    void parse_string(const std::string& key, std::string& value);

    Size2i page_size_;

    FontMetrics metrics_;

    mutable GlyphPage pages_;

    int point_size_;
 
    BMFontPage page_;

    std::vector<BMFontKerningPair> kernings_;

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