ConsoleFont.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2018 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_CONSOLE_FONT_H
#define GF_CONSOLE_FONT_H

#include "ArrayRef.h"
#include "Path.h"
#include "Portability.h"
#include "StringRef.h"
#include "Texture.h"
#include "Vector.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  struct GF_API ConsoleFontFormat {
    enum Transparency {
      Alpha,      
      Grayscale,  
      ColorKey,   
    };

    Transparency transparency; 

    enum Layout {
      InColumn, 
      InRow,    
    };

    Layout layout; 

    enum Mapping {
      CodePage437,          
      ModifiedCodePage437,  
      Special,              
      Custom,               
    };

    Mapping mapping; 
  };

  struct GF_API ConsoleFontElement {
    char16_t character; 
    uint8_t index;      
  };

  struct GF_API PredefinedConsoleFontFormat {
    static constexpr ConsoleFontFormat Libtcod = { ConsoleFontFormat::ColorKey, ConsoleFontFormat::InRow, ConsoleFontFormat::Special };

    static constexpr ConsoleFontFormat DwarfFortress = { ConsoleFontFormat::ColorKey, ConsoleFontFormat::InRow, ConsoleFontFormat::CodePage437 };
  };

  class GF_API ConsoleFont {
  public:
    ConsoleFont();

    virtual ~ConsoleFont();

    ConsoleFontFormat getFormat() const {
      return m_format;
    }

    Vector2u getSize() const {
      return m_size;
    }

    Vector2u getCharacterSize() const {
      return m_characterSize;
    }

    void mapCode(char16_t c, Vector2u position);

    void mapCodeRange(char16_t c, unsigned count, Vector2u position);

    void mapString(StringRef str, Vector2u position);

    void mapElement(ConsoleFontElement element);

    void mapElements(ArrayRef<ConsoleFontElement> elements);

    void clearMapping();

    RectU getSubTexture(char16_t c) const;

    RectF getTextureRect(char16_t c) const;

    virtual const BareTexture *getTexture() const = 0;

  protected:
    bool setFormatAndComputeSizes(ConsoleFontFormat format, Vector2u size, Vector2u imageSize);

    void logFormat(const Path& filename) const;

    Vector2u getColorKeyPosition() const;

  private:
    std::vector<uint8_t> m_mapping;
    ConsoleFontFormat m_format;
    Vector2u m_size;
    Vector2u m_characterSize;
  };

  class GF_API BitmapConsoleFont : public ConsoleFont {
  public:

    virtual const BareTexture *getTexture() const override;

    bool loadFromFile(const Path& filename, ConsoleFontFormat format, Vector2u size = { 0u, 0u });

  private:
    AlphaTexture m_texture;
  };

  class GF_API ColoredConsoleFont : public ConsoleFont {
  public:

    virtual const BareTexture *getTexture() const override;

    bool loadFromFile(const Path& filename, ConsoleFontFormat format, Vector2u size = { 0u, 0u });

  private:
    Texture m_texture;
  };


#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_CONSOLE_FONT_H