Font Class Reference

#include <font.hpp>

List of all members.

Public Types
enum	GlyphWidth { FIXED, VARIABLE }
Public Member Functions
	Font (GlyphWidth glyph_width, const std::string &fontfile, int shadowsize=2)
	Construct a fixed-width font.
	~Font ()
float	get_text_width (const std::string &text) const
	returns the width of a given text.
float	get_text_height (const std::string &text) const
	returns the height of a given text.
float	get_height () const
	returns the height of the font.
std::string	wrap_to_width (const std::string &text, float width, std::string *overflow)
	returns the given string, truncated (preferably at whitespace) to be at most "width" pixels wide
void	draw (Renderer *renderer, const std::string &text, const Vector &pos, FontAlignment alignment=ALIGN_LEFT, DrawingEffect drawing_effect=NO_EFFECT, Color color=Color(1.0, 1.0, 1.0), float alpha=1.0f) const
	Draws the given text to the screen.
Static Public Member Functions
static std::string	wrap_to_chars (const std::string &text, int max_chars, std::string *overflow)
	returns the given string, truncated (preferably at whitespace) to be at most max_chars characters long
Private Member Functions
void	draw_text (Renderer *renderer, const std::string &text, const Vector &pos, DrawingEffect drawing_effect=NO_EFFECT, Color color=Color(1.0, 1.0, 1.0), float alpha=1.0f) const
void	draw_chars (Renderer *renderer, bool nonshadow, const std::string &text, const Vector &position, DrawingEffect drawing_effect, Color color, float alpha) const
void	loadFontFile (const std::string &filename)
void	loadFontSurface (const std::string &glyphimage, const std::string &shadowimage, const std::vector< std::string > &chars, GlyphWidth glyph_width, int char_width)
Private Attributes
GlyphWidth	glyph_width
std::vector< SurfacePtr >	glyph_surfaces
std::vector< SurfacePtr >	shadow_surfaces
int	char_height
int	shadowsize
std::vector< Glyph >	glyphs
	65536 of glyphs
Friends
class	DrawingContext
Classes
struct	Glyph

---

Detailed Description

Definition at line 38 of file font.hpp.

---

Member Enumeration Documentation

enum Font::GlyphWidth

Enumerator:

FIXED
VARIABLE

Definition at line 41 of file font.hpp.

                  {
    FIXED,
    VARIABLE
  };

---

Constructor & Destructor Documentation

Font::Font	(	GlyphWidth	glyph_width,
		const std::string &	fontfile,
		int	shadowsize = 2
	)

Construct a fixed-width font.

Parameters:

	glyph_width	VARIABLE for proportional fonts, VARIABLE for monospace ones
	fontfile	file in format supertux-font
	sgadowsize	offset of shadow

Definition at line 57 of file font.cpp.

References FileSystem::basename(), FileSystem::dirname(), glyphs, and loadFontFile().

                            :
  glyph_width(glyph_width_),
  glyph_surfaces(),
  shadow_surfaces(),
  char_height(),
  shadowsize(shadowsize_),
  glyphs(65536)
{
  for(unsigned int i=0; i<65536;i++) glyphs[i].surface_idx = -1;

  const std::string fontdir = FileSystem::dirname(filename);
  const std::string fontname = FileSystem::basename(filename);

  // scan for prefix-filename in addons search path
  char **rc = PHYSFS_enumerateFiles(fontdir.c_str());
  for (char **i = rc; *i != NULL; i++) {
    std::string filename(*i);
    if( filename.rfind(fontname) != std::string::npos ) {
      loadFontFile(fontdir + filename);
    }
  }
  PHYSFS_freeList(rc);
}

Font::~Font

(

)

Definition at line 244 of file font.cpp.

{
}

---

Member Function Documentation

float Font::get_text_width

(

const std::string &

text

)

const

returns the width of a given text.

(Note that I won't add a normal get_width function here, as we might switch to variable width fonts in the future.) Supports breaklines.

Definition at line 249 of file font.cpp.

References glyphs.

Referenced by draw(), and wrap_to_width().

{
  float curr_width = 0;
  float last_width = 0;

  for(UTF8Iterator it(text); !it.done(); ++it)
  {
    if (*it == '\n')
    {
      last_width = std::max(last_width, curr_width);
      curr_width = 0;
    }
    else
    {
      if( glyphs.at(*it).surface_idx != -1 )
        curr_width += glyphs[*it].advance;
      else 
        curr_width += glyphs[0x20].advance;
    }
  }

  return std::max(curr_width, last_width);
}

float Font::get_text_height

(

const std::string &

text

)

const

returns the height of a given text.

This function supports breaklines. In case, you are positive that your text doesn't use break lines, you can just use get_height().

Definition at line 274 of file font.cpp.

References char_height.

{
  std::string::size_type text_height = char_height;

  for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
  { // since UTF8 multibyte characters are decoded with values
    // outside the ASCII range there is no risk of overlapping and
    // thus we don't need to decode the utf-8 string
    if (*it == '\n')
      text_height += char_height + 2;
  }

  return text_height;
}

float Font::get_height

(

)

const

returns the height of the font.

Definition at line 290 of file font.cpp.

References char_height.

{
  return char_height;
}

std::string Font::wrap_to_chars	(	const std::string &	text,
		int	max_chars,
		std::string *	overflow
	)			[static]

returns the given string, truncated (preferably at whitespace) to be at most max_chars characters long

Definition at line 296 of file font.cpp.

Referenced by Console::addLine().

{
  // if text is already smaller, return full text
  if ((int)s.length() <= line_length) {
    if (overflow) *overflow = "";
    return s;
  }

  // if we can find a whitespace character to break at, return text up to this character
  int i = line_length;
  while ((i > 0) && (s[i] != ' ')) i--;
  if (i > 0) {
    if (overflow) *overflow = s.substr(i+1);
    return s.substr(0, i);
  }

  // FIXME: wrap at line_length, taking care of multibyte characters
  if (overflow) *overflow = "";
  return s;
}

std::string Font::wrap_to_width	(	const std::string &	text,
		float	width,
		std::string *	overflow
	)

returns the given string, truncated (preferably at whitespace) to be at most "width" pixels wide

Definition at line 318 of file font.cpp.

References get_text_width().

{
  std::string s = s_;

  // if text is already smaller, return full text
  if (get_text_width(s) <= width) {
    if (overflow) *overflow = "";
    return s;
  }

  // if we can find a whitespace character to break at, return text up to this character
  for (int i = s.length()-1; i >= 0; i--) {
    std::string s2 = s.substr(0,i);
    if (s[i] != ' ') continue;
    if (get_text_width(s2) <= width) {
      if (overflow) *overflow = s.substr(i+1);
      return s.substr(0, i);
    }
  }
  
  // FIXME: hard-wrap at width, taking care of multibyte characters
  if (overflow) *overflow = "";
  return s;
}

void Font::draw	(	Renderer *	renderer,
		const std::string &	text,
		const Vector &	pos,
		FontAlignment	alignment = ALIGN_LEFT,
		DrawingEffect	drawing_effect = NO_EFFECT,
		Color	color = Color(1.0, 1.0, 1.0),
		float	alpha = 1.0f
	)			const

Draws the given text to the screen.

Also needs the position. Type of alignment, drawing effect and alpha are optional.

Definition at line 344 of file font.cpp.

References ALIGN_CENTER, ALIGN_RIGHT, char_height, draw_text(), get_text_width(), Vector::x, and Vector::y.

Referenced by DrawingContext::handle_drawing_requests().

{
  float x = pos_.x;
  float y = pos_.y;

  std::string::size_type last = 0;
  for(std::string::size_type i = 0;; ++i)
  {
    if (text[i] == '\n' || i == text.size())
    {
      std::string temp = text.substr(last, i - last);

      // calculate X positions based on the alignment type
      Vector pos = Vector(x, y);

      if(alignment == ALIGN_CENTER)
        pos.x -= get_text_width(temp) / 2;
      else if(alignment == ALIGN_RIGHT)
        pos.x -= get_text_width(temp);

      // Cast font position to integer to get a clean drawing result and
      // no blurring as we would get with subpixel positions
      pos.x = static_cast<int>(pos.x);

      draw_text(renderer, temp, pos, drawing_effect, color, alpha);

      if (i == text.size())
        break;

      y += char_height + 2;
      last = i + 1;
    }
  }
}

void Font::draw_text	(	Renderer *	renderer,
		const std::string &	text,
		const Vector &	pos,
		DrawingEffect	drawing_effect = NO_EFFECT,
		Color	color = Color(1.0, 1.0, 1.0),
		float	alpha = 1.0f
	)			const [private]

Definition at line 382 of file font.cpp.

References draw_chars(), and shadowsize.

Referenced by draw().

{
  if(shadowsize > 0)
    draw_chars(renderer, false, text, 
               pos + Vector(shadowsize, shadowsize), drawing_effect, Color(1,1,1), alpha);

  draw_chars(renderer, true, text, pos, drawing_effect, color, alpha);
}

void Font::draw_chars	(	Renderer *	renderer,
		bool	nonshadow,
		const std::string &	text,
		const Vector &	position,
		DrawingEffect	drawing_effect,
		Color	color,
		float	alpha
	)			const [private]

Definition at line 393 of file font.cpp.

References Font::Glyph::advance, DrawingRequest::alpha, char_height, DrawingRequest::color, Renderer::draw_surface_part(), DrawingRequest::drawing_effect, glyph_surfaces, glyphs, Font::Glyph::offset, Rectf::p1, Rectf::p2, DrawingRequest::pos, Font::Glyph::rect, DrawingRequest::request_data, shadow_surfaces, SurfacePartRequest::size, SurfacePartRequest::source, SurfacePartRequest::surface, Font::Glyph::surface_idx, Vector::x, and Vector::y.

Referenced by draw_text().

{
  Vector p = pos;

  for(UTF8Iterator it(text); !it.done(); ++it)
  {
    if(*it == '\n')
    {
      p.x = pos.x;
      p.y += char_height + 2;
    }
    else if(*it == ' ')
    {
      p.x += glyphs[0x20].advance;
    }
    else
    {
      Glyph glyph;
      if( glyphs.at(*it).surface_idx != -1 )
        glyph = glyphs[*it];
      else 
        glyph = glyphs[0x20];

      DrawingRequest request;

      request.pos = p + glyph.offset;
      request.drawing_effect = drawing_effect;
      request.color = color;
      request.alpha = alpha;

      SurfacePartRequest surfacepartrequest;
      surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
      surfacepartrequest.source = glyph.rect.p1;
      surfacepartrequest.surface = notshadow ? glyph_surfaces[glyph.surface_idx].get() : shadow_surfaces[glyph.surface_idx].get();

      request.request_data = &surfacepartrequest;
      renderer->draw_surface_part(request);

      p.x += glyph.advance;
    }
  }
}

void Font::loadFontFile

(

const std::string &

filename

)

[private]

Definition at line 84 of file font.cpp.

References char_height, FIXED, lisp::Lisp::get(), lisp::Lisp::get_lisp(), glyph_width, loadFontSurface(), log_debug, log_warning, lisp::Parser::parse(), and VARIABLE.

Referenced by Font().

{
  lisp::Parser parser;
  log_debug << "Loading font: " << filename << std::endl;
  const lisp::Lisp* root = parser.parse(filename);
  const lisp::Lisp* config_l = root->get_lisp("supertux-font");

  if(!config_l) {
    std::ostringstream msg;
    msg << "Font file:" << filename << ": is not a supertux-font file";
    throw std::runtime_error(msg.str());
  }

  int def_char_width=0;

  if( !config_l->get("glyph-width",def_char_width) ) {
    log_warning << "Font:"<< filename << ": misses default glyph-width" << std::endl;
  }
  
  if( !config_l->get("glyph-height",char_height) ) {
    std::ostringstream msg;
    msg << "Font:" << filename << ": misses glyph-height";
    throw std::runtime_error(msg.str());
  }

  lisp::ListIterator iter(config_l);
  while(iter.next()) {
    const std::string& token = iter.item();
    if( token == "surface" ) {
      const lisp::Lisp * glyphs_val = iter.lisp();
      int local_char_width;
      bool monospaced;
      GlyphWidth local_glyph_width;
      std::string glyph_image;
      std::string shadow_image;
      std::vector<std::string> chars;
      if( ! glyphs_val->get("glyph-width", local_char_width) ) {
        local_char_width = def_char_width;
      }
      if( ! glyphs_val->get("monospace", monospaced ) ) {
        local_glyph_width = glyph_width;
      }
      else {
        if( monospaced ) local_glyph_width = FIXED;
        else local_glyph_width = VARIABLE;
      }
      if( ! glyphs_val->get("glyphs", glyph_image) ) {
        std::ostringstream msg;
        msg << "Font:" << filename << ": missing glyphs image";
        throw std::runtime_error(msg.str());
      }
      if( ! glyphs_val->get("shadows", shadow_image) ) {
        std::ostringstream msg;
        msg << "Font:" << filename << ": missing shadows image";
        throw std::runtime_error(msg.str());
      }
      if( ! glyphs_val->get("chars", chars) || chars.size() == 0) {
        std::ostringstream msg;
        msg << "Font:" << filename << ": missing chars definition";
        throw std::runtime_error(msg.str());
      }

      if( local_char_width==0 ) {
        std::ostringstream msg;
        msg << "Font:" << filename << ": misses glyph-width for some surface";
        throw std::runtime_error(msg.str());
      }

      loadFontSurface(glyph_image, shadow_image, chars,
                      local_glyph_width, local_char_width);
    }
  }
}

void Font::loadFontSurface	(	const std::string &	glyphimage,
		const std::string &	shadowimage,
		const std::vector< std::string > &	chars,
		GlyphWidth	glyph_width,
		int	char_width
	)			[private]

Definition at line 159 of file font.cpp.

References Font::Glyph::advance, char_height, Surface::create(), FIXED, get_physfs_SDLRWops(), glyph_surfaces, glyphs, Font::Glyph::offset, Font::Glyph::rect, shadow_surfaces, Font::Glyph::surface_idx, VARIABLE, and vline_empty().

Referenced by loadFontFile().

{
  SurfacePtr glyph_surface  = Surface::create("images/engine/fonts/" + glyphimage);
  SurfacePtr shadow_surface = Surface::create("images/engine/fonts/" + shadowimage);

  int surface_idx = glyph_surfaces.size();
  glyph_surfaces.push_back(glyph_surface);
  shadow_surfaces.push_back(shadow_surface);

  int row=0, col=0;
  int wrap = glyph_surface->get_width() / char_width;
 
  SDL_Surface *surface = NULL;
  
  if( glyph_width == VARIABLE ) {
    //this does not work:
    // surface = ((SDL::Texture *)glyph_surface.get_texture())->get_texture();
    surface = IMG_Load_RW(get_physfs_SDLRWops("images/engine/fonts/"+glyphimage), 1);
    if(surface == NULL) {
      std::ostringstream msg;
      msg << "Couldn't load image '" << glyphimage << "' :" << SDL_GetError();
      throw std::runtime_error(msg.str());
    }
    SDL_LockSurface(surface);
  }

  for( unsigned int i = 0; i < chars.size(); i++) {
    for(UTF8Iterator chr(chars[i]); !chr.done(); ++chr) {
      int y = row * char_height;
      int x = col * char_width;
      if( ++col == wrap ) { col=0; row++; }
      if( *chr == 0x0020 && glyphs[0x20].surface_idx != -1) continue;
        
      Glyph glyph;
      glyph.surface_idx   = surface_idx;
      
      if( glyph_width == FIXED ) 
      {
        glyph.rect    = Rectf(x, y, x + char_width, y + char_height);
        glyph.offset  = Vector(0, 0);
        glyph.advance = char_width;
      }
      else 
      {
        int left = x;
        while (left < x + char_width && vline_empty(surface, left, y, y + char_height, 64))
          left += 1;
        int right = x + char_width - 1;
        while (right > left && vline_empty(surface, right, y, y + char_height, 64))
          right -= 1;
          
        if (left <= right) 
        {
          glyph.offset  = Vector(x-left, 0);
          glyph.advance = right - left + 1 + 1; // FIXME: might be useful to make spacing configurable
        } 
        else 
        { // glyph is completly transparent
          glyph.offset  = Vector(0, 0);
          glyph.advance = char_width + 1; // FIXME: might be useful to make spacing configurable
        }

        glyph.rect = Rectf(x,  y, x + char_width, y + char_height);
      }

      glyphs[*chr] = glyph;
    }
    if( col>0 && col <= wrap ) { 
      col = 0;
      row++;
    }
  }
  
  if( surface != NULL ) {
    SDL_UnlockSurface(surface);
    SDL_FreeSurface(surface);
  }
}

---

Friends And Related Function Documentation

friend class DrawingContext [friend]

Definition at line 93 of file font.hpp.

---

Member Data Documentation

GlyphWidth Font::glyph_width [private]

Definition at line 134 of file font.hpp.

Referenced by loadFontFile().

std::vector<SurfacePtr> Font::glyph_surfaces [private]

Definition at line 136 of file font.hpp.

Referenced by draw_chars(), and loadFontSurface().

std::vector<SurfacePtr> Font::shadow_surfaces [private]

Definition at line 137 of file font.hpp.

Referenced by draw_chars(), and loadFontSurface().

int Font::char_height [private]

Definition at line 138 of file font.hpp.

Referenced by draw(), draw_chars(), get_height(), get_text_height(), loadFontFile(), and loadFontSurface().

int Font::shadowsize [private]

Definition at line 139 of file font.hpp.

Referenced by draw_text().

std::vector<Glyph> Font::glyphs [private]

65536 of glyphs

Definition at line 142 of file font.hpp.

Referenced by draw_chars(), Font(), get_text_width(), and loadFontSurface().

---

The documentation for this class was generated from the following files:

• src/video/font.hpp
• src/video/font.cpp

---