/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.pdmodel.font;
import java.io.IOException;
import java.io.InputStream;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.fontbox.util.BoundingBox;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.pdmodel.font.encoding.Encoding;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.util.Matrix;
import org.apache.pdfbox.util.Vector;
/**
* A PostScript Type 3 Font.
*
* @author Ben Litchfield
*/
public class PDType3Font extends PDSimpleFont
{
private static final Log LOG = LogFactory.getLog(PDType3Font.class);
private PDResources resources;
private COSDictionary charProcs;
private Matrix fontMatrix;
/**
* Constructor.
*
* @param fontDictionary The font dictionary according to the PDF specification.
*/
public PDType3Font(COSDictionary fontDictionary) throws IOException
{
super(fontDictionary);
readEncoding();
}
@Override
public String getName()
{
return dict.getNameAsString(COSName.NAME);
}
@Override
protected Encoding readEncodingFromFont() throws IOException
{
throw new UnsupportedOperationException("not supported for Type 3 fonts");
}
@Override
protected Boolean isFontSymbolic()
{
return false;
}
@Override
public Vector getDisplacement(int code) throws IOException
{
return getFontMatrix().transform(new Vector(getWidth(code), 0));
}
@Override
public float getWidth(int code) throws IOException
{
int firstChar = dict.getInt(COSName.FIRST_CHAR, -1);
int lastChar = dict.getInt(COSName.LAST_CHAR, -1);
if (getWidths().size() > 0 && code >= firstChar && code <= lastChar)
{
return getWidths().get(code - firstChar).floatValue();
}
else
{
PDFontDescriptor fd = getFontDescriptor();
if (fd != null)
{
return fd.getMissingWidth();
}
else
{
// todo: call getWidthFromFont?
LOG.error("No width for glyph " + code + " in font " + getName());
return 0;
}
}
}
@Override
public float getWidthFromFont(int code)
{
// todo: could these be extracted from the font's stream?
throw new UnsupportedOperationException("not suppported");
}
@Override
public boolean isEmbedded()
{
return true;
}
@Override
public float getHeight(int code) throws IOException
{
PDFontDescriptor desc = getFontDescriptor();
if (desc != null)
{
// the following values are all more or less accurate at least all are average
// values. Maybe we'll find another way to get those value for every single glyph
// in the future if needed
PDRectangle fontBBox = desc.getFontBoundingBox();
float retval = 0;
if (fontBBox != null)
{
retval = fontBBox.getHeight() / 2;
}
if (retval == 0)
{
retval = desc.getCapHeight();
}
if (retval == 0)
{
retval = desc.getAscent();
}
if (retval == 0)
{
retval = desc.getXHeight();
if (retval > 0)
{
retval -= desc.getDescent();
}
}
return retval;
}
return 0;
}
@Override
public int readCode(InputStream in) throws IOException
{
return in.read();
}
@Override
public Matrix getFontMatrix()
{
if (fontMatrix == null)
{
COSArray array = (COSArray) dict.getDictionaryObject(COSName.FONT_MATRIX);
if (array != null)
{
fontMatrix = new Matrix(array);
}
else
{
return super.getFontMatrix();
}
}
return fontMatrix;
}
@Override
public boolean isDamaged()
{
// there's no font file to load
return false;
}
/**
* Returns the optional resources of the type3 stream.
*
* @return the resources bound to be used when parsing the type3 stream
*/
public PDResources getResources()
{
if (resources == null)
{
COSDictionary resources = (COSDictionary) dict.getDictionaryObject(COSName.RESOURCES);
if (resources != null)
{
this.resources = new PDResources(resources);
}
}
return resources;
}
/**
* This will get the fonts bounding box.
*
* @return The fonts bounding box.
*/
public PDRectangle getFontBBox()
{
COSArray rect = (COSArray) dict.getDictionaryObject(COSName.FONT_BBOX);
PDRectangle retval = null;
if(rect != null)
{
retval = new PDRectangle(rect);
}
return retval;
}
@Override
public BoundingBox getBoundingBox()
{
PDRectangle rect = getFontBBox();
return new BoundingBox(rect.getLowerLeftX(), rect.getLowerLeftY(),
rect.getWidth(), rect.getHeight());
}
/**
* Returns the dictionary containing all streams to be used to render the glyphs.
*
* @return the dictionary containing all glyph streams.
*/
public COSDictionary getCharProcs()
{
if (charProcs == null)
{
charProcs = (COSDictionary) dict.getDictionaryObject(COSName.CHAR_PROCS);
}
return charProcs;
}
/**
* Returns the stream of the glyph for the given character code
*
* @param code character code
* @return the stream to be used to render the glyph
*/
public PDType3CharProc getCharProc(int code)
{
String name = getEncoding().getName(code);
if (!name.equals(".notdef"))
{
COSStream stream;
stream = (COSStream)getCharProcs().getDictionaryObject(COSName.getPDFName(name));
if (stream == null)
{
return null;
}
return new PDType3CharProc(this, stream);
}
return null;
}
}