processing4/core/PFont.java

/* -*- mode: jde; c-basic-offset: 2; indent-tabs-mode: nil -*- */

/*
  PFont - font object for text rendering
  Part of the Processing project - http://processing.org

  Copyright (c) 2004 Ben Fry & Casey Reas
  Portions Copyright (c) 2001-04 Massachusetts Institute of Technology

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/

package processing.core;

import java.io.*;
import java.util.*;


/*
  awful ascii (non)art for how this works
  |
  |                   height is the full used height of the image
  |
  |   ..XX..       }
  |   ..XX..       }  
  |   ......       }
  |   XXXX..       }  topExtent (top y is baseline - topExtent)
  |   ..XX..       }
  |   ..XX..       }  dotted areas are where the image data
  |   ..XX..       }  is actually located for the character
  +---XXXXXX----   }  (it extends to the right & down for pow of 2 textures)
  |
  ^^^^ leftExtent (amount to move over before drawing the image

  ^^^^^^^^^^^^^^ setWidth (width displaced by char)
*/

public class PFont implements PConstants {

  //int firstChar = 33; // always
  public int charCount;
  public PImage images[];

  // image width, a power of 2
  // note! these will always be the same
  public int twidth, theight;
  // float versions of the above
  //float twidthf, theightf;

  // formerly iwidthf, iheightf.. but that's wrong
  // actually should be mbox, the font size
  float fwidth, fheight;

  // mbox is just the font size (i.e. 48 for most vlw fonts)
  public int mbox2; // next power of 2
  public int mbox;  // font size

  public int value[];  // char code
  public int height[]; // height of the bitmap data
  public int width[];  // width of bitmap data
  public int setWidth[];  // width displaced by the char
  public int topExtent[];  // offset for the top
  public int leftExtent[];  // offset for the left

  public int ascent;
  public int descent;

  // scaling, for convenience
  public float size;
  public float leading;

  int ascii[];  // quick lookup for the ascii chars
  boolean cached;


  public PFont() { }  // for PFontAI subclass and font builder


  public PFont(InputStream input) throws IOException {
    DataInputStream is = new DataInputStream(input);

    // number of character images stored in this font
    charCount = is.readInt();

    // bit count is ignored since this is always 8
    int numBits = is.readInt();

    // this was formerly ignored, now it's the actual font size
    mbox = is.readInt();
    // this was formerly mboxY, the one that was used
    // this will make new fonts downward compatible
    mbox2 = is.readInt();

    fwidth = mbox;
    fheight = mbox;

    // size for image ("texture") is next power of 2
    // over the font size. for most vlw fonts, the size is 48
    // so the next power of 2 is 64.
    // double-check to make sure that mbox2 is a power of 2
    // there was a bug in the old font generator that broke this
    mbox2 = (int) Math.pow(2, Math.ceil(Math.log(mbox2) / Math.log(2)));
    // size for the texture is stored in the font
    twidth = theight = mbox2;

    ascent  = is.readInt();  // formerly baseHt (zero/ignored)
    descent = is.readInt();  // formerly ignored struct padding

    //System.out.println("found mbox = " + mbox);
    //System.out.println("found ascent/descent = " + ascent + " " + descent);

    // allocate enough space for the character info
    value       = new int[charCount];
    height      = new int[charCount];
    width       = new int[charCount];
    setWidth    = new int[charCount];
    topExtent   = new int[charCount];
    leftExtent  = new int[charCount];

    ascii = new int[128];
    for (int i = 0; i < 128; i++) ascii[i] = -1;

    // read the information about the individual characters
    for (int i = 0; i < charCount; i++) {
      value[i]      = is.readInt();
      height[i]     = is.readInt();
      width[i]      = is.readInt();
      setWidth[i]   = is.readInt();
      topExtent[i]  = is.readInt();
      leftExtent[i] = is.readInt();

      // pointer in the c version, ignored
      is.readInt();

      // cache locations of the ascii charset
      if (value[i] < 128) ascii[value[i]] = i;

      // the values for getAscent() and getDescent() from FontMetrics
      // seem to be way too large.. perhaps they're the max? 
      // as such, use a more traditional marker for ascent/descent
      if (value[i] == 'd') {
        if (ascent == 0) ascent = topExtent[i];
      }
      if (value[i] == 'p') {
        if (descent == 0) descent = -topExtent[i] + height[i];
      }
    }

    // not a roman font, so throw an error and ask to re-build.
    // that way can avoid a bunch of error checking hacks in here.
    if ((ascent == 0) && (descent == 0)) {
      throw new RuntimeException("Please use \"Create Font\" to " +
                                 "re-create this font.");
    } 

    images = new PImage[charCount];
    for (int i = 0; i < charCount; i++) {
      //int pixels[] = new int[64 * 64];
      int pixels[] = new int[twidth * theight];
      //images[i] = new PImage(pixels, 64, 64, ALPHA);
      images[i] = new PImage(pixels, twidth, theight, ALPHA);
      int bitmapSize = height[i] * width[i];

      byte temp[] = new byte[bitmapSize];
      is.readFully(temp);

      // convert the bitmap to an alpha channel
      int w = width[i];
      int h = height[i];
      for (int y = 0; y < h; y++) {
        for (int x = 0; x < w; x++) {
          int valu = temp[y*w + x] & 0xff;
          //images[i].pixels[y*64 + x] = valu;
          images[i].pixels[y * twidth + x] = valu;
          // the following makes javagl more happy..
          // not sure what's going on
          //(valu << 24) | (valu << 16) | (valu << 8) | valu; //0xffffff;
          //System.out.print((images[i].pixels[y*64+x] > 128) ? "*" : ".");
        }
        //System.out.println();
      }
      //System.out.println();
    }
    cached = false;
    resetSize();
    resetLeading(); // ??
  }

    //static boolean isSpace(int c) {
    //return (Character.isWhitespace((char) c) ||
    //      (c == '\u00A0') || (c == '\u2007') || (c == '\u202F'));
    //}


  public void write(OutputStream output) throws IOException {
    DataOutputStream os = new DataOutputStream(output);

    os.writeInt(charCount);
    os.writeInt(8);       // numBits
    os.writeInt(mbox);    // formerly mboxX (was 64, now 48)
    os.writeInt(mbox2);   // formerly mboxY (was 64, still 64)
    os.writeInt(ascent);  // formerly baseHt (was ignored)
    os.writeInt(descent); // formerly struct padding for c version

    for (int i = 0; i < charCount; i++) {
      os.writeInt(value[i]);
      os.writeInt(height[i]);
      os.writeInt(width[i]);
      os.writeInt(setWidth[i]);
      os.writeInt(topExtent[i]);
      os.writeInt(leftExtent[i]);
      os.writeInt(0); // padding
    }

    for (int i = 0; i < charCount; i++) {
      //int bitmapSize = height[i] * width[i];
      //byte bitmap[] = new byte[bitmapSize];

      for (int y = 0; y < height[i]; y++) {
        for (int x = 0; x < width[i]; x++) {
          //os.write(images[i].pixels[y * width[i] + x] & 0xff);
          os.write(images[i].pixels[y * mbox2 + x] & 0xff);
        }
      }
    }
    os.flush();
    os.close();  // can/should i do this?
  }


  /**
   * Get index for the char (convert from unicode to bagel charset).
   * @return index into arrays or -1 if not found
   */
  public int index(char c) {
    // these chars required in all fonts
    //if ((c >= 33) && (c <= 126)) {
    //return c - 33;
    //}
    // quicker lookup for the ascii fellers
    if (c < 128) return ascii[c];

    // some other unicode char, hunt it out
    return index_hunt(c, 0, value.length-1);
  }


  // whups, this used the p5 charset rather than what was inside the font
  // meaning that old fonts would crash.. fixed for 0069

  private int index_hunt(int c, int start, int stop) {
    //System.err.println("checking between " + start + " and " + stop);
    int pivot = (start + stop) / 2;

    // if this is the char, then return it
    if (c == value[pivot]) return pivot;

    // char doesn't exist, otherwise would have been the pivot
    //if (start == stop) return -1;
    if (start >= stop) return -1;

    // if it's in the lower half, continue searching that
    if (c < value[pivot]) return index_hunt(c, start, pivot-1);

    // if it's in the upper half, continue there
    return index_hunt(c, pivot+1, stop);
  }


  public float kern(char a, char b) {
    return 0;  // * size, but since zero..
  }


  public void resetSize() {
    size = 12;
  }


  public void size(float isize) {
    size = isize;
  }


  public void resetLeading() {
    //leading = size * ((float)mbox / fheight) * 1.2f;

    // by trial & error, this seems close to illustrator
    leading = (ascent() + descent()) * 1.275f;
  }


  public void leading(float ileading) {
    leading = ileading;
  }


  public float ascent() {
    return ((float)ascent / fheight) * size;
  }


  public float descent() {
    return ((float)descent / fheight) * size;
  }


  // supposedly this should be ok even in SCREEN_SPACE mode
  // since the applet will set the 'size' of the font to twidth
  // (though this prolly breaks any sort of 'height' measurements)
  public float width(char c) {
    if (c == 32) return width('i');

    int cc = index(c);
    if (cc == -1) return 0;

    return ((float)setWidth[cc] / fwidth) * size;
  }


  public float width(String string) {
    //if (!valid) return 0;
    float wide = 0;
    float pwide = 0;
    char previous = 0;

    char s[] = string.toCharArray();
    for (int i = 0; i < s.length; i++) {
      if (s[i] == '\n') {
        if (wide > pwide) pwide = wide;
        wide = 0;
        previous = 0;

      } else {
        wide += width(s[i]);
        if (previous != 0) {
          wide += kern(previous, s[i]);
        }
        previous = s[i];
      }
    }
    return (pwide > wide) ? pwide : wide;
  }


  public void text(char c, float x, float y, PGraphics parent) {
    text(c, x, y, 0, parent);
  }


  public void text(char c, float x, float y, float z, PGraphics parent) {
    //if (!valid) return;
    //if (!exists(c)) return;

    // eventually replace this with a table
    // to convert the > 127 coded chars
    //int glyph = c - 33;
    int glyph = index(c);
    if (glyph == -1) return;

    if (!cached) {
      // cache on first run, to ensure a graphics context exists
      parent.cache(images);
      cached = true;
    }

    if (parent.text_space == OBJECT_SPACE) {
      float high    = (float) height[glyph]     / fheight;
      float bwidth  = (float) width[glyph]      / fwidth;
      float lextent = (float) leftExtent[glyph] / fwidth;
      float textent = (float) topExtent[glyph]  / fheight;

      int savedTextureMode = parent.texture_mode;
      //boolean savedSmooth = parent.smooth;
      boolean savedStroke = parent._stroke;

      parent.texture_mode = IMAGE_SPACE;
      //parent.smooth = true;
      parent.drawing_text = true;
      parent._stroke = false;

      float x1 = x + lextent * size;
      float y1 = y - textent * size;
      float x2 = x1 + bwidth * size;
      float y2 = y1 + high * size;

      // this code was moved here (instead of using parent.image)
      // because now images use tint() for their coloring, which
      // internally is kind of a hack because it temporarily sets
      // the fill color to the tint values when drawing text.
      // rather than doubling up the hack with this hack, the code
      // is just included here instead.

      //System.out.println(x1 + " " + y1 + " " + x2 + " " + y2);

      parent.beginShape(QUADS);
      parent.texture(images[glyph]);
      parent.vertex(x1, y1, z, 0, 0);
      parent.vertex(x1, y2, z, 0, height[glyph]);
      parent.vertex(x2, y2, z, width[glyph], height[glyph]);
      parent.vertex(x2, y1, z, width[glyph], 0);
      parent.endShape();

      parent.texture_mode = savedTextureMode;
      parent.drawing_text = false;
      parent._stroke = savedStroke;

    } else {  // SCREEN_SPACE
      int xx = (int) x + leftExtent[glyph];;
      int yy = (int) y - topExtent[glyph];

      int x0 = 0;
      int y0 = 0;
      int w0 = width[glyph];
      int h0 = height[glyph];

      if ((xx >= parent.width) || (yy >= parent.height) ||
          (xx + w0 < 0) || (yy + h0 < 0)) return;

      if (xx < 0) {
        x0 -= xx;
        w0 += xx;
        //System.out.println("x " + xx + " " + x0 + " " + w0);
        xx = 0;
      }
      if (yy < 0) {
        y0 -= yy;
        h0 += yy;
        //System.out.println("y " + yy + " " + y0 + " " + h0);
        yy = 0;
      }
      if (xx + w0 > parent.width) {
        //System.out.println("wide " + x0 + " " + w0);
        w0 -= ((xx + w0) - parent.width);
      }
      if (yy + h0 > parent.height) {
        h0 -= ((yy + h0) - parent.height);
      }

      int fr = parent.fillRi;
      int fg = parent.fillGi;
      int fb = parent.fillBi;
      int fa = parent.fillAi;

      int pixels1[] = images[glyph].pixels;
      int pixels2[] = parent.pixels;

      for (int row = y0; row < y0 + h0; row++) {
        for (int col = x0; col < x0 + w0; col++) {
          int a1 = (fa * pixels1[row * twidth + col]) >> 8;
          int a2 = a1 ^ 0xff;
          int p1 = pixels1[row * width[glyph] + col];
          int p2 = pixels2[(yy + row-y0)*parent.width + (xx+col-x0)];

          pixels2[(yy + row-y0)*parent.width + xx+col-x0] =
            (0xff000000 |
             (((a1 * fr + a2 * ((p2 >> 16) & 0xff)) & 0xff00) << 8) |
             (( a1 * fg + a2 * ((p2 >>  8) & 0xff)) & 0xff00) |
             (( a1 * fb + a2 * ( p2        & 0xff)) >> 8));
        }
      }
    }
  }


  // used by the text() functions to avoid over-allocation of memory
  private char c[] = new char[8192];


  public void text(String str, float x, float y, PGraphics parent) {
    text(str, x, y, 0, parent);
  }


  public void text(String str, float x, float y, float z, PGraphics parent) {
    float startX = x;
    int index = 0;
    char previous = 0;

    int length = str.length();
    if (length > c.length) {
      c = new char[length + 10];
    }
    str.getChars(0, length, c, 0);

    while (index < length) {
      if (c[index] == '\n') {
        x = startX;
        y += leading;
        //y += ascent();
        previous = 0;
      } else {
        text(c[index], x, y, z, parent);
        x += width(c[index]);
        if (previous != 0)
          x += kern(previous, c[index]);
        previous = c[index];
      }
      index++;
    }
  }


  /**
   * Same as below, just without a z coordinate.
   */
  public void text(String str, float x, float y,
                   float w, float h, PGraphics parent) {
    text(str, x, y, 0, w, h, parent);
  }


  /**
   * Draw text in a box that is constrained to a
   * particular width and height. 
   *
   * Note that the x,y coords of the start of the box 
   * will align with the *ascent* of the text, 
   * not the baseline, as is the case for the other 
   * text() functions.
   */
  public void text(String str, float x, float y, float z,
                   float w, float h, PGraphics parent) {
    float space = width(' ');
    float xx = x;
    float yy = y;
    float right = x + w;

    yy += ascent();

    String paragraphs[] = PApplet.split(str, '\n');
    for (int i = 0; i < paragraphs.length; i++) {
      String words[] = PApplet.split(paragraphs[i], ' ');
      float wide = 0;
      for (int j = 0; j < words.length; j++) {
        float size = width(words[j]);
        if (xx + size > right) {
          // this goes on the next line
          xx = x;
          yy += leading; 
          //yy += ascent() * 1.2f;
          if (yy > h) return;  // too big for box
        }
        text(words[j], xx, yy, z, parent);
        xx += size + space;
      }
      // end of paragraph, move to left and increment leading
      xx = 0;
      yy += leading;
      if (yy > h) return;  // too big for box
    }
  }


  // .................................................................


  /**
   * Draw SCREEN_SPACE text on its left edge.
   * This method is incomplete and should not be used.
   */
  public void ltext(String str, float x, float y, PGraphics parent) {
    float startY = y;
    int index = 0;
    char previous = 0;

    int length = str.length();
    if (length > c.length) {
      c = new char[length + 10];
    }
    str.getChars(0, length, c, 0);

    while (index < length) {
      if (c[index] == '\n') {
	y = startY;
	x += leading;
        previous = 0;

      } else {
        ltext(c[index], x, y, parent);
	y -= width(c[index]);
        if (previous != 0)
	  y -= kern(previous, c[index]);
        previous = c[index];
      }
      index++;
    }
  }


  /**
   * Draw SCREEN_SPACE text on its left edge.
   * This method is incomplete and should not be used.
   */
  public void ltext(char c, float x, float y, PGraphics parent) {
    //PGraphics parent = g;
    PFont font = this;

    int glyph = font.index(c);
    if (glyph == -1) return;

    //int xx = (int) x + font.leftExtent[glyph];
    //int yy = (int) y - font.topExtent[glyph];
    // starting point on the screen
    int xx = (int) x - font.topExtent[glyph];
    //+ font.leftExtent[glyph];
    //int yy = (int) y + font.leftExtent[glyph]; //- font.topExtent[glyph];
    //int yy = (int)y;
    int yy = (int) y - font.leftExtent[glyph];

    // boundary of the character's pixel buffer to copy
    int x0 = 0;
    int y0 = 0;
    int w0 = font.width[glyph];
    int h0 = font.height[glyph];

    // if the character is off the screen
    if ((xx >= parent.width) || (yy >= parent.height) ||
	(yy + w0 < 0) || (xx + h0 < 0)) return;
	//(xx + w0 < 0) || (yy + h0 < 0)) return;

    if (xx < 0) {  // if starting x is off screen
      //x0 -= xx;  // chop that amount off of the image area to be copied
      //w0 += xx;  // and reduce the width by that (negative) amount
      y0 -= xx;
      h0 += xx;
      xx = 0;
    }
    if (yy < 0) {
      //y0 -= yy;
      //h0 += yy;
      x0 -= yy;
      w0 += yy;
      yy = 0;
    }
    //if (xx + w0 > parent.width) {  // if the ending x is off screen
    if (xx + h0 > parent.width) {  // if the ending x is off screen
      //w0 -= ((xx + w0) - parent.width);
      h0 -= ((xx + h0) - parent.width);
    }
    //if (yy + h0 > parent.height) {
    if (yy + w0 > parent.height) {
      //h0 -= ((yy + h0) - parent.height);
      w0 -= ((yy + w0) - parent.height);
    }

    int fr = parent.fillRi;
    int fg = parent.fillGi;
    int fb = parent.fillBi;
    int fa = parent.fillAi;

    int pixels1[] = font.images[glyph].pixels;
    int pixels2[] = parent.pixels;

    // loop over the source pixels in the character image
    // row & col is the row and column of the source image
    // (but they become col & row in the target image)
    for (int row = y0; row < y0 + h0; row++) {
      for (int col = x0; col < x0 + w0; col++) {
	int a1 = (fa * pixels1[row * font.twidth + col]) >> 8;
	int a2 = a1 ^ 0xff;
	int p1 = pixels1[row * font.width[glyph] + col];

        try {
          //int index = (yy + row-y0)*parent.width + (xx+col-x0);
          int index = (yy + x0-col)*parent.width + (xx+row-y0);
          //int index = (yy + col)*parent.width + (xx+row-y0);
          int p2 = pixels2[index];

          pixels2[index] = 
            (0xff000000 | 
             (((a1 * fr + a2 * ((p2 >> 16) & 0xff)) & 0xff00) << 8) |
             (( a1 * fg + a2 * ((p2 >>  8) & 0xff)) & 0xff00) |
             (( a1 * fb + a2 * ( p2        & 0xff)) >> 8));
        } catch (ArrayIndexOutOfBoundsException e) {
          System.out.println("out of bounds " + yy + " " + x0 + " " + col);
        }
      }
    }
  }


  // .................................................................


  /**
   * Draw SCREEN_SPACE text on its right edge.
   * This method is incomplete and should not be used.
   */
  public void rtext(String str, float x, float y, PGraphics parent) {
    float startY = y;
    int index = 0;
    char previous = 0;

    int length = str.length();
    if (length > c.length) {
      c = new char[length + 10];
    }
    str.getChars(0, length, c, 0);

    while (index < length) {
      if (c[index] == '\n') {
	y = startY;
	x += leading;
        previous = 0;

      } else {
        rtext(c[index], x, y, parent);
	y += width(c[index]);
        if (previous != 0)
	  y += kern(previous, c[index]);
        previous = c[index];
      }
      index++;
    }
  }


  /**
   * Draw SCREEN_SPACE text on its right edge.
   * This method is incomplete and should not be used.
   */
  public void rtext(char c, float x, float y, PGraphics parent) {
    int glyph = index(c);
    if (glyph == -1) return;

    parent.stroke(150);
    parent.line(x, y, x, y+10);

    // starting point on the screen
    int sx = (int) x + topExtent[glyph];
    int sy = (int) y + leftExtent[glyph];

    // boundary of the character's pixel buffer to copy
    int px = 0;
    int py = 0;
    int pw = width[glyph];
    int ph = height[glyph];

    // if the character is off the screen
    if ((sx + ph >= parent.width) || (sy >= parent.height) ||
        (sy + pw < 0) || (sx < 0)) return;

    // off the left of screen, cut off bottom of letter
    if (sx < ph) {
      //x0 -= xx;  // chop that amount off of the image area to be copied
      //w0 += xx;  // and reduce the width by that (negative) amount
      //py0 -= xx;  // if x = -3, cut off 3 pixels from the bottom
      //ph0 += xx;
      ph -= (ph - sx);
      //sx = 0;
    }
    // off the right of the screen, cut off top of the letter
    if (sx >= parent.width) {
      int extra = sx - (parent.width-1);
      py += extra;
      ph -= extra;
      sx = parent.width-1;
    }
    // off the top, cut off left edge of letter
    if (sy < 0) {
      int extra = -sy;
      px += extra;
      pw -= extra;
      sy = 0;
    }
    // off the bottom, cut off right edge of letter
    if (sy + pw >= parent.height-1) {
      int extra = (sy + pw) - (parent.height-1);
      pw -= extra;
    }

    int fr = parent.fillRi;
    int fg = parent.fillGi;
    int fb = parent.fillBi;
    int fa = parent.fillAi;

    int fpixels[] = images[glyph].pixels;
    int spixels[] = parent.pixels;

    // loop over the source pixels in the character image
    // row & col is the row and column of the source image
    // (but they become col & row in the target image)
    for (int row = py; row < py + ph; row++) {
      for (int col = px; col < px + pw; col++) {
	int a1 = (fa * fpixels[row * twidth + col]) >> 8;
	int a2 = a1 ^ 0xff;
	int p1 = fpixels[row * width[glyph] + col];

        try {
          //int index = (yy + x0-col)*parent.width + (xx+row-y0);
          //int index = (sy + px-col)*parent.width + (sx+row-py);
          int index = (sy + px+col)*parent.width + (sx+row-py);
          int p2 = spixels[index];

          // x coord is backwards
          spixels[index] = 
            (0xff000000 | 
             (((a1 * fr + a2 * ((p2 >> 16) & 0xff)) & 0xff00) << 8) |
             (( a1 * fg + a2 * ((p2 >>  8) & 0xff)) & 0xff00) |
             (( a1 * fb + a2 * ( p2        & 0xff)) >> 8));
        } catch (ArrayIndexOutOfBoundsException e) {
          System.out.println("out of bounds " + sy + " " + px + " " + col);
        }
      }
    }
  }
}