path: root/libjava/classpath/gnu/java/awt/font/OpenTypeFontPeer.java

/* XFontPeer2.java -- A Java based TTF font peer for X
   Copyright (C) 2006 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath 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, or (at your option)
any later version.

GNU Classpath 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 GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package gnu.java.awt.font;


import gnu.java.awt.peer.ClasspathFontPeer;
import gnu.java.lang.CPStringBuilder;

import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.font.FontRenderContext;
import java.awt.font.GlyphVector;
import java.awt.font.LineMetrics;
import java.awt.font.TextAttribute;
import java.awt.geom.AffineTransform;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.text.CharacterIterator;
import java.text.StringCharacterIterator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

public class OpenTypeFontPeer
  extends ClasspathFontPeer
{

  /**
   * The font mapping as specified in the file fonts.properties.
   */
  private static Properties fontProperties;

  /**
   * The available font family names.
   */
  private static Set<String> availableFontNames;

  /**
   * Font spec to file mapping.
   */
  private static Map<String,Map<String,String>> fontToFileMap;

  static
  {
    fontProperties = new Properties();
    InputStream in = OpenTypeFontPeer.class.getResourceAsStream("fonts.properties");
    try
      {
        fontProperties.load(in);
      }
    catch (IOException e)
      {
        e.printStackTrace();
      }
  }

  private class XLineMetrics
    extends LineMetrics
  {

    private Font font;
    private GlyphVector glyphVector;
//    private CharacterIterator characterIterator;
//    private int begin;
//    private int limit;
    private FontRenderContext fontRenderContext;
    XLineMetrics(Font f, CharacterIterator ci, int b, int l,
                 FontRenderContext rc)
    {
      font = f;
//      characterIterator = ci;
//      begin = b;
//      limit = l;
      fontRenderContext = rc;
      glyphVector = fontDelegate.createGlyphVector(font, fontRenderContext,
                                                   ci);
    }

    public float getAscent()
    {
      return fontDelegate.getAscent(font.getSize(), fontRenderContext.getTransform(),
                             fontRenderContext.isAntiAliased(),
                             fontRenderContext.usesFractionalMetrics(), true);
    }

    public int getBaselineIndex()
    {
      // FIXME: Implement this.
      throw new UnsupportedOperationException("Not yet implemented");
    }

    public float[] getBaselineOffsets()
    {
      // FIXME: Implement this.
      throw new UnsupportedOperationException("Not yet implemented");
    }

    public float getDescent()
    {
      return (int) fontDelegate.getDescent(font.getSize(), IDENDITY, false,
                                           false, false);
    }

    public float getHeight()
    {
      return (float) glyphVector.getLogicalBounds().getHeight();
    }

    public float getLeading()
    {
      return getHeight() - getAscent() - getDescent();
    }

    public int getNumChars()
    {
      // FIXME: Implement this.
      throw new UnsupportedOperationException("Not yet implemented");
    }

    public float getStrikethroughOffset()
    {
      return 0.F;
    }

    public float getStrikethroughThickness()
    {
      return 0.F;
    }

    public float getUnderlineOffset()
    {
      return 0.F;
    }

    public float getUnderlineThickness()
    {
      return 0.F;
    }

  }

  private class XFontMetrics
    extends FontMetrics
  {
    /**
     * A cached point instance, to be used in #charWidth().
     */
    private Point2D cachedPoint = new Point2D.Double();

    XFontMetrics(Font f)
    {
      super(f);
    }

    public int getAscent()
    {
      return (int) fontDelegate.getAscent(getFont().getSize(), IDENDITY,
                                          false, false, false);
    }

    public int getDescent()
    {
      return (int) fontDelegate.getDescent(getFont().getSize(), IDENDITY,
                                           false, false, false);
    }

    public int getHeight()
    {
      GlyphVector gv = fontDelegate.createGlyphVector(getFont(),
                    new FontRenderContext(IDENDITY, false, false),
                    new StringCharacterIterator("m"));
      Rectangle2D b = gv.getVisualBounds();
      return (int) b.getHeight();
    }

    public int charWidth(char c)
    {
      int code = fontDelegate.getGlyphIndex(c);
      Point2D advance = cachedPoint;
      fontDelegate.getAdvance(code, font.getSize2D(), IDENDITY,
                              false, false, true, advance);
      return (int) advance.getX();
    }

    public int charsWidth(char[] chars, int offs, int len)
    {
      return stringWidth(new String(chars, offs, len));
    }

    public int stringWidth(String s)
    {
      GlyphVector gv = fontDelegate.createGlyphVector(getFont(),
                    new FontRenderContext(IDENDITY, false, false),
                    new StringCharacterIterator(s));
      Rectangle2D b = gv.getVisualBounds();
      return (int) b.getWidth();
    }
  }

  /**
   * The indendity transform, to be used in several methods.
   */
  private static final AffineTransform IDENDITY = new AffineTransform();

  private FontDelegate fontDelegate;

  public OpenTypeFontPeer(String name, int style, int size)
  {
    super(name, style, size);
    try
      {
        String fontSpec = encodeFont(name, style);
        String filename = mapFontToFilename(fontSpec);
        File fontfile = new File(filename);
        FileInputStream in = new FileInputStream(fontfile);
        FileChannel ch = in.getChannel();
        ByteBuffer buffer = ch.map(FileChannel.MapMode.READ_ONLY, 0,
                                   fontfile.length());
        fontDelegate = FontFactory.createFonts(buffer)[0];
      }
    catch (Exception ex)
      {
        ex.printStackTrace();
      }
  }

  public OpenTypeFontPeer(String name, Map atts)
  {
    super(name, atts);
    try
      {
        String fontSpec = encodeFont(name, atts);
        String filename = mapFontToFilename(fontSpec);
        File fontfile = new File(filename);
        FileInputStream in = new FileInputStream(fontfile);
        FileChannel ch = in.getChannel();
        ByteBuffer buffer = ch.map(FileChannel.MapMode.READ_ONLY, 0,
                                   fontfile.length());
        fontDelegate = FontFactory.createFonts(buffer)[0];
      }
    catch (Exception ex)
      {
        ex.printStackTrace();
      }
  }

  public boolean canDisplay(Font font, int c)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public int canDisplayUpTo(Font font, CharacterIterator i, int start, int limit)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public String getSubFamilyName(Font font, Locale locale)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public String getPostScriptName(Font font)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public int getNumGlyphs(Font font)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public int getMissingGlyphCode(Font font)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public byte getBaselineFor(Font font, char c)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public String getGlyphName(Font font, int glyphIndex)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public GlyphVector createGlyphVector(Font font, FontRenderContext frc, CharacterIterator ci)
  {
    return fontDelegate.createGlyphVector(font, frc, ci);
  }

  public GlyphVector createGlyphVector(Font font, FontRenderContext ctx, int[] glyphCodes)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public GlyphVector layoutGlyphVector(Font font, FontRenderContext frc, char[] chars, int start, int limit, int flags)
  {
    StringCharacterIterator i = new StringCharacterIterator(new String(chars), start, limit, 0);
    return fontDelegate.createGlyphVector(font, frc, i);
  }

  public FontMetrics getFontMetrics(Font font)
  {
    return new XFontMetrics(font);
  }

  public boolean hasUniformLineMetrics(Font font)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public LineMetrics getLineMetrics(Font font, CharacterIterator ci, int begin, int limit, FontRenderContext rc)
  {
    return new XLineMetrics(font, ci, begin, limit, rc);
  }

  public Rectangle2D getMaxCharBounds(Font font, FontRenderContext rc)
  {
    // FIXME: Implement this.
    throw new UnsupportedOperationException("Not yet implemented");
  }

  /**
   * Encodes a font name + style + size specification into a X logical font
   * description (XLFD) as described here:
   *
   * http://www.meretrx.com/e93/docs/xlfd.html
   *
   * This is implemented to look up the font description in the
   * fonts.properties of this package.
   *
   * @param name the font name
   * @param atts the text attributes
   *
   * @return the encoded font description
   */
  public static String encodeFont(String name, Map atts)
  {
    String family = name;
    if (family == null || family.equals(""))
      family = (String) atts.get(TextAttribute.FAMILY);
    if (family == null)
      family = "SansSerif";

    int style = 0;
    // Detect italic attribute.
    Float posture = (Float) atts.get(TextAttribute.POSTURE);
    if (posture != null && !posture.equals(TextAttribute.POSTURE_REGULAR))
      style |= Font.ITALIC;

    // Detect bold attribute.
    Float weight = (Float) atts.get(TextAttribute.WEIGHT);
    if (weight != null && weight.compareTo(TextAttribute.WEIGHT_REGULAR) > 0)
      style |= Font.BOLD;

    return encodeFont(name, style);
  }

  /**
   * Encodes a font name + style into a combined string.
   *
   * This is implemented to look up the font description in the
   * fonts.properties of this package.
   *
   * @param name the font name
   * @param style the font style
   *
   * @return the encoded font description
   */
  static String encodeFont(String name, int style)
  {
    CPStringBuilder key = new CPStringBuilder();
    key.append(validName(name));
    key.append('/');
    switch (style)
    {
      case Font.BOLD:
        key.append("b");
        break;
      case Font.ITALIC:
        key.append("i");
        break;
      case (Font.BOLD | Font.ITALIC):
        key.append("bi");
        break;
      case Font.PLAIN:
      default:
        key.append("p");

    }

    return key.toString();
  }

  /**
   * Checks the specified font name for a valid font name. If the font name
   * is not known, then this returns 'sansserif' as fallback.
   *
   * @param name the font name to check
   *
   * @return a valid font name
   */
  static String validName(String name)
  {
    String retVal;
    Set<String> fontNames = getFontNames();
    if (fontNames.contains(name))
      {
        retVal = name;
      }
    else
      {
        retVal = "SansSerif";
      }
    return retVal;
  }

  public static String[] getAvailableFontFamilyNames(Locale l)
  {
    Set<String> fontNames = getFontNames();
    int numNames = fontNames.size();
    String[] ret = fontNames.toArray(new String[numNames]);
    return ret;
  }

  private static synchronized Set<String> getFontNames()
  {
    if (availableFontNames == null)
      {
        HashSet<String> familyNames = new HashSet<String>();
        for (Object o : fontProperties.keySet())
          {
            if (o instanceof String)
              {
                String key = (String) o;
                int slashIndex = key.indexOf('/');
                String name = key.substring(0, slashIndex);
                familyNames.add(name);
              }
          }
        availableFontNames = familyNames;
      }
    return availableFontNames;
  }

  /**
   * Takes a font spec as returned by {@link #encodeFont(String, int)},
   * and returns the corresponding font file, or <code>null</code> if no such
   * font mapping exists.
   *
   * @param fontSpec font name and style as returned by
   *        {@link #encodeFont(String, int)}
   *
   * @return filename of the corresponding font file
   */
  private synchronized String mapFontToFilename(String fontSpec)
  {
    if (fontToFileMap == null)
      {
        fontToFileMap = new HashMap<String,Map<String,String>>();

        // Initialize font spec to file mapping according to the
        // font.properties.
        for (Object o : fontProperties.keySet())
          {
            if (o instanceof String)
              {
                String key = (String) o;
                int slashIndex = key.indexOf('/');
                String name = key.substring(0, slashIndex);
                String spec = key.substring(slashIndex + 1);
                // Handle aliases in the 2nd pass below.
                if (! spec.equals("a"))
                  {
                    Map<String,String> specToFileMap = fontToFileMap.get(name);
                    if (specToFileMap == null)
                      {
                        specToFileMap = new HashMap<String,String>();
                        fontToFileMap.put(name, specToFileMap);
                      }
                    specToFileMap.put(spec, fontProperties.getProperty(key));
                  }
              }
          }
        // 2nd pass for handling aliases.
        for (Object o : fontProperties.keySet())
          {
            if (o instanceof String)
              {
                String key = (String) o;
                int slashIndex = key.indexOf('/');
                String name = key.substring(0, slashIndex);
                String spec = key.substring(slashIndex + 1);
                // Handle aliases in the 2nd pass below.
                if (spec.equals("a"))
                  {
                    String alias = fontProperties.getProperty(key);
                    Map<String,String> specToFileMap = fontToFileMap.get(alias);
                    fontToFileMap.put(name, specToFileMap);
                  }
              }
          }
      }
    // Look up font file.
    int slashIndex = fontSpec.indexOf('/');
    String name = fontSpec.substring(0, slashIndex);
    String spec = fontSpec.substring(slashIndex + 1);
    return fontToFileMap.get(name).get(spec);
  }
}