font.cc

Go to the documentation of this file.

/*
 *  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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif

#include "U7file.h"
#include "databuf.h"
#include "font.h"
#include "ibuf8.h"
#include "vgafile.h"
#include "exceptions.h"

#ifndef UNDER_CE
using std::cout;
using std::endl;
using std::size_t;
using std::string;
using std::strncmp;
#endif

FontManager fontManager;

//  Want a more restrictive test for space.
inline bool Is_space(char c)
  { return c == ' ' || c == '\n' || c == '\t'; }

/*
 *  Pass space.
 */

static const char *Pass_space
  (
  const char *text
  )
  {
  while (Is_space(*text))
    text++;
  return (text);
  }

/*
 *  Pass a word.
 */

static const char *Pass_word
  (
  const char *text
  )
  {
  while (*text && (!Is_space(*text) || (*text == '\f') || (*text == '\v')))
    text++;
  return (text);
  }

/*
 *  Draw text within a rectangular area.
 *  Special characters handled are:
 *    \n  New line.
 *    space Word break.
 *    tab Treated like a space for now.
 *
 *  Output: If out of room, -offset of end of text painted.
 *    Else height of text painted.
 */

int Font::paint_text_box
  (
  Image_buffer8 *win,   // Buffer to paint in.
  const char *text,
  int x, int y,     // Top-left corner of box.
  int w, int h,     // Dimensions.
  int vert_lead,      // Extra spacing between lines.
  int pbreak      // End at punctuation.
  )
  {
  const char *start = text; // Remember the start.
  win->set_clip(x, y, w, h);
  int endx = x + w;   // Figure where to stop.
  int curx = x, cury = y;
  int height = get_text_height() + vert_lead + ver_lead;
  int space_width = get_text_width(" ", 1);
  int max_lines = h/height; // # lines that can be shown.
  string *lines = new string[max_lines + 1];
  int cur_line = 0;
  const char *last_punct_end = 0;// ->last period, qmark, etc.
          // Last punct in 'lines':
  int last_punct_line = -1, last_punct_offset = -1;

  while (*text)
    {
    switch (*text)    // Special cases.
      {
    case '\n':    // Next line.
      curx = x;
      text++;
      cur_line++;
      if (cur_line >= max_lines)
        break;  // No more room.
      continue;
    case '\r':    //??
      text++;
      continue;
    case ' ':   // Space.
    case '\t':
      {   // Pass space.
      const char *wrd = Pass_space(text);
      if (wrd != text)
        {
        int w = get_text_width(text, wrd - text);
        if (w <= 0)
          w = space_width;
        int nsp = w/space_width;
        lines[cur_line].append(nsp, ' ');
        curx += nsp*space_width;
        }
      text = wrd;
      break;
      }
      }

    if (cur_line >= max_lines)
      break;
          // Pass word & get its width.
    const char *ewrd = Pass_word(text);
    int width = get_text_width(text, ewrd - text);
    if (curx + width - hor_lead > endx)
      {   // Word-wrap.
      curx = x;
      cur_line++;
      if (cur_line >= max_lines)
        break;  // No more room.
      }

          // Store word.
    lines[cur_line].append(text, ewrd - text);
    curx += width;
    text = ewrd;    // Continue past the word.
          // Keep loc. of punct. endings.
    if (text[-1] == '.' || text[-1] == '?' || text[-1] == '!' ||
        text[-1] == ',')
      {
      last_punct_end = text;
      last_punct_line = cur_line;
      last_punct_offset = lines[cur_line].length();
      }
    }
  if (*text &&      // Out of room?
          // Break off at end of punct.
       pbreak && last_punct_end)
    text = Pass_space(last_punct_end);
  else
    last_punct_line = -1;
          // Render text.
  for (int i = 0; i <= cur_line; i++)
    {
    const char *str = lines[i].data();
    int len = lines[i].length();
    if (i == last_punct_line)
      len = last_punct_offset;
    paint_text(win, str, len, x, cury);
    cury += height;
    if (i == last_punct_line)
      break;
    }
  win->clear_clip();
  delete [] lines;
  if (*text)      // Out of room?
    return -(text - start); // Return -offset of end.
  else        // Else return height.
    return (cury - y);
  }

/*
 *  Draw text at a given location (which is the upper-left corner of the
 *  place to draw.
 *
 *  Output: Width in pixels of what was drawn.
 */

int Font::paint_text
  (
  Image_buffer8 *win,   // Buffer to paint in.
  const char *text,   // What to draw, 0-delimited.
  int xoff, int yoff    // Upper-left corner of where to start.
  )
  {
  int x = xoff;
  int chr;
  yoff += get_text_baseline();
  if (font_shapes)
    while ((chr = *text++) != 0)
      {
      Shape_frame *shape = font_shapes->get_frame((unsigned char)chr);
      if (!shape)
        continue;
      shape->paint_rle(x, yoff);
      x += shape->get_width() + hor_lead;
      }
  return (x - xoff);
  }

/*
 *  Paint text using font from "fonts.vga".
 *
 *  Output: Width in pixels of what was painted.
 */

int Font::paint_text
  (
  Image_buffer8 *win,   // Buffer to paint in.
  const char *text,   // What to draw.
  int textlen,      // Length of text.
  int xoff, int yoff    // Upper-left corner of where to start.
  )
  {
  int x = xoff;
  yoff += get_text_baseline();
  if (font_shapes)
    while (textlen--)
      {
      Shape_frame *shape= font_shapes->get_frame((unsigned char)*text++);
      if (!shape)
        continue;
      shape->paint_rle(x, yoff);
      x += shape->get_width() + hor_lead;
      }
  return (x - xoff);
  }

/*
 *
 *  FIXED WIDTH RENDERING
 *
 */

/*
 *  Draw text within a rectangular area.
 *  Special characters handled are:
 *    \n  New line.
 *    space Word break.
 *    tab Treated like a space for now.
 *
 *  Output: If out of room, -offset of end of text painted.
 *    Else height of text painted.
 */

int Font::paint_text_box_fixedwidth
  (
  Image_buffer8 *win,   // Buffer to paint in.
  const char *text,
  int x, int y,     // Top-left corner of box.
  int w, int h,     // Dimensions.
  int char_width,     // Width of each character
  int vert_lead,      // Extra spacing between lines.
  int pbreak      // End at punctuation.
  )
  {
  const char *start = text; // Remember the start.
  win->set_clip(x, y, w, h);
  int endx = x + w;   // Figure where to stop.
  int curx = x, cury = y;
  int height = get_text_height() + vert_lead + ver_lead;
  int max_lines = h/height; // # lines that can be shown.
  string *lines = new string[max_lines + 1];
  int cur_line = 0;
  const char *last_punct_end = 0;// ->last period, qmark, etc.
          // Last punct in 'lines':
  int last_punct_line = -1, last_punct_offset = -1;

  while (*text)
    {
    switch (*text)    // Special cases.
      {
    case '\n':    // Next line.
      curx = x;
      text++;
      cur_line++;
      if (cur_line >= max_lines)
        break;  // No more room.
      continue;
    case ' ':   // Space.
    case '\t':
      {   // Pass space.
      const char *wrd = Pass_space(text);
      if (wrd != text)
        {
        int w = (wrd - text) * char_width;
        if (!w)
          w = char_width;
        int nsp = w/char_width;
        lines[cur_line].append(nsp, ' ');
        curx += nsp*char_width;
        }
      text = wrd;
      break;
      }
      }

    if (cur_line >= max_lines)
      break;
          // Pass word & get its width.
    const char *ewrd = Pass_word(text);
    int width = (ewrd - text) * char_width;
    if (curx + width - hor_lead > endx)
      {   // Word-wrap.
      curx = x;
      cur_line++;
      if (cur_line >= max_lines)
        break;  // No more room.
      }

          // Store word.
    lines[cur_line].append(text, ewrd - text);
    curx += width;
    text = ewrd;    // Continue past the word.
          // Keep loc. of punct. endings.
    if (text[-1] == '.' || text[-1] == '?' || text[-1] == '!' ||
        text[-1] == ',')
      {
      last_punct_end = text;
      last_punct_line = cur_line;
      last_punct_offset = lines[cur_line].length();
      }
    }
  if (*text &&      // Out of room?
          // Break off at end of punct.
       pbreak && last_punct_end)
    text = Pass_space(last_punct_end);
  else
    last_punct_line = -1;
          // Render text.
  for (int i = 0; i <= cur_line; i++)
    {
    const char *str = lines[i].data();
    int len = lines[i].length();
    if (i == last_punct_line)
      len = last_punct_offset;
    paint_text_fixedwidth(win, str, len, x, cury, char_width);
    cury += height;
    if (i == last_punct_line)
      break;
    }
  win->clear_clip();
  delete [] lines;
  if (*text)      // Out of room?
    return -(text - start); // Return -offset of end.
  else        // Else return height.
    return (cury - y);
  }

/*
 *  Draw text at a given location (which is the upper-left corner of the
 *  place to draw. Text will be drawn with the fixed width specified.
 *
 *  Output: Width in pixels of what was drawn.
 */

int Font::paint_text_fixedwidth
  (
  Image_buffer8 *win,   // Buffer to paint in.
  const char *text,   // What to draw, 0-delimited.
  int xoff, int yoff,   // Upper-left corner of where to start.
  int width     // Width of each character
  )
  {
  int x = xoff;
  int w;
  int chr;
  yoff += get_text_baseline();
  while ((chr = *text++) != 0)
    {
    Shape_frame *shape = font_shapes->get_frame((unsigned char)chr);
    if (!shape)
      continue;
    x += w = (width - shape->get_width()) / 2;
    shape->paint_rle(x, yoff);
    x += width - w;
    }
  return (x - xoff);
  }

/*
 *  Draw text at a given location (which is the upper-left corner of the
 *  place to draw. Text will be drawn with the fixed width specified.
 *
 *  Output: Width in pixels of what was drawn.
 */

int Font::paint_text_fixedwidth
  (
  Image_buffer8 *win,   // Buffer to paint in.
  const char *text,   // What to draw.
  int textlen,      // Length of text.
  int xoff, int yoff,   // Upper-left corner of where to start.
  int width     // Width of each character
  )
  {
  int w;
  int x = xoff;
  yoff += get_text_baseline();
  while (textlen--)
    {
    Shape_frame *shape = font_shapes->get_frame((unsigned char) *text++);
    if (!shape)
      continue;
    x += w = (width - shape->get_width()) / 2;
    shape->paint_rle(x, yoff);
    x += width - w;
    }
  return (x - xoff);
  }

/*
 *  Get the width in pixels of a 0-delimited string.
 */

int Font::get_text_width
  (
  const char *text
  )
  {
  int width = 0;
  short chr;
  if (font_shapes)
    while ((chr = *text++) != 0) {
      Shape_frame* shape = font_shapes->get_frame((unsigned char)chr);
      if (shape)
        width += shape->get_width() + hor_lead;
    }
  return (width);
  }

/*
 *  Get the width in pixels of a string given by length.
 */

int Font::get_text_width
  (
  const char *text,
  int textlen     // Length of text.
  )
  {
  int width = 0;
  if (font_shapes)
    while (textlen--) {
      Shape_frame* shape =font_shapes->get_frame((unsigned char)*text++);
      if (shape)
        width += shape->get_width() + hor_lead;
    }
  return (width);
  }

/*
 *  Get font line-height.
 */

int Font::get_text_height
  (
  )
  {
  // Note, I wont assume the fonts exist
  //Shape_frame *A = font_shapes->get_frame('A');
  //Shape_frame *y = font_shapes->get_frame('y');
  return highest + lowest + 1;  
  }

/*
 *  Get font baseline as the distance from the top.
 */

int Font::get_text_baseline
  (
  )
  {
  //Shape_frame *A = font_shapes->get_frame('A');
  return highest;
  }

Font::Font(): font_shapes(0), font_data(0), font_buf(0), orig_font_buf(0)
{
}

Font::Font(const char *fname, int index, int hlead, int vlead): font_shapes(0), font_data(0), font_buf(0), orig_font_buf(0)
{
  load(fname, index, hlead, vlead);
}

Font::~Font()
{
  if(font_shapes)
    delete font_shapes;
  if(font_data)
    delete font_data;
  if(orig_font_buf)
    delete [] orig_font_buf;
}

int Font::load(const char *fname, int index, int hlead, int vlead)
{
  if(font_shapes)
    delete font_shapes;
  if (font_data)
    delete font_data;
  if(orig_font_buf)
    delete [] orig_font_buf;
  font_shapes = 0;
  font_data = 0;
  orig_font_buf = 0;
  try 
  {

    size_t len;

    U7object font_obj(fname, index);
    font_buf = font_obj.retrieve(len);

    if (!font_buf || !len) throw (exult_exception ("Unable to retrieve data"));

      orig_font_buf = font_buf;
    if(!strncmp(font_buf,"font",4)) // If it's an IFF archive...
      font_buf += 8;    // Skip first 8 bytes
    font_data = new BufferDataSource(font_buf, len);
    font_shapes = new Shape_file(font_data);
    hor_lead = hlead;
    ver_lead = vlead;
    calc_highlow();
  }
  catch (exult_exception &e)
  {
    font_data = 0;
    font_shapes = 0;
    hor_lead = 0;
    ver_lead = 0;
    orig_font_buf = 0;
  }
  return 0;
}

int Font::center_text(Image_buffer8 *win, int x, int y, const char *s)
{
  return draw_text(win, x - get_text_width(s)/2, y, s);
}

void Font::calc_highlow()
{
  bool unset = true;

  for (int i = 0; i < font_shapes->get_num_frames(); i++)
  {
    Shape_frame *f = font_shapes->get_frame(i);

    if (!f) continue;

    if (unset)
    {
      unset = false;
      highest = f->get_yabove();
      lowest = f->get_ybelow();
      continue;
    }
    
    if (f->get_yabove() > highest) highest = f->get_yabove();
    if (f->get_ybelow() > lowest) lowest = f->get_ybelow();
  }
}

FontManager::FontManager()
{
}

FontManager::~FontManager()
{
  fonts.clear();
}

void FontManager::add_font(const char *name, const char *archive, int index, int hlead, int vlead)
{
  remove_font(name);

  Font *font = new Font(archive, index, hlead, vlead);
  
  fonts[name] = font;
}

void FontManager::remove_font(const char *name)
{
  if(fonts[name]!=0) {
    delete fonts[name];
    fonts.erase(name);
  }
}

Font *FontManager::get_font(const char *name)
{
  return fonts[name];
}

void FontManager::reset()
{
#ifndef DONT_HAVE_HASH_MAP
  hash_map<const char*, Font*, hashstr, eqstr>::iterator i;
#else
  std::map<const char*, Font*, ltstr>::iterator i;
#endif

  for (i=fonts.begin(); i != fonts.end(); ++i) {
    delete (*i).second;
  }

  fonts.clear();
}

---