| /* |
| * 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.render.pdf; |
| |
| import java.awt.Color; |
| import java.awt.Dimension; |
| import java.awt.Paint; |
| import java.awt.Point; |
| import java.awt.Rectangle; |
| import java.awt.geom.AffineTransform; |
| import java.io.IOException; |
| |
| import org.w3c.dom.Document; |
| |
| import org.apache.fop.fonts.Font; |
| import org.apache.fop.fonts.FontInfo; |
| import org.apache.fop.fonts.FontTriplet; |
| import org.apache.fop.fonts.LazyFont; |
| import org.apache.fop.fonts.SingleByteFont; |
| import org.apache.fop.fonts.Typeface; |
| import org.apache.fop.pdf.PDFDocument; |
| import org.apache.fop.pdf.PDFNumber; |
| import org.apache.fop.pdf.PDFTextUtil; |
| import org.apache.fop.pdf.PDFXObject; |
| import org.apache.fop.render.RenderingContext; |
| import org.apache.fop.render.intermediate.AbstractIFPainter; |
| import org.apache.fop.render.intermediate.IFContext; |
| import org.apache.fop.render.intermediate.IFException; |
| import org.apache.fop.render.intermediate.IFState; |
| import org.apache.fop.render.intermediate.IFUtil; |
| import org.apache.fop.render.pdf.PDFLogicalStructureHandler.MarkedContentInfo; |
| import org.apache.fop.traits.BorderProps; |
| import org.apache.fop.traits.Direction; |
| import org.apache.fop.traits.RuleStyle; |
| import org.apache.fop.util.CharUtilities; |
| |
| /** |
| * IFPainter implementation that produces PDF. |
| */ |
| public class PDFPainter extends AbstractIFPainter { |
| |
| private final PDFDocumentHandler documentHandler; |
| |
| /** The current content generator */ |
| protected PDFContentGenerator generator; |
| |
| private final PDFBorderPainter borderPainter; |
| |
| private boolean accessEnabled; |
| |
| private MarkedContentInfo imageMCI; |
| |
| private PDFLogicalStructureHandler logicalStructureHandler; |
| |
| /** |
| * Default constructor. |
| * @param documentHandler the parent document handler |
| * @param logicalStructureHandler the logical structure handler |
| */ |
| public PDFPainter(PDFDocumentHandler documentHandler, |
| PDFLogicalStructureHandler logicalStructureHandler) { |
| super(); |
| this.documentHandler = documentHandler; |
| this.logicalStructureHandler = logicalStructureHandler; |
| this.generator = documentHandler.generator; |
| this.borderPainter = new PDFBorderPainter(this.generator); |
| this.state = IFState.create(); |
| accessEnabled = this.getUserAgent().isAccessibilityEnabled(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| protected IFContext getContext() { |
| return this.documentHandler.getContext(); |
| } |
| |
| PDFRenderingUtil getPDFUtil() { |
| return this.documentHandler.pdfUtil; |
| } |
| |
| PDFDocument getPDFDoc() { |
| return this.documentHandler.pdfDoc; |
| } |
| |
| FontInfo getFontInfo() { |
| return this.documentHandler.getFontInfo(); |
| } |
| |
| /** {@inheritDoc} */ |
| public void startViewport(AffineTransform transform, Dimension size, Rectangle clipRect) |
| throws IFException { |
| generator.saveGraphicsState(); |
| generator.concatenate(toPoints(transform)); |
| if (clipRect != null) { |
| clipRect(clipRect); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| public void endViewport() throws IFException { |
| generator.restoreGraphicsState(); |
| } |
| |
| /** {@inheritDoc} */ |
| public void startGroup(AffineTransform transform) throws IFException { |
| generator.saveGraphicsState(); |
| generator.concatenate(toPoints(transform)); |
| } |
| |
| /** {@inheritDoc} */ |
| public void endGroup() throws IFException { |
| generator.restoreGraphicsState(); |
| } |
| |
| /** {@inheritDoc} */ |
| public void drawImage(String uri, Rectangle rect) |
| throws IFException { |
| PDFXObject xobject = getPDFDoc().getXObject(uri); |
| if (xobject != null) { |
| if (accessEnabled) { |
| String ptr = getContext().getStructurePointer(); |
| prepareImageMCID(ptr); |
| placeImageAccess(rect, xobject); |
| } else { |
| placeImage(rect, xobject); |
| } |
| } else { |
| if (accessEnabled) { |
| String ptr = getContext().getStructurePointer(); |
| prepareImageMCID(ptr); |
| } |
| drawImageUsingURI(uri, rect); |
| flushPDFDoc(); |
| } |
| } |
| |
| private void prepareImageMCID(String ptr) { |
| imageMCI = logicalStructureHandler.addImageContentItem(ptr); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| protected RenderingContext createRenderingContext() { |
| PDFRenderingContext pdfContext = new PDFRenderingContext( |
| getUserAgent(), generator, this.documentHandler.currentPage, getFontInfo()); |
| pdfContext.setMarkedContentInfo(imageMCI); |
| return pdfContext; |
| } |
| |
| /** |
| * Places a previously registered image at a certain place on the page. |
| * @param rect the rectangle for the image |
| * @param xobj the image XObject |
| */ |
| private void placeImage(Rectangle rect, PDFXObject xobj) { |
| generator.saveGraphicsState(); |
| generator.add(format(rect.width) + " 0 0 " |
| + format(-rect.height) + " " |
| + format(rect.x) + " " |
| + format(rect.y + rect.height ) |
| + " cm " + xobj.getName() + " Do\n"); |
| generator.restoreGraphicsState(); |
| } |
| /** |
| * Places a previously registered image at a certain place on the page - Accessibility version |
| * @param rect the rectangle for the image |
| * @param xobj the image XObject |
| */ |
| private void placeImageAccess(Rectangle rect, PDFXObject xobj) { |
| generator.saveGraphicsState(imageMCI.tag, imageMCI.mcid); |
| generator.add(format(rect.width) + " 0 0 " |
| + format(-rect.height) + " " |
| + format(rect.x) + " " |
| + format(rect.y + rect.height ) |
| + " cm " + xobj.getName() + " Do\n"); |
| generator.restoreGraphicsStateAccess(); |
| } |
| |
| /** {@inheritDoc} */ |
| public void drawImage(Document doc, Rectangle rect) throws IFException { |
| if (accessEnabled) { |
| String ptr = getContext().getStructurePointer(); |
| prepareImageMCID(ptr); |
| } |
| drawImageUsingDocument(doc, rect); |
| flushPDFDoc(); |
| } |
| |
| private void flushPDFDoc() throws IFException { |
| // output new data |
| try { |
| generator.flushPDFDoc(); |
| } catch (IOException ioe) { |
| throw new IFException("I/O error flushing the PDF document", ioe); |
| } |
| } |
| |
| /** |
| * Formats a integer value (normally coordinates in millipoints) to a String. |
| * @param value the value (in millipoints) |
| * @return the formatted value |
| */ |
| protected static String format(int value) { |
| return PDFNumber.doubleOut(value / 1000f); |
| } |
| |
| /** {@inheritDoc} */ |
| public void clipRect(Rectangle rect) throws IFException { |
| generator.endTextObject(); |
| generator.clipRect(rect); |
| } |
| |
| /** {@inheritDoc} */ |
| public void fillRect(Rectangle rect, Paint fill) throws IFException { |
| if (fill == null) { |
| return; |
| } |
| if (rect.width != 0 && rect.height != 0) { |
| generator.endTextObject(); |
| if (fill != null) { |
| if (fill instanceof Color) { |
| generator.updateColor((Color)fill, true, null); |
| } else { |
| throw new UnsupportedOperationException("Non-Color paints NYI"); |
| } |
| } |
| StringBuffer sb = new StringBuffer(); |
| sb.append(format(rect.x)).append(' '); |
| sb.append(format(rect.y)).append(' '); |
| sb.append(format(rect.width)).append(' '); |
| sb.append(format(rect.height)).append(" re"); |
| if (fill != null) { |
| sb.append(" f"); |
| } |
| /* Removed from method signature as it is currently not used |
| if (stroke != null) { |
| sb.append(" S"); |
| }*/ |
| sb.append('\n'); |
| generator.add(sb.toString()); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, |
| BorderProps left, BorderProps right) throws IFException { |
| if (top != null || bottom != null || left != null || right != null) { |
| generator.endTextObject(); |
| try { |
| this.borderPainter.drawBorders(rect, top, bottom, left, right); |
| } catch (IOException ioe) { |
| throw new IFException("I/O error while drawing borders", ioe); |
| } |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void drawLine(Point start, Point end, int width, Color color, RuleStyle style) |
| throws IFException { |
| generator.endTextObject(); |
| this.borderPainter.drawLine(start, end, width, color, style); |
| } |
| |
| private Typeface getTypeface(String fontName) { |
| if (fontName == null) { |
| throw new NullPointerException("fontName must not be null"); |
| } |
| Typeface tf = getFontInfo().getFonts().get(fontName); |
| if (tf instanceof LazyFont) { |
| tf = ((LazyFont)tf).getRealFont(); |
| } |
| return tf; |
| } |
| |
| /** {@inheritDoc} */ |
| public void drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, |
| String text) |
| throws IFException { |
| if (accessEnabled) { |
| String ptr = getContext().getStructurePointer(); |
| MarkedContentInfo mci = logicalStructureHandler.addTextContentItem(ptr); |
| if (generator.getTextUtil().isInTextObject()) { |
| generator.separateTextElements(mci.tag, mci.mcid); |
| } |
| generator.updateColor(state.getTextColor(), true, null); |
| generator.beginTextObject(mci.tag, mci.mcid); |
| } else { |
| generator.updateColor(state.getTextColor(), true, null); |
| generator.beginTextObject(); |
| } |
| |
| FontTriplet triplet = new FontTriplet( |
| state.getFontFamily(), state.getFontStyle(), state.getFontWeight()); |
| |
| if ( ( dp == null ) || IFUtil.isDPOnlyDX ( dp ) ) { |
| drawTextWithDX ( x, y, text, triplet, letterSpacing, |
| wordSpacing, IFUtil.convertDPToDX ( dp ) ); |
| } else { |
| drawTextWithDP ( x, y, text, triplet, letterSpacing, |
| wordSpacing, dp ); |
| } |
| } |
| |
| private void drawTextWithDX ( int x, int y, String text, FontTriplet triplet, |
| int letterSpacing, int wordSpacing, int[] dx ) { |
| |
| //TODO Ignored: state.getFontVariant() |
| //TODO Opportunity for font caching if font state is more heavily used |
| String fontKey = getFontInfo().getInternalFontKey(triplet); |
| int sizeMillipoints = state.getFontSize(); |
| float fontSize = sizeMillipoints / 1000f; |
| |
| // This assumes that *all* CIDFonts use a /ToUnicode mapping |
| Typeface tf = getTypeface(fontKey); |
| SingleByteFont singleByteFont = null; |
| if (tf instanceof SingleByteFont) { |
| singleByteFont = (SingleByteFont)tf; |
| } |
| Font font = getFontInfo().getFontInstance(triplet, sizeMillipoints); |
| String fontName = font.getFontName(); |
| |
| PDFTextUtil textutil = generator.getTextUtil(); |
| textutil.updateTf(fontKey, fontSize, tf.isMultiByte()); |
| |
| generator.updateCharacterSpacing(letterSpacing / 1000f); |
| |
| textutil.writeTextMatrix(new AffineTransform(1, 0, 0, -1, x / 1000f, y / 1000f)); |
| int l = text.length(); |
| int dxl = (dx != null ? dx.length : 0); |
| |
| if (dx != null && dxl > 0 && dx[0] != 0) { |
| textutil.adjustGlyphTJ(-dx[0] / fontSize); |
| } |
| for (int i = 0; i < l; i++) { |
| char orgChar = text.charAt(i); |
| char ch; |
| float glyphAdjust = 0; |
| if (font.hasChar(orgChar)) { |
| ch = font.mapChar(orgChar); |
| ch = selectAndMapSingleByteFont(singleByteFont, fontName, fontSize, textutil, ch); |
| if ((wordSpacing != 0) && CharUtilities.isAdjustableSpace(orgChar)) { |
| glyphAdjust += wordSpacing; |
| } |
| } else { |
| if (CharUtilities.isFixedWidthSpace(orgChar)) { |
| //Fixed width space are rendered as spaces so copy/paste works in a reader |
| ch = font.mapChar(CharUtilities.SPACE); |
| int spaceDiff = font.getCharWidth(ch) - font.getCharWidth(orgChar); |
| glyphAdjust = -spaceDiff; |
| } else { |
| ch = font.mapChar(orgChar); |
| if ((wordSpacing != 0) && CharUtilities.isAdjustableSpace(orgChar)) { |
| glyphAdjust += wordSpacing; |
| } |
| } |
| ch = selectAndMapSingleByteFont(singleByteFont, fontName, fontSize, |
| textutil, ch); |
| } |
| textutil.writeTJMappedChar(ch); |
| |
| if (dx != null && i < dxl - 1) { |
| glyphAdjust += dx[i + 1]; |
| } |
| |
| if (glyphAdjust != 0) { |
| textutil.adjustGlyphTJ(-glyphAdjust / fontSize); |
| } |
| |
| } |
| textutil.writeTJ(); |
| } |
| |
| private static int[] paZero = new int[4]; |
| |
| private void drawTextWithDP ( int x, int y, String text, FontTriplet triplet, |
| int letterSpacing, int wordSpacing, int[][] dp ) { |
| assert text != null; |
| assert triplet != null; |
| assert dp != null; |
| String fk = getFontInfo().getInternalFontKey(triplet); |
| Typeface tf = getTypeface(fk); |
| if ( tf.isMultiByte() ) { |
| int fs = state.getFontSize(); |
| float fsPoints = fs / 1000f; |
| Font f = getFontInfo().getFontInstance(triplet, fs); |
| // String fn = f.getFontName(); |
| PDFTextUtil tu = generator.getTextUtil(); |
| double xc = 0f; |
| double yc = 0f; |
| double xoLast = 0f; |
| double yoLast = 0f; |
| double wox = wordSpacing; |
| tu.writeTextMatrix ( new AffineTransform ( 1, 0, 0, -1, x / 1000f, y / 1000f ) ); |
| tu.updateTf ( fk, fsPoints, true ); |
| generator.updateCharacterSpacing ( letterSpacing / 1000f ); |
| for ( int i = 0, n = text.length(); i < n; i++ ) { |
| char ch = text.charAt ( i ); |
| int[] pa = ( i < dp.length ) ? dp [ i ] : paZero; |
| double xo = xc + pa[0]; |
| double yo = yc + pa[1]; |
| double xa = f.getCharWidth(ch) + maybeWordOffsetX ( wox, ch, null ); |
| double ya = 0; |
| double xd = ( xo - xoLast ) / 1000f; |
| double yd = ( yo - yoLast ) / 1000f; |
| tu.writeTd ( xd, yd ); |
| tu.writeTj ( f.mapChar ( ch ) ); |
| xc += xa + pa[2]; |
| yc += ya + pa[3]; |
| xoLast = xo; |
| yoLast = yo; |
| } |
| } |
| } |
| |
| private double maybeWordOffsetX ( double wox, char ch, Direction dir ) { |
| if ( ( wox != 0 ) |
| && CharUtilities.isAdjustableSpace ( ch ) |
| && ( ( dir == null ) || dir.isHorizontal() ) ) { |
| return wox; |
| } else { |
| return 0; |
| } |
| } |
| |
| /* |
| private double maybeWordOffsetY ( double woy, char ch, Direction dir ) { |
| if ( ( woy != 0 ) |
| && CharUtilities.isAdjustableSpace ( ch ) && dir.isVertical() |
| && ( ( dir != null ) && dir.isVertical() ) ) { |
| return woy; |
| } else { |
| return 0; |
| } |
| } |
| */ |
| |
| private char selectAndMapSingleByteFont(SingleByteFont singleByteFont, String fontName, |
| float fontSize, PDFTextUtil textutil, char ch) { |
| if (singleByteFont != null && singleByteFont.hasAdditionalEncodings()) { |
| int encoding = ch / 256; |
| if (encoding == 0) { |
| textutil.updateTf(fontName, fontSize, singleByteFont.isMultiByte()); |
| } else { |
| textutil.updateTf(fontName + "_" + Integer.toString(encoding), |
| fontSize, singleByteFont.isMultiByte()); |
| ch = (char)(ch % 256); |
| } |
| } |
| return ch; |
| } |
| |
| } |
