/usr/include/guichan/imagefont.hpp is in libguichan-dev 0.8.2-13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | /* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naessén a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* 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.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* 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 GCN_IMAGEFONT_HPP
#define GCN_IMAGEFONT_HPP
#include <string>
#include "guichan/font.hpp"
#include "guichan/platform.hpp"
#include "guichan/rectangle.hpp"
namespace gcn
{
class Color;
class Graphics;
class Image;
/**
* A font using an image containing the font data. ImageFont can be used
* with any image supported by the currently used ImageLoader.
*
* These are two examples of an image containing a font.
* \image html imagefontexample.bmp
* \image html imagefontexample2.bmp
*
* The first pixel at coordinate (0,0) tells which color the image font
* looks for when seperating glyphs. The glyphs in the image is provided
* to the image font's constructor in the order they appear in the image.
*
* To create an ImageFont from the first image example above the following
* constructor call should be made:
* @code gcn::ImageFont imageFont("fixedfont_big.bmp"," abcdefghijklmno\
pqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"); @endcode
*
* Noteworthy is that the first glyph actually gives the width of space.
* Glyphs can, as seen in the second image example above, be seperated with
* horizontal lines making it possible to draw glyphs on more then one
* line in the image. However, these horizontal lines must have a height of
* one pixel!
*/
class GCN_CORE_DECLSPEC ImageFont: public Font
{
public:
/**
* Constructor. Takes an image file containing the font and
* a string containing the glyphs. The glyphs in the string should
* be in the same order as they appear in the font image.
*
* @param filename The filename of the image.
* @param glyphs The glyphs found in the image.
* @throws Exception when glyph list is incorrect or the font file is
* corrupt or if no ImageLoader exists.
*/
ImageFont(const std::string& filename, const std::string& glyphs);
/**
* Constructor. Takes an image containing the font and
* a string containing the glyphs. The glyphs in the string should
* be in the same order as they appear in the font image.
* The image will be deleted in the destructor.
*
* @param image The image with font glyphs.
* @param glyphs The glyphs found in the image.
* @throws Exception when glyph list is incorrect or the font image is
* is missing.
*/
ImageFont(Image* image, const std::string& glyphs);
/**
* Constructor. Takes an image file containing the font and
* two boundaries of ASCII values. The font image should include
* all glyphs specified with the boundaries in increasing ASCII
* order. The boundaries are inclusive.
*
* @param filename The filename of the image.
* @param glyphsFrom The ASCII value of the first glyph found in the
* image.
* @param glyphsTo The ASCII value of the last glyph found in the
* image.
* @throws Exception when glyph bondaries are incorrect or the font
* file is corrupt or if no ImageLoader exists.
*/
ImageFont(const std::string& filename,
unsigned char glyphsFrom=32,
unsigned char glyphsTo=126);
/**
* Destructor.
*/
virtual ~ImageFont();
/**
* Draws a glyph.
*
* NOTE: You normally won't use this function to draw text since
* the Graphics class contains better functions for drawing
* text.
*
* @param graphics A graphics object used for drawing.
* @param glyph A glyph to draw.
* @param x The x coordinate where to draw the glyph.
* @param y The y coordinate where to draw the glyph.
* @return The width of the glyph in pixels.
*/
virtual int drawGlyph(Graphics* graphics, unsigned char glyph,
int x, int y);
/**
* Sets the space between rows in pixels. Default is 0 pixels.
* The space can be negative.
*
* @param spacing The space between rows in pixels.
* @see getRowSpacing
*/
virtual void setRowSpacing(int spacing);
/**
* Gets the space between rows in pixels.
*
* @return The space between rows in pixels.
* @see setRowSpacing
*/
virtual int getRowSpacing();
/**
* Sets the spacing between glyphs in pixels. Default is 0 pixels.
* The space can be negative.
*
* @param spacing The glyph space in pixels.
* @see getGlyphSpacing
*/
virtual void setGlyphSpacing(int spacing);
/**
* Gets the spacing between letters in pixels.
*
* @return the spacing.
* @see setGlyphSpacing
*/
virtual int getGlyphSpacing();
/**
* Gets a width of a glyph in pixels.
*
* @param glyph The glyph which width will be returned.
* @return The width of a glyph in pixels.
*/
virtual int getWidth(unsigned char glyph) const;
// Inherited from Font
virtual int getWidth(const std::string& text) const;
virtual void drawString(Graphics* graphics, const std::string& text,
int x, int y);
virtual int getHeight() const;
virtual int getStringIndexAt(const std::string& text, int x) const;
protected:
/**
* Scans for a certain glyph.
*
* @param glyph The glyph to scan for. Used for exception messages.
* @param x The x coordinate where to begin the scan. The coordinate
* will be updated with the end x coordinate of the glyph
* when the scan is complete.
* @param y The y coordinate where to begin the scan. The coordinate
* will be updated with the end y coordinate of the glyph
* when the scan is complete.
* @param separator The color separator to look for where the glyph ends.
* @return A rectangle with the found glyph dimension in the image
* with the font.
* @throws Exception when no glyph is found.
*/
Rectangle scanForGlyph(unsigned char glyph,
int x,
int y,
const Color& separator);
/**
* Holds the glyphs areas in the image.
*/
Rectangle mGlyph[256];
/**
* Holds the height of the image font.
*/
int mHeight;
/**
* Holds the glyph spacing of the image font.
*/
int mGlyphSpacing;
/**
* Holds the row spacing of the image font.
*/
int mRowSpacing;
/**
* Holds the image with the font data.
*/
Image* mImage;
/**
* Holds the filename of the image with the font data.
*/
std::string mFilename;
};
}
#endif // end GCN_IMAGEFONT_HPP
|