sjis.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

// The code in this file is currently used in KYRA, SCI, SCUMM, SAGA,
// and AGOS. If none of those are enabled, we will skip compiling it.
// We also enable this code for ScummVM builds including support
// for dynamic engine plugins.
// If you plan to use this code in another engine, you will have
// to add the proper define check here.
#if !(defined(ENABLE_KYRA) || defined(ENABLE_SCI) || defined(ENABLE_SCUMM) || defined(ENABLE_SAGA) || defined(ENABLE_AGOS) || defined(DYNAMIC_MODULES))

// If neither of the above mentioned is enabled, do not include the SJIS code.

#else

#ifndef GRAPHICS_SJIS_H
#define GRAPHICS_SJIS_H

#ifdef __DS__
/* This disables the flipped mode which is used in FM-Towns versions
 * of Monkey Island 1 (and maybe other SCUMM 5 games). These are not supported
 * on the DS, so it makes sense to have a corresponding setting here.
 */
#define DISABLE_FLIPPED_MODE
#endif

#include "common/scummsys.h"
#include "common/platform.h"

namespace Graphics {

struct Surface;

class FontSJIS {
public:
    virtual ~FontSJIS() {}

    static FontSJIS *createFont(const Common::Platform platform = Common::kPlatformUnknown);

    virtual bool loadData() = 0;

    enum DrawingMode {
        kDefaultMode,
        kOutlineMode,
        kShadowRightMode,
        kShadowLeftMode,
        kFMTownsShadowMode
    };

    virtual void setDrawingMode(DrawingMode mode) {}

    virtual void toggleFatPrint(bool enable) {}

    virtual void toggleFlippedMode(bool enable) {}

    virtual void setCharSpacing(int spacing) {}
    virtual void setLineSpacing(int spacing) {}

    virtual uint getFontHeight() const = 0;

    virtual uint getMaxFontWidth() const = 0;

    virtual uint getCharWidth(uint16 ch) const = 0;

    void drawChar(Graphics::Surface &dst, uint16 ch, int x, int y, uint32 c1, uint32 c2) const;

    virtual void drawChar(void *dst, uint16 ch, int pitch, int bpp, uint32 c1, uint32 c2, int maxW, int maxH) const = 0;
};

class FontSJISBase : public FontSJIS {
public:
    FontSJISBase();

    virtual void setDrawingMode(DrawingMode mode);

    virtual void toggleFlippedMode(bool enable);

    virtual void toggleFatPrint(bool enable);

    virtual uint getFontHeight() const;

    virtual uint getMaxFontWidth() const;

    virtual uint getCharWidth(uint16 ch) const;

    virtual void drawChar(void *dst, uint16 ch, int pitch, int bpp, uint32 c1, uint32 c2, int maxW, int maxH) const;
private:
    template<typename Color>
    void blitCharacter(const uint8 *glyph, const int w, const int h, uint8 *dst, int pitch, Color c) const;
    void createOutline(uint8 *outline, const uint8 *glyph, const int w, const int h) const;

#ifndef DISABLE_FLIPPED_MODE
    // This is used in the FM-Towns version of Monkey Island 1
    // when Guybrush gets shot out of the cannon in the circus tent.
    const uint8 *flipCharacter(const uint8 *glyph, const int w) const;
    mutable uint8 _tempGlyph[32];
#endif
    const uint8 *makeFatCharacter(const uint8 *glyph, const int w) const;
    mutable uint8 _tempGlyph2[32];
protected:
    DrawingMode _drawMode;
    bool _flippedMode, _fatPrint;
    int _fontWidth, _fontHeight;
    uint8 _bitPosNewLineMask;

    bool isASCII(uint16 ch) const;

    virtual const uint8 *getCharData(uint16 c) const = 0;

    enum DrawingFeature {
        kFeatDefault        = 1 << 0,
        kFeatOutline        = 1 << 1,
        kFeatShadow         = 1 << 2,
        kFeatFMTownsShadow  = 1 << 3,
        kFeatFlipped        = 1 << 4,
        kFeatFatPrint       = 1 << 5
    };

    virtual bool hasFeature(int feat) const = 0;
};

class FontTowns : public FontSJISBase {
public:
    bool loadData();

    static int getCharFMTChunk(uint16 ch);

private:
    enum {
        kFont16x16Chars = 7808,
        kFont8x16Chars = 256
    };

    uint8 _fontData16x16[kFont16x16Chars * 32];
    uint8 _fontData8x16[kFont8x16Chars * 32];

    virtual const uint8 *getCharData(uint16 c) const;

    bool hasFeature(int feat) const;
};

class FontPC98 : public FontSJISBase {
public:
    bool loadData() override;

    bool loadBMPData();

protected:
    const uint8 *getCharData(uint16 c) const override;

private:
    enum {
        kFont16x16Chars = 8831,
        kFont8x16Chars = 256
    };

    uint8 _fontData16x16[kFont16x16Chars * 32];
    uint8 _fontData8x16[kFont8x16Chars * 16];

    bool hasFeature(int feat) const override;
};

class FontPCEngine : public FontSJISBase {
public:
    bool loadData();
private:
    enum {
        kFont12x12Chars = 3418
    };

    uint8 _fontData12x12[kFont12x12Chars * 18];

    virtual const uint8 *getCharData(uint16 c) const;

    bool hasFeature(int feat) const;
};

class FontSjisSVM : public FontSJISBase {
public:
    FontSjisSVM(const Common::Platform platform);
    ~FontSjisSVM();

    bool loadData();
private:
    uint8 *_fontData16x16;
    uint _fontData16x16Size;

    uint8 *_fontData8x16;
    uint _fontData8x16Size;

    uint8 *_fontData12x12;
    uint _fontData12x12Size;

    virtual const uint8 *getCharData(uint16 c) const;

    bool hasFeature(int feat) const;

    const uint8 *getCharDataPCE(uint16 c) const;
    const uint8 *getCharDataDefault(uint16 c) const;

    void mapKANJIChar(const uint8 fB, const uint8 sB, int &base, int &index) const;

    enum {
        kSjisFontVersion = 3
    };
};

// TODO: Consider adding support for PC98 ROM
} // End of namespace Graphics

#endif

#endif // engine and dynamic plugins guard