From: Glenn Adams Date: Thu, 1 Sep 2016 16:14:25 +0000 (+0000) Subject: Rename o.a.f.fonts.FontReader to XMLMetricsFontReader, then deprecate the latter. X-Git-Tag: fop-2_2~45 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=d6523cbf1c1549232f2c195aa11f93d0082a81cd;p=xmlgraphics-fop.git Rename o.a.f.fonts.FontReader to XMLMetricsFontReader, then deprecate the latter. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1758804 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/fop-core/src/main/java/org/apache/fop/fonts/FontReader.java b/fop-core/src/main/java/org/apache/fop/fonts/FontReader.java deleted file mode 100644 index 9f5d54396..000000000 --- a/fop-core/src/main/java/org/apache/fop/fonts/FontReader.java +++ /dev/null @@ -1,309 +0,0 @@ -/* - * 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. - */ - -/* $Id$ */ - -package org.apache.fop.fonts; - -//Java -import java.io.IOException; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; - -import javax.xml.parsers.SAXParserFactory; - -import org.xml.sax.Attributes; -import org.xml.sax.InputSource; -import org.xml.sax.SAXException; -import org.xml.sax.XMLReader; -import org.xml.sax.helpers.DefaultHandler; - -import org.apache.fop.apps.FOPException; -import org.apache.fop.apps.io.InternalResourceResolver; -import org.apache.fop.fonts.apps.TTFReader; - -/** - * Class for reading a metric.xml file and creating a font object. - * Typical usage: - * 
- * FontReader reader = new FontReader();
- * reader.setFontEmbedPath();
- * reader.useKerning(true);
- * Font f = reader.getFont();
- *
- */ -public class FontReader extends DefaultHandler { - - private boolean isCID; - private CustomFont returnFont; - private MultiByteFont multiFont; - private SingleByteFont singleFont; - private final InternalResourceResolver resourceResolver; - private StringBuffer text = new StringBuffer(); - - private List cidWidths; - //private int cidWidthIndex; - - private Map currentKerning; - - private List bfranges; - - /** - * Construct a FontReader object from a path to a metric.xml file - * and read metric data - * @param source Source of the font metric file - * @throws FOPException if loading the font fails - */ - public FontReader(InputSource source, InternalResourceResolver resourceResolver) throws FOPException { - this.resourceResolver = resourceResolver; - createFont(source); - } - - private void createFont(InputSource source) throws FOPException { - XMLReader parser = null; - - try { - final SAXParserFactory factory = javax.xml.parsers.SAXParserFactory.newInstance(); - factory.setNamespaceAware(true); - parser = factory.newSAXParser().getXMLReader(); - } catch (Exception e) { - throw new FOPException(e); - } - if (parser == null) { - throw new FOPException("Unable to create SAX parser"); - } - - try { - parser.setFeature("http://xml.org/sax/features/namespace-prefixes", false); - } catch (SAXException e) { - throw new FOPException("You need a SAX parser which supports SAX version 2", e); - } - - parser.setContentHandler(this); - - try { - parser.parse(source); - } catch (SAXException e) { - throw new FOPException(e); - } catch (IOException e) { - throw new FOPException(e); - } - - } - - /** - * Sets the path to embed a font. A null value disables font embedding. - * @param path URI for the embeddable file - */ - public void setFontEmbedURI(URI path) { - returnFont.setEmbedURI(path); - } - - /** - * Enable/disable use of kerning for the font - * @param enabled true to enable kerning, false to disable - */ - public void setKerningEnabled(boolean enabled) { - returnFont.setKerningEnabled(enabled); - } - - /** - * Enable/disable use of advanced typographic features for the font - * @param enabled true to enable, false to disable - */ - public void setAdvancedEnabled(boolean enabled) { - returnFont.setAdvancedEnabled(enabled); - } - - /** - * Get the generated font object - * @return the font - */ - public Typeface getFont() { - return returnFont; - } - - /** - * {@inheritDoc} - */ - @Override - public void startDocument() { - } - - /** - * {@inheritDoc} - */ - public void startElement(String uri, String localName, String qName, Attributes attributes) - throws SAXException { - if (localName.equals("font-metrics")) { - if ("TYPE0".equals(attributes.getValue("type"))) { - multiFont = new MultiByteFont(resourceResolver, EmbeddingMode.AUTO); - returnFont = multiFont; - isCID = true; - TTFReader.checkMetricsVersion(attributes); - } else if ("TRUETYPE".equals(attributes.getValue("type"))) { - singleFont = new SingleByteFont(resourceResolver, EmbeddingMode.AUTO); - singleFont.setFontType(FontType.TRUETYPE); - returnFont = singleFont; - isCID = false; - TTFReader.checkMetricsVersion(attributes); - } else { - singleFont = new SingleByteFont(resourceResolver, EmbeddingMode.AUTO); - singleFont.setFontType(FontType.TYPE1); - returnFont = singleFont; - isCID = false; - } - } else if ("embed".equals(localName)) { - try { - returnFont.setEmbedURI(InternalResourceResolver.cleanURI(attributes.getValue("file"))); - } catch (URISyntaxException e) { - throw new SAXException("URI syntax error in metrics file: " + e.getMessage(), e); - } - returnFont.setEmbedResourceName(attributes.getValue("class")); - } else if ("cid-widths".equals(localName)) { - // This is unused - // cidWidthIndex = getInt(attributes.getValue("start-index")); - cidWidths = new ArrayList(); - } else if ("kerning".equals(localName)) { - currentKerning = new HashMap(); - returnFont.putKerningEntry(getInt(attributes.getValue("kpx1")), - currentKerning); - } else if ("bfranges".equals(localName)) { - bfranges = new ArrayList(); - } else if ("bf".equals(localName)) { - CMapSegment entry = new CMapSegment(getInt(attributes.getValue("us")), - getInt(attributes.getValue("ue")), - getInt(attributes.getValue("gi"))); - bfranges.add(entry); - } else if ("wx".equals(localName)) { - cidWidths.add(getInt(attributes.getValue("w"))); - // } else if ("widths".equals(localName)) { - // singleFont.width = new int[256]; - } else if ("char".equals(localName)) { - try { - singleFont.setWidth(getInt(attributes.getValue("idx")), - getInt(attributes.getValue("wdt"))); - } catch (NumberFormatException ne) { - throw new SAXException("Malformed width in metric file: " + ne.getMessage(), ne); - } - } else if ("pair".equals(localName)) { - currentKerning.put(getInt(attributes.getValue("kpx2")), - getInt(attributes.getValue("kern"))); - } - - } - - private int getInt(String str) throws SAXException { - int ret = 0; - try { - ret = Integer.parseInt(str); - } catch (Exception e) { - throw new SAXException("Error while parsing integer value: " + str, e); - } - return ret; - } - - /** - * {@inheritDoc} - */ - @Override - public void endElement(String uri, String localName, String qName) throws SAXException { - String content = text.toString().trim(); - if ("font-name".equals(localName)) { - returnFont.setFontName(content); - } else if ("full-name".equals(localName)) { - returnFont.setFullName(content); - } else if ("family-name".equals(localName)) { - Set s = new HashSet(); - s.add(content); - returnFont.setFamilyNames(s); - } else if ("ttc-name".equals(localName) && isCID) { - multiFont.setTTCName(content); - } else if ("encoding".equals(localName)) { - if (singleFont != null && singleFont.getFontType() == FontType.TYPE1) { - singleFont.setEncoding(content); - } - } else if ("cap-height".equals(localName)) { - returnFont.setCapHeight(getInt(content)); - } else if ("x-height".equals(localName)) { - returnFont.setXHeight(getInt(content)); - } else if ("ascender".equals(localName)) { - returnFont.setAscender(getInt(content)); - } else if ("descender".equals(localName)) { - returnFont.setDescender(getInt(content)); - } else if ("left".equals(localName)) { - int[] bbox = returnFont.getFontBBox(); - bbox[0] = getInt(content); - returnFont.setFontBBox(bbox); - } else if ("bottom".equals(localName)) { - int[] bbox = returnFont.getFontBBox(); - bbox[1] = getInt(content); - returnFont.setFontBBox(bbox); - } else if ("right".equals(localName)) { - int[] bbox = returnFont.getFontBBox(); - bbox[2] = getInt(content); - returnFont.setFontBBox(bbox); - } else if ("top".equals(localName)) { - int[] bbox = returnFont.getFontBBox(); - bbox[3] = getInt(content); - returnFont.setFontBBox(bbox); - } else if ("first-char".equals(localName)) { - returnFont.setFirstChar(getInt(content)); - } else if ("last-char".equals(localName)) { - returnFont.setLastChar(getInt(content)); - } else if ("flags".equals(localName)) { - returnFont.setFlags(getInt(content)); - } else if ("stemv".equals(localName)) { - returnFont.setStemV(getInt(content)); - } else if ("italic-angle".equals(localName)) { - returnFont.setItalicAngle(getInt(content)); - } else if ("missing-width".equals(localName)) { - returnFont.setMissingWidth(getInt(content)); - } else if ("cid-type".equals(localName)) { - multiFont.setCIDType(CIDFontType.byName(content)); - } else if ("default-width".equals(localName)) { - multiFont.setDefaultWidth(getInt(content)); - } else if ("cid-widths".equals(localName)) { - int[] wds = new int[cidWidths.size()]; - int j = 0; - for (int count = 0; count < cidWidths.size(); count++) { - wds[j++] = cidWidths.get(count).intValue(); - } - - //multiFont.addCIDWidthEntry(cidWidthIndex, wds); - multiFont.setWidthArray(wds); - - } else if ("bfranges".equals(localName)) { - multiFont.setCMap(bfranges.toArray(new CMapSegment[bfranges.size()])); - } - text.setLength(0); //Reset text buffer (see characters()) - } - - /** - * {@inheritDoc} - */ - @Override - public void characters(char[] ch, int start, int length) { - text.append(ch, start, length); - } -} diff --git a/fop-core/src/main/java/org/apache/fop/fonts/LazyFont.java b/fop-core/src/main/java/org/apache/fop/fonts/LazyFont.java index 2d32eec57..d99a3675f 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/LazyFont.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/LazyFont.java @@ -101,12 +101,13 @@ public class LazyFont extends Typeface implements FontDescriptor, Substitutable, if (!isMetricsLoaded) { try { if (fontUris.getMetrics() != null) { - /**@todo Possible thread problem here */ - FontReader reader = null; + // Use of XML based font metrics is DEPRECATED! + // @todo Possible thread problem here + XMLFontMetricsReader reader = null; InputStream in = resourceResolver.getResource(fontUris.getMetrics()); InputSource src = new InputSource(in); src.setSystemId(fontUris.getMetrics().toASCIIString()); - reader = new FontReader(src, resourceResolver); + reader = new XMLFontMetricsReader(src, resourceResolver); reader.setKerningEnabled(useKerning); reader.setAdvancedEnabled(useAdvanced); if (this.embedded) { diff --git a/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java b/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java new file mode 100644 index 000000000..4e6177786 --- /dev/null +++ b/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java @@ -0,0 +1,313 @@ +/* + * 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. + */ + +/* $Id$ */ + +package org.apache.fop.fonts; + +//Java +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.xml.parsers.SAXParserFactory; + +import org.xml.sax.Attributes; +import org.xml.sax.InputSource; +import org.xml.sax.SAXException; +import org.xml.sax.XMLReader; +import org.xml.sax.helpers.DefaultHandler; + +import org.apache.fop.apps.FOPException; +import org.apache.fop.apps.io.InternalResourceResolver; +import org.apache.fop.fonts.apps.TTFReader; + +/** + *

Class for reading a metric.xml file and creating a font object. + * Typical usage:

+ * 
+ * XMLFontMetricsReader reader = new XMLFontMetricsReader();
+ * reader.setFontEmbedPath();
+ * reader.useKerning(true);
+ * Font f = reader.getFont();
+ *
+ *

N.B. This is deprecated functionality and is expected to be + * removed from a future version of FOP. New applications using FOP should + * not make direct or implied use of this mechanism.

+ */ +@Deprecated +public class XMLFontMetricsReader extends DefaultHandler { + + private boolean isCID; + private CustomFont returnFont; + private MultiByteFont multiFont; + private SingleByteFont singleFont; + private final InternalResourceResolver resourceResolver; + private StringBuffer text = new StringBuffer(); + + private List cidWidths; + //private int cidWidthIndex; + + private Map currentKerning; + + private List bfranges; + + /** + * Construct a XMLFontMetricsReader object from a path to a metric.xml file + * and read metric data + * @param source Source of the font metric file + * @throws FOPException if loading the font fails + */ + public XMLFontMetricsReader(InputSource source, InternalResourceResolver resourceResolver) throws FOPException { + this.resourceResolver = resourceResolver; + createFont(source); + } + + private void createFont(InputSource source) throws FOPException { + XMLReader parser = null; + + try { + final SAXParserFactory factory = javax.xml.parsers.SAXParserFactory.newInstance(); + factory.setNamespaceAware(true); + parser = factory.newSAXParser().getXMLReader(); + } catch (Exception e) { + throw new FOPException(e); + } + if (parser == null) { + throw new FOPException("Unable to create SAX parser"); + } + + try { + parser.setFeature("http://xml.org/sax/features/namespace-prefixes", false); + } catch (SAXException e) { + throw new FOPException("You need a SAX parser which supports SAX version 2", e); + } + + parser.setContentHandler(this); + + try { + parser.parse(source); + } catch (SAXException e) { + throw new FOPException(e); + } catch (IOException e) { + throw new FOPException(e); + } + + } + + /** + * Sets the path to embed a font. A null value disables font embedding. + * @param path URI for the embeddable file + */ + public void setFontEmbedURI(URI path) { + returnFont.setEmbedURI(path); + } + + /** + * Enable/disable use of kerning for the font + * @param enabled true to enable kerning, false to disable + */ + public void setKerningEnabled(boolean enabled) { + returnFont.setKerningEnabled(enabled); + } + + /** + * Enable/disable use of advanced typographic features for the font + * @param enabled true to enable, false to disable + */ + public void setAdvancedEnabled(boolean enabled) { + returnFont.setAdvancedEnabled(enabled); + } + + /** + * Get the generated font object + * @return the font + */ + public Typeface getFont() { + return returnFont; + } + + /** + * {@inheritDoc} + */ + @Override + public void startDocument() { + } + + /** + * {@inheritDoc} + */ + public void startElement(String uri, String localName, String qName, Attributes attributes) + throws SAXException { + if (localName.equals("font-metrics")) { + if ("TYPE0".equals(attributes.getValue("type"))) { + multiFont = new MultiByteFont(resourceResolver, EmbeddingMode.AUTO); + returnFont = multiFont; + isCID = true; + TTFReader.checkMetricsVersion(attributes); + } else if ("TRUETYPE".equals(attributes.getValue("type"))) { + singleFont = new SingleByteFont(resourceResolver, EmbeddingMode.AUTO); + singleFont.setFontType(FontType.TRUETYPE); + returnFont = singleFont; + isCID = false; + TTFReader.checkMetricsVersion(attributes); + } else { + singleFont = new SingleByteFont(resourceResolver, EmbeddingMode.AUTO); + singleFont.setFontType(FontType.TYPE1); + returnFont = singleFont; + isCID = false; + } + } else if ("embed".equals(localName)) { + try { + returnFont.setEmbedURI(InternalResourceResolver.cleanURI(attributes.getValue("file"))); + } catch (URISyntaxException e) { + throw new SAXException("URI syntax error in metrics file: " + e.getMessage(), e); + } + returnFont.setEmbedResourceName(attributes.getValue("class")); + } else if ("cid-widths".equals(localName)) { + // This is unused + // cidWidthIndex = getInt(attributes.getValue("start-index")); + cidWidths = new ArrayList(); + } else if ("kerning".equals(localName)) { + currentKerning = new HashMap(); + returnFont.putKerningEntry(getInt(attributes.getValue("kpx1")), + currentKerning); + } else if ("bfranges".equals(localName)) { + bfranges = new ArrayList(); + } else if ("bf".equals(localName)) { + CMapSegment entry = new CMapSegment(getInt(attributes.getValue("us")), + getInt(attributes.getValue("ue")), + getInt(attributes.getValue("gi"))); + bfranges.add(entry); + } else if ("wx".equals(localName)) { + cidWidths.add(getInt(attributes.getValue("w"))); + // } else if ("widths".equals(localName)) { + // singleFont.width = new int[256]; + } else if ("char".equals(localName)) { + try { + singleFont.setWidth(getInt(attributes.getValue("idx")), + getInt(attributes.getValue("wdt"))); + } catch (NumberFormatException ne) { + throw new SAXException("Malformed width in metric file: " + ne.getMessage(), ne); + } + } else if ("pair".equals(localName)) { + currentKerning.put(getInt(attributes.getValue("kpx2")), + getInt(attributes.getValue("kern"))); + } + + } + + private int getInt(String str) throws SAXException { + int ret = 0; + try { + ret = Integer.parseInt(str); + } catch (Exception e) { + throw new SAXException("Error while parsing integer value: " + str, e); + } + return ret; + } + + /** + * {@inheritDoc} + */ + @Override + public void endElement(String uri, String localName, String qName) throws SAXException { + String content = text.toString().trim(); + if ("font-name".equals(localName)) { + returnFont.setFontName(content); + } else if ("full-name".equals(localName)) { + returnFont.setFullName(content); + } else if ("family-name".equals(localName)) { + Set s = new HashSet(); + s.add(content); + returnFont.setFamilyNames(s); + } else if ("ttc-name".equals(localName) && isCID) { + multiFont.setTTCName(content); + } else if ("encoding".equals(localName)) { + if (singleFont != null && singleFont.getFontType() == FontType.TYPE1) { + singleFont.setEncoding(content); + } + } else if ("cap-height".equals(localName)) { + returnFont.setCapHeight(getInt(content)); + } else if ("x-height".equals(localName)) { + returnFont.setXHeight(getInt(content)); + } else if ("ascender".equals(localName)) { + returnFont.setAscender(getInt(content)); + } else if ("descender".equals(localName)) { + returnFont.setDescender(getInt(content)); + } else if ("left".equals(localName)) { + int[] bbox = returnFont.getFontBBox(); + bbox[0] = getInt(content); + returnFont.setFontBBox(bbox); + } else if ("bottom".equals(localName)) { + int[] bbox = returnFont.getFontBBox(); + bbox[1] = getInt(content); + returnFont.setFontBBox(bbox); + } else if ("right".equals(localName)) { + int[] bbox = returnFont.getFontBBox(); + bbox[2] = getInt(content); + returnFont.setFontBBox(bbox); + } else if ("top".equals(localName)) { + int[] bbox = returnFont.getFontBBox(); + bbox[3] = getInt(content); + returnFont.setFontBBox(bbox); + } else if ("first-char".equals(localName)) { + returnFont.setFirstChar(getInt(content)); + } else if ("last-char".equals(localName)) { + returnFont.setLastChar(getInt(content)); + } else if ("flags".equals(localName)) { + returnFont.setFlags(getInt(content)); + } else if ("stemv".equals(localName)) { + returnFont.setStemV(getInt(content)); + } else if ("italic-angle".equals(localName)) { + returnFont.setItalicAngle(getInt(content)); + } else if ("missing-width".equals(localName)) { + returnFont.setMissingWidth(getInt(content)); + } else if ("cid-type".equals(localName)) { + multiFont.setCIDType(CIDFontType.byName(content)); + } else if ("default-width".equals(localName)) { + multiFont.setDefaultWidth(getInt(content)); + } else if ("cid-widths".equals(localName)) { + int[] wds = new int[cidWidths.size()]; + int j = 0; + for (int count = 0; count < cidWidths.size(); count++) { + wds[j++] = cidWidths.get(count).intValue(); + } + + //multiFont.addCIDWidthEntry(cidWidthIndex, wds); + multiFont.setWidthArray(wds); + + } else if ("bfranges".equals(localName)) { + multiFont.setCMap(bfranges.toArray(new CMapSegment[bfranges.size()])); + } + text.setLength(0); //Reset text buffer (see characters()) + } + + /** + * {@inheritDoc} + */ + @Override + public void characters(char[] ch, int start, int length) { + text.append(ch, start, length); + } +}