1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef GRAPHICS_FONT_H
#define GRAPHICS_FONT_H
#include "common/str.h"
namespace Common {
class SeekableReadStream;
template<class T> class Array;
}
namespace Graphics {
struct Surface;
/** Text alignment modes */
enum TextAlign {
kTextAlignInvalid,
kTextAlignLeft, ///< Text should be aligned to the left
kTextAlignCenter, ///< Text should be centered
kTextAlignRight ///< Text should be aligned to the right
};
/**
* Instances of this class represent a distinct font, with a built-in renderer.
* @todo Maybe move the high-level methods (drawString etc.) to a separate
* FontRenderer class? That way, we could have different variants... ?
*/
class Font {
public:
Font() {}
virtual ~Font() {}
/**
* Query the height of the font.
*
* @return font height.
*/
virtual int getFontHeight() const = 0;
/**
* Query the maximum width of the font.
*
* @return maximum font width.
*/
virtual int getMaxCharWidth() const = 0;
/**
* Query the width of a specific character.
*
* @param chr The character to query the width of.
* @return The character's width.
*/
virtual int getCharWidth(byte chr) const = 0;
/**
* Draw a character at a specific point on a surface.
*
* Note that the point describes the top left edge point of the
* character's bounding box.
*
* The Font implemenation should take care of not drawing outside of the
* specified surface.
*
* @param dst The surface to drawn on.
* @param chr The character to draw.
* @param x The x coordinate where to draw the character.
* @param y The y coordinate where to draw the character.
* @param color The color of the character.
*/
virtual void drawChar(Surface *dst, byte chr, int x, int y, uint32 color) const = 0;
// TODO: Add doxygen comments to this
void drawString(Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = true) const;
/**
* Compute and return the width the string str has when rendered using this font.
*/
int getStringWidth(const Common::String &str) const;
/**
* Take a text (which may contain newline characters) and word wrap it so that
* no text line is wider than maxWidth pixels. If necessary, additional line breaks
* are generated, preferably between words (i.e. where whitespaces are).
* The resulting lines are appended to the lines string list.
* It returns the maximal width of any of the new lines (i.e. a value which is less
* or equal to maxWidth).
*
* @param str the string to word wrap
* @param maxWidth the maximum width a line may have
* @param lines the string list to which the text lines from str are appended
* @return the maximal width of any of the lines added to lines
*/
int wordWrapText(const Common::String &str, int maxWidth, Common::Array<Common::String> &lines) const;
};
typedef uint16 bitmap_t; /* bitmap image unit size*/
struct BBX {
int8 w;
int8 h;
int8 x;
int8 y;
};
/* builtin C-based proportional/fixed font structure */
/* based on The Microwindows Project http://microwindows.org */
struct FontDesc {
const char * name; /* font name*/
int maxwidth; /* max width in pixels*/
int height; /* height in pixels*/
int fbbw, fbbh, fbbx, fbby; /* max bounding box */
int ascent; /* ascent (baseline) height*/
int firstchar; /* first character in bitmap*/
int size; /* font size in glyphs*/
const bitmap_t* bits; /* 16-bit right-padded bitmap data*/
const unsigned long* offset; /* offsets into bitmap data*/
const unsigned char* width; /* character widths or NULL if fixed*/
const BBX* bbx; /* character bounding box or NULL if fixed */
int defaultchar; /* default char (not glyph index)*/
long bits_size; /* # words of bitmap_t bits*/
};
struct NewFontData;
class NewFont : public Font {
protected:
FontDesc _desc;
NewFontData *_font;
public:
NewFont(const FontDesc &desc, NewFontData *font = 0) : _desc(desc), _font(font) {}
~NewFont();
virtual int getFontHeight() const { return _desc.height; }
virtual int getMaxCharWidth() const { return _desc.maxwidth; }
virtual int getCharWidth(byte chr) const;
virtual void drawChar(Surface *dst, byte chr, int x, int y, uint32 color) const;
static NewFont *loadFont(Common::SeekableReadStream &stream);
static bool cacheFontData(const NewFont &font, const Common::String &filename);
static NewFont *loadFromCache(Common::SeekableReadStream &stream);
};
#define DEFINE_FONT(n) \
const NewFont *n = 0; \
void create_##n() { \
n = new NewFont(desc); \
}
#define FORWARD_DECLARE_FONT(n) \
extern const NewFont *n; \
extern void create_##n()
#define INIT_FONT(n) \
create_##n()
} // End of namespace Graphics
#endif
|
