/*
 * Copyright (c) 1995, 2004, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package sun.awt.motif;

import java.awt.*;
import java.util.Hashtable;
import sun.awt.PlatformFont;

A font metrics object for a WServer font.
Author:
Jim Graham/**
 * A font metrics object for a WServer font.
 *
 * @author Jim Graham
 */
public class X11FontMetrics extends FontMetrics {
    
The widths of the first 256 characters.
/**
     * The widths of the first 256 characters.
     */
    int widths[];

    
The standard ascent of the font.  This is the logical height
above the baseline for the Alphanumeric characters and should
be used for determining line spacing.  Note, however, that some
characters in the font may extend above this height.
/**
     * The standard ascent of the font.  This is the logical height
     * above the baseline for the Alphanumeric characters and should
     * be used for determining line spacing.  Note, however, that some
     * characters in the font may extend above this height.
     */
    int ascent;

    
The standard descent of the font.  This is the logical height
below the baseline for the Alphanumeric characters and should
be used for determining line spacing.  Note, however, that some
characters in the font may extend below this height.
/**
     * The standard descent of the font.  This is the logical height
     * below the baseline for the Alphanumeric characters and should
     * be used for determining line spacing.  Note, however, that some
     * characters in the font may extend below this height.
     */
    int descent;

    
The standard leading for the font.  This is the logical amount
of space to be reserved between the descent of one line of text
and the ascent of the next line.  The height metric is calculated
to include this extra space.
/**
     * The standard leading for the font.  This is the logical amount
     * of space to be reserved between the descent of one line of text
     * and the ascent of the next line.  The height metric is calculated
     * to include this extra space.
     */
    int leading;

    
The standard height of a line of text in this font.  This is
the distance between the baseline of adjacent lines of text.
It is the sum of the ascent+descent+leading.  There is no
guarantee that lines of text spaced at this distance will be
disjoint; such lines may overlap if some characters overshoot
the standard ascent and descent metrics.
/**
     * The standard height of a line of text in this font.  This is
     * the distance between the baseline of adjacent lines of text.
     * It is the sum of the ascent+descent+leading.  There is no
     * guarantee that lines of text spaced at this distance will be
     * disjoint; such lines may overlap if some characters overshoot
     * the standard ascent and descent metrics.
     */
    int height;

    
The maximum ascent for all characters in this font.  No character
will extend further above the baseline than this metric.
/**
     * The maximum ascent for all characters in this font.  No character
     * will extend further above the baseline than this metric.
     */
    int maxAscent;

    
The maximum descent for all characters in this font.  No character
will descend further below the baseline than this metric.
/**
     * The maximum descent for all characters in this font.  No character
     * will descend further below the baseline than this metric.
     */
    int maxDescent;

    
The maximum possible height of a line of text in this font.
Adjacent lines of text spaced this distance apart will be
guaranteed not to overlap.  Note, however, that many paragraphs
that contain ordinary alphanumeric text may look too widely
spaced if this metric is used to determine line spacing.  The
height field should be preferred unless the text in a given
line contains particularly tall characters.
/**
     * The maximum possible height of a line of text in this font.
     * Adjacent lines of text spaced this distance apart will be
     * guaranteed not to overlap.  Note, however, that many paragraphs
     * that contain ordinary alphanumeric text may look too widely
     * spaced if this metric is used to determine line spacing.  The
     * height field should be preferred unless the text in a given
     * line contains particularly tall characters.
     */
    int maxHeight;

    
The maximum advance width of any character in this font.
/**
     * The maximum advance width of any character in this font.
     */
    int maxAdvance;

    static {
        initIDs();
    }

    
Initialize JNI field and method IDs for fields that may be
accessed from C.
/**
     * Initialize JNI field and method IDs for fields that may be
       accessed from C.
     */
    private static native void initIDs();

     
Calculate the metrics from the given WServer and font.
/**
     * Calculate the metrics from the given WServer and font.
     */
    public X11FontMetrics(Font font) {
        super(font);
        init();
    }

    
Get leading
/**
     * Get leading
     */
    public int getLeading() {
        return leading;
    }

    
Get ascent.
/**
     * Get ascent.
     */
    public int getAscent() {
        return ascent;
    }

    
Get descent
/**
     * Get descent
     */
    public int getDescent() {
        return descent;
    }

    
Get height
/**
     * Get height
     */
    public int getHeight() {
        return height;
    }

    
Get maxAscent
/**
     * Get maxAscent
     */
    public int getMaxAscent() {
        return maxAscent;
    }

    
Get maxDescent
/**
     * Get maxDescent
     */
    public int getMaxDescent() {
        return maxDescent;
    }

    
Get maxAdvance
/**
     * Get maxAdvance
     */
    public int getMaxAdvance() {
        return maxAdvance;
    }

    
Return the width of the specified string in this Font.
/**
     * Return the width of the specified string in this Font.
     */
    public int stringWidth(String string) {
        return charsWidth(string.toCharArray(), 0, string.length());
    }

    
Return the width of the specified char[] in this Font.
/**
     * Return the width of the specified char[] in this Font.
     */
    public int charsWidth(char chars[], int offset, int length) {
        Font font = getFont();
        PlatformFont pf = ((PlatformFont) font.getPeer());
        if (pf.mightHaveMultiFontMetrics()) {
            return getMFCharsWidth(chars, offset, length, font);
        } else {
            if (widths != null) {
                int w = 0;
                for (int i = offset; i < offset + length; i++) {
                    int ch = chars[i];
                    if (ch < 0 || ch >= widths.length) {
                        w += maxAdvance;
                    } else {
                        w += widths[ch];
                    }
                }
                return w;
            } else {
                return maxAdvance * length;
            }
        }
    }

    private native int getMFCharsWidth(char chars[], int offset, int length, Font font);

    
Return the width of the specified byte[] in this Font.
/**
     * Return the width of the specified byte[] in this Font.
     */
    public native int bytesWidth(byte data[], int off, int len);

    
Get the widths of the first 256 characters in the font.
/**
     * Get the widths of the first 256 characters in the font.
     */
    public int[] getWidths() {
        return widths;
    }

    native void init();

    static Hashtable table = new Hashtable();

    static synchronized FontMetrics getFontMetrics(Font font) {
        FontMetrics fm = (FontMetrics)table.get(font);
        if (fm == null) {
            table.put(font, fm = new X11FontMetrics(font));
        }
        return fm;
    }
}