scummvm/graphics/fonts/macfont.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/>.
 *
 */

#ifndef GRAPHICS_FONTS_MACFONT_H
#define GRAPHICS_FONTS_MACFONT_H

#include "common/array.h"
#include "common/hashmap.h"
#include "common/stream.h"
#include "graphics/font.h"

namespace Graphics {

#define SLANTDEEP 2

class MacFontFamily {
public:
	MacFontFamily(const Common::String &name);
	~MacFontFamily();

	bool load(Common::SeekableReadStream &stream);
	int getKerningOffset(uint style, int32 left, uint32 right) const;
	int getGlyphWidth(uint style, uint c);

	struct AsscEntry {
		uint16 _fontSize;
		uint16 _fontStyle;
		uint16 _fontID;
	};

	const Common::String &getName() { return _name; }
	uint16 getFontFamilyId() { return _ffFamID; }
	Common::Array<AsscEntry> *getAssocTable() { return &_ffAssocEntries; }

private:
	Common::String _name;

	// FOND
	uint16 _ffFlags;
	uint16 _ffFamID;
	uint16 _ffFirstChar;
	uint16 _ffLastChar;
	int16 _ffAscent;
	int16 _ffDescent;
	int16 _ffLeading;
	int16 _ffWidMax;
	uint32 _ffWTabOff;
	uint32 _ffKernOff;
	uint32 _ffStylOff;
	uint16 _ffProperty[9];
	uint16 _ffIntl[2];
	uint16 _ffVersion;

	uint16 _ffNumAssoc;
	Common::Array<AsscEntry> _ffAssocEntries;

	uint16 _ffNumOffsets;
	uint32 *_ffOffsets;

	struct BBoxEntry {
		uint16 _style;
		int16 _left;
		int16 _bottom;
		int16 _right;
		int16 _top;
	};

	uint16 _ffNumBBoxes;
	Common::Array<BBoxEntry> _ffBBoxes;

	struct KernPair {
		byte _firstChar;
		byte _secondChar;
		uint16 _distance;
	};

	struct KernEntry {
		uint16 _style;
		uint16 _entryLength;
		Common::Array<KernPair> _kernPairs;

		Common::HashMap<uint16, int16> _kernTable;
	};

	uint16 _ffNumKerns;
	Common::Array<KernEntry> _ffKernEntries;

	struct StyleWidthEntry {
		uint16 _style;
		Common::Array<uint16> _widths;
	};

	uint16 _ffNumStyleWidths;
	Common::Array<StyleWidthEntry> _ffStyleWidths;
};

struct MacGlyph {
	void clear() {
		bitmapOffset = 0;
		width1 = 0;
		height = 0;
		bitmapWidth = 0;
		kerningOffset = 0;
		width = 0;
	}

	uint16 bitmapOffset;
	uint16 height;
	uint16 bitmapWidth;
	uint16 width1;	// this width is from glyph-table, which has the higher priority
	byte width;	// this width is from width/offset table
	int kerningOffset;
};

struct MacFONTdata {
	uint16 _fontType;
	uint16 _firstChar;
	uint16 _lastChar;
	uint16 _maxWidth;
	int16  _kernMax;
	int16  _nDescent;
	uint16 _fRectWidth;
	uint16 _fRectHeight;
	uint32 _owTLoc;
	uint16 _ascent;
	uint16 _descent;
	uint16 _leading;
	uint16 _rowWords;
	uint16 _surfHeight;

	byte *_bitImage;

	Common::Array<MacGlyph> _glyphs;
	MacGlyph _defaultChar;

	MacFontFamily *_family;
	int _size;
	int _style;

	// currently only available in generated fonts
	int _slant;
};

/**
 * Processing of Mac FONT/NFNT rResources
 */
class MacFONTFont : public Font {
public:
	MacFONTFont();
	MacFONTFont(const MacFONTdata &data);
	virtual ~MacFONTFont();

	virtual int getFontHeight() const { return _data._fRectHeight + getFontLeading(); }
	virtual int getFontAscent() const { return _data._ascent; }
	virtual int getFontDescent() const { return _data._descent; }
	virtual int getFontLeading() const { return _data._leading; }
	virtual int getMaxCharWidth() const { return _data._maxWidth; }
	virtual int getCharWidth(uint32 chr) const;
	virtual void drawChar(Surface *dst, uint32 chr, int x, int y, uint32 color) const;

	bool loadFont(Common::SeekableReadStream &stream, MacFontFamily *family = nullptr, int size = 12, int style = 0);

	virtual int getKerningOffset(uint32 left, uint32 right) const;

	int getFontSize() const { return _data._size; }

	static MacFONTFont *scaleFont(const MacFONTFont *src, int newSize, int slant);
	static void testBlit(const MacFONTFont *src, ManagedSurface *dst, int color, int x0, int y0, int width);

private:
	MacFONTdata _data;

	const MacGlyph *findGlyph(uint32 c) const;
};

} // End of namespace Graphics

#endif