import org.apache.fop.render.ps.extensions.PSExtensionAttachment;
import org.apache.fop.render.ps.extensions.PSSetPageDevice;
import org.apache.fop.render.ps.extensions.PSSetupCode;
+import org.apache.fop.render.ps.extensions.PSCommentAfter;
+import org.apache.fop.render.ps.extensions.PSCommentBefore;
import org.apache.fop.util.CharUtilities;
import org.apache.xmlgraphics.ps.DSCConstants;
private boolean ioTrouble = false;
private boolean inTextMode = false;
- private boolean firstPageSequenceReceived = false;
/** Used to temporarily store PSSetupCode instance until they can be written. */
private List setupCodeList;
/** Whether or not Dublin Core Standard (dsc) compliant output is enforced */
private boolean dscCompliant = true;
+ /** This is a collection holding all document header comments */
+ private Collection headerComments;
+
+ /** This is a collection holding all document footer comments */
+ private Collection footerComments;
/**
* {@inheritDoc}
*/
this.pageDeviceDictionary = new PSPageDeviceDictionary();
pageDeviceDictionary.setFlushOnRetrieval(!this.dscCompliant);
pageDeviceDictionary.put("/ImagingBBox", "null");
+ }
+ private void writeHeader() throws IOException {
//PostScript Header
writeln(DSCConstants.PS_ADOBE_30);
gen.writeDSCComment(DSCConstants.CREATOR, new String[] {userAgent.getProducer()});
gen.writeDSCComment(DSCConstants.PAGES, new Object[] {DSCConstants.ATEND});
gen.writeDSCComment(DSCConstants.DOCUMENT_SUPPLIED_RESOURCES,
new Object[] {DSCConstants.ATEND});
+ if (headerComments != null) {
+ for (Iterator iter = headerComments.iterator(); iter.hasNext();) {
+ PSExtensionAttachment comment = (PSExtensionAttachment)iter.next();
+ gen.writeln("%" + comment.getContent());
+ }
+ }
gen.writeDSCComment(DSCConstants.END_COMMENTS);
//Defaults
gen.writeDSCComment(DSCConstants.END_DEFAULTS);
//Prolog and Setup written right before the first page-sequence, see startPageSequence()
+ //Do this only once, as soon as we have all the content for the Setup section!
+ //Prolog
+ gen.writeDSCComment(DSCConstants.BEGIN_PROLOG);
+ PSProcSets.writeStdProcSet(gen);
+ PSProcSets.writeEPSProcSet(gen);
+ gen.writeDSCComment(DSCConstants.END_PROLOG);
+
+ //Setup
+ gen.writeDSCComment(DSCConstants.BEGIN_SETUP);
+ writeSetupCodeList(setupCodeList, "SetupCode");
+ if (!twoPassGeneration) {
+ this.fontResources = PSFontUtils.writeFontDict(gen, fontInfo);
+ } else {
+ gen.commentln("%FOPFontSetup");
+ }
+ gen.writeDSCComment(DSCConstants.END_SETUP);
}
/**
//Write trailer
gen.writeDSCComment(DSCConstants.TRAILER);
+ if (footerComments != null) {
+ for (Iterator iter = footerComments.iterator(); iter.hasNext();) {
+ PSExtensionAttachment comment = (PSExtensionAttachment)iter.next();
+ gen.commentln("%" + comment.getContent());
+ }
+ }
gen.writeDSCComment(DSCConstants.PAGES, new Integer(this.currentPageNumber));
gen.getResourceTracker().writeResources(false, gen);
gen.writeDSCComment(DSCConstants.EOF);
+ e.getMessage() + ", content = '" + content + "'");
}
}
- }
+ } else if (attachment instanceof PSCommentBefore) {
+ if (headerComments == null) {
+ headerComments = new java.util.TreeSet();
+ }
+ headerComments.add(attachment);
+ } else if (attachment instanceof PSCommentAfter) {
+ if (footerComments == null) {
+ footerComments = new java.util.TreeSet();
+ }
+ footerComments.add(attachment);
+ }
}
}
}
/** {@inheritDoc} */
public void startPageSequence(LineArea seqTitle) {
super.startPageSequence(seqTitle);
- if (!firstPageSequenceReceived) {
- //Do this only once, as soon as we have all the content for the Setup section!
- try {
- //Prolog
- gen.writeDSCComment(DSCConstants.BEGIN_PROLOG);
- PSProcSets.writeStdProcSet(gen);
- PSProcSets.writeEPSProcSet(gen);
- gen.writeDSCComment(DSCConstants.END_PROLOG);
-
- //Setup
- gen.writeDSCComment(DSCConstants.BEGIN_SETUP);
- writeSetupCodeList(setupCodeList, "SetupCode");
- if (!twoPassGeneration) {
- this.fontResources = PSFontUtils.writeFontDict(gen, fontInfo);
- } else {
- gen.commentln("%FOPFontSetup");
- }
- gen.writeDSCComment(DSCConstants.END_SETUP);
- } catch (IOException ioe) {
- handleIOTrouble(ioe);
- }
-
- firstPageSequenceReceived = true;
- }
}
/**
throws IOException, FOPException {
log.debug("renderPage(): " + page);
+ if (this.currentPageNumber == 0) {
+ writeHeader();
+ }
+
this.currentPageNumber++;
gen.getResourceTracker().notifyStartNewPage();
gen.writeDSCComment(DSCConstants.BEGIN_PAGE_SETUP);
+ if (page.hasExtensionAttachments()) {
+ List extensionAttachments = page.getExtensionAttachments();
+ for (int i = 0; i < extensionAttachments.size(); i++) {
+ PSExtensionAttachment attachment
+ = (PSExtensionAttachment)extensionAttachments.get(i);
+ if (attachment instanceof PSCommentBefore) {
+ gen.commentln("%" + attachment.getContent());
+ }
+ }
+ }
+
// Write any unwritten changes to page device dictionary
if (!pageDeviceDictionary.isEmpty()) {
String content = pageDeviceDictionary.getContent();
//Show page
writeln("showpage");
gen.writeDSCComment(DSCConstants.PAGE_TRAILER);
-
+ if (page.hasExtensionAttachments()) {
+ List extensionAttachments = page.getExtensionAttachments();
+ for (int i = 0; i < extensionAttachments.size(); i++) {
+ PSExtensionAttachment attachment;
+ attachment = (PSExtensionAttachment)extensionAttachments.get(i);
+ if (attachment instanceof PSCommentAfter) {
+ gen.commentln("%" + attachment.getContent());
+ }
+ }
+ }
gen.getResourceTracker().writeResources(true, gen);
}
iter.remove();
}
}
-
+
/**
* Sets whether or not the safe set page device macro should be used
* (as opposed to directly invoking setpagedevice) when setting the
*/
public void setDSCCompliant(boolean dscCompliant) {
this.dscCompliant = dscCompliant;
- }
+ }
}
--- /dev/null
+/*
+ * 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.ps.extensions;
+
+import org.apache.fop.apps.FOPException;
+import org.apache.fop.fo.Constants;
+import org.apache.fop.fo.FONode;
+import org.apache.fop.fo.ValidationException;
+
+/**
+ * Base postscript commment element class
+ */
+public abstract class AbstractPSCommentElement extends AbstractPSExtensionElement {
+
+ /**
+ * Default constructor
+ *
+ * @param parent parent of this node
+ * @see org.apache.fop.fo.FONode#FONode(FONode)
+ */
+ public AbstractPSCommentElement(FONode parent) {
+ super(parent);
+ }
+
+ /**
+ * @throws FOPException if there's a problem during processing
+ * @see org.apache.fop.fo.FONode#startOfNode()
+ */
+ protected void startOfNode() throws FOPException {
+ if (parent.getNameId() != Constants.FO_DECLARATIONS
+ && parent.getNameId() != Constants.FO_SIMPLE_PAGE_MASTER) {
+ throw new ValidationException(getName()
+ + " must be a child of fo:declarations or fo:simple-page-master.");
+ }
+ }
+
+}
--- /dev/null
+/*
+ * 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.ps.extensions;
+
+/**
+ * Custom postscript comment after class
+ */
+public class PSCommentAfter extends PSExtensionAttachment {
+
+ /**
+ * Element name
+ */
+ protected static final String ELEMENT = "ps-comment-after";
+
+ /**
+ * Default constructor
+ */
+ public PSCommentAfter() {
+ super();
+ }
+
+ /**
+ * Constructor
+ * @param content comment
+ */
+ public PSCommentAfter(String content) {
+ super(content);
+ }
+
+ /**
+ * @return the element name
+ */
+ protected String getElement() {
+ return ELEMENT;
+ }
+}
--- /dev/null
+/*
+ * 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.ps.extensions;
+
+import org.apache.fop.fo.FONode;
+import org.apache.fop.fo.extensions.ExtensionAttachment;
+
+/**
+ * Comment after element
+ */
+public class PSCommentAfterElement extends AbstractPSCommentElement {
+
+ /**
+ * Main constructor
+ * @param parent node
+ */
+ public PSCommentAfterElement(FONode parent) {
+ super(parent);
+ }
+
+ /**
+ * @return local name
+ * @see org.apache.fop.fo.FONode#getLocalName()
+ */
+ public String getLocalName() {
+ return "ps-comment-after";
+ }
+
+ /**
+ * @return instance of its extension attachment object
+ * @see org.apache.fop.render.ps.extensions.AbstractPSExtensionElement
+ * #instantiateExtensionAttachment()
+ */
+ protected ExtensionAttachment instantiateExtensionAttachment() {
+ return new PSCommentAfter();
+ }
+}
--- /dev/null
+/*
+ * 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.ps.extensions;
+
+/**
+ * Custom postscript comment before class
+ */
+public class PSCommentBefore extends PSExtensionAttachment {
+
+ /**
+ * Element name
+ */
+ protected static final String ELEMENT = "ps-comment-before";
+
+ /**
+ * Default constructor
+ * @param content the actual comment
+ */
+ public PSCommentBefore(String content) {
+ super(content);
+ }
+
+ /**
+ * Constructor
+ */
+ public PSCommentBefore() {
+ super();
+ }
+
+ /**
+ * @return element name
+ */
+ protected String getElement() {
+ return ELEMENT;
+ }
+}
--- /dev/null
+/*
+ * 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.ps.extensions;
+
+import org.apache.fop.fo.FONode;
+import org.apache.fop.fo.extensions.ExtensionAttachment;
+
+/**
+ * Comment before element
+ */
+public class PSCommentBeforeElement extends AbstractPSCommentElement {
+
+ /**
+ * Main constructor
+ * @param parent parent node
+ */
+ public PSCommentBeforeElement(FONode parent) {
+ super(parent);
+ }
+
+ /**
+ * @return local name
+ * @see org.apache.fop.fo.FONode#getLocalName()
+ */
+ public String getLocalName() {
+ return "ps-comment-before";
+ }
+
+ /**
+ * @return instance of its extension attachment object
+ */
+ protected ExtensionAttachment instantiateExtensionAttachment() {
+ return new PSCommentBefore();
+ }
+}
foObjs.put("ps-setup-code", new PSSetupCodeMaker());
foObjs.put("ps-page-setup-code", new PSPageSetupCodeMaker());
foObjs.put("ps-setpagedevice", new PSSetPageDeviceMaker());
+ foObjs.put("ps-comment-before", new PSCommentBeforeMaker());
+ foObjs.put("ps-comment-after", new PSCommentAfterMaker());
}
}
return new PSSetPageDeviceElement(parent);
}
}
+
+ static class PSCommentBeforeMaker extends ElementMapping.Maker {
+ public FONode make(FONode parent) {
+ return new PSCommentBeforeElement(parent);
+ }
+ }
+
+ static class PSCommentAfterMaker extends ElementMapping.Maker {
+ public FONode make(FONode parent) {
+ return new PSCommentAfterElement(parent);
+ }
+ }
}
lastAttributes = attributes;
handled = false;
if (localName.equals(PSSetupCode.ELEMENT)
- || localName.equals(PSSetPageDevice.ELEMENT)) {
+ || localName.equals(PSSetPageDevice.ELEMENT)
+ || localName.equals(PSCommentBefore.ELEMENT)
+ || localName.equals(PSCommentAfter.ELEMENT)) {
//handled in endElement
handled = true;
}
} else if (PSSetPageDevice.ELEMENT.equals(localName)) {
String name = lastAttributes.getValue("name");
this.returnedObject = new PSSetPageDevice(name, content.toString());
+ } else if (PSCommentBefore.ELEMENT.equals(localName)) {
+ this.returnedObject = new PSCommentBefore(content.toString());
+ } else if (PSCommentAfter.ELEMENT.equals(localName)) {
+ this.returnedObject = new PSCommentAfter(content.toString());
}
}
content.setLength(0); //Reset text buffer (see characters())
<fo:layout-master-set>\r
<fo:simple-page-master master-name="A4" page-height="29.7cm" page-width="21cm" margin-top="1cm" margin-bottom="2cm" margin-left="2.5cm" margin-right="2.5cm">\r
<ps:ps-setpagedevice name="lower tray"><![CDATA[ << /MediaPosition /4 >> ]]></ps:ps-setpagedevice>\r
+ <ps:ps-comment-before>A4 before page</ps:ps-comment-before>\r
+ <ps:ps-comment-after>A4 after page</ps:ps-comment-after>\r
<fo:region-body/>\r
</fo:simple-page-master>\r
<fo:simple-page-master master-name="A4a" page-height="29.7cm" page-width="21cm" margin-top="1cm" margin-bottom="2cm" margin-left="2.5cm" margin-right="2.5cm">\r
<ps:ps-setpagedevice name="upper tray"><![CDATA[ << /MediaPosition /1 >> ]]></ps:ps-setpagedevice>\r
+ <ps:ps-comment-before>A4a before page</ps:ps-comment-before>\r
+ <ps:ps-comment-after>A4a after page</ps:ps-comment-after>\r
<fo:region-body background-color="orange"/>\r
</fo:simple-page-master>\r
<fo:page-sequence-master master-name="complex">\r
</fo:layout-master-set>\r
<fo:declarations>\r
<ps:ps-setpagedevice name="autofeed"><![CDATA[ << /ManualFeed false >> ]]></ps:ps-setpagedevice>\r
+ <ps:ps-comment-before>header comment</ps:ps-comment-before>\r
+ <ps:ps-comment-after>footer comment</ps:ps-comment-after>\r
</fo:declarations>\r
<fo:page-sequence master-reference="complex">\r
<fo:flow flow-name="xsl-region-body">\r
</fo:root>\r
</fo>\r
<checks>\r
- <eval expected="1" xpath="count(/areaTree/child::extension-attachments/child::*)"/>\r
+ <eval expected="2" xpath="count(/areaTree/child::*)"/>\r
+ <eval expected="1" xpath="count(/areaTree/child::pageSequence)"/>\r
+ <eval expected="1" xpath="count(/areaTree/child::extension-attachments)"/>\r
+ <eval expected="3" xpath="count(/areaTree/child::extension-attachments/child::*)"/>\r
<eval expected="autofeed" xpath="/areaTree/extension-attachments/child::*[1]/@name"/>\r
+ <eval expected="header comment" xpath="/areaTree/extension-attachments/child::*[2]/text()"/>\r
+ <eval expected="footer comment" xpath="/areaTree/extension-attachments/child::*[3]/text()"/>\r
\r
- <eval expected="1" xpath="count(/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=1]/page/extension-attachments/child::*)"/>\r
+ <eval expected="3" xpath="count(/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=1]/page/extension-attachments/child::*)"/>\r
<eval expected="lower tray" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=1]/page/extension-attachments/child::*[1]/@name"/>\r
+ <eval expected="A4 before page" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=1]/page/extension-attachments/child::*[2]"/>\r
+ <eval expected="A4 after page" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=1]/page/extension-attachments/child::*[3]"/>\r
\r
- <eval expected="1" xpath="count(/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4a' and @nr=2]/page/extension-attachments/child::*)"/>\r
+ <eval expected="3" xpath="count(/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4a' and @nr=2]/page/extension-attachments/child::*)"/>\r
<eval expected="upper tray" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4a' and @nr=2]/page/extension-attachments/child::*[1]/@name"/>\r
+ <eval expected="A4a before page" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4a' and @nr=2]/page/extension-attachments/child::*[2]"/>\r
+ <eval expected="A4a after page" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4a' and @nr=2]/page/extension-attachments/child::*[3]"/>\r
\r
- <eval expected="1" xpath="count(/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=3]/page/extension-attachments/child::*)"/>\r
+ <eval expected="3" xpath="count(/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=3]/page/extension-attachments/child::*)"/>\r
<eval expected="lower tray" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=3]/page/extension-attachments/child::*[1]/@name"/>\r
+ <eval expected="A4 before page" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=3]/page/extension-attachments/child::*[2]"/>\r
+ <eval expected="A4 after page" xpath="/areaTree/pageSequence/pageViewport[@simple-page-master-name='A4' and @nr=3]/page/extension-attachments/child::*[3]"/>\r
</checks>\r
</testcase>\r
projects / xmlgraphics-fop.git / commitdiff