From 450983718dfcc1292490ad8b76be5eb32c367f91 Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 25 May 2021 13:44:45 +1000 Subject: [PATCH 01/54] #364 Basic test for footnotes (failing). Test kindly provided by @a-leithner --- .../html/issue-364-footnotes-basic.html | 26 +++++++++++++++++++ .../VisualRegressionTest.java | 9 +++++++ 2 files changed, 35 insertions(+) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html new file mode 100644 index 000000000..fdc808ac1 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html @@ -0,0 +1,26 @@ + + + + + +

+ This text needs some footnotes.This is a footnote. +

+ + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index 4a91145f4..f30d6feb0 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1413,6 +1413,15 @@ public void testIssue649MultipleBgImagesPageBox() throws IOException { assertTrue(vt.runTest("issue-649-multiple-bg-images-page-box")); } + /** + * Tests that we support CSS footnotes. + */ + @Test + @Ignore // Footnotes not implemented. + public void testIssue364FootnotesBasicExample() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-basic")); + } + // TODO: // + Elements that appear just on generated overflow pages. // + content property (page counters, etc) From 2bc0a97e6f4e4f061a0255b22c256c9d7c11200f Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 25 May 2021 14:16:10 +1000 Subject: [PATCH 02/54] #364 Add footnote and bottom as allowed values for float. --- .../java/com/openhtmltopdf/css/constants/IdentValue.java | 5 +++++ .../css/parser/property/PrimitivePropertyBuilders.java | 5 ++++- .../java/com/openhtmltopdf/css/style/CalculatedStyle.java | 4 ++++ .../src/main/java/com/openhtmltopdf/layout/BoxBuilder.java | 7 ++++++- .../src/main/java/com/openhtmltopdf/render/BlockBox.java | 4 ++++ .../main/java/com/openhtmltopdf/render/FootnoteData.java | 5 +++++ 6 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java index f1f36b156..00f23a544 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java @@ -256,6 +256,11 @@ public class IdentValue implements FSDerivedValue { */ public static final IdentValue COLUMN = addValue("column"); + /** + * CSS footnotes for use in float: footnote + */ + public static final IdentValue FOOTNOTE = addValue("footnote"); + /** * Constructor for the IdentValue object * diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/property/PrimitivePropertyBuilders.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/property/PrimitivePropertyBuilders.java index 9d2272322..5c56688a8 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/property/PrimitivePropertyBuilders.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/property/PrimitivePropertyBuilders.java @@ -663,8 +663,11 @@ protected BitSet getAllowed() { public static class Float extends SingleIdent { // left | right | none | inherit + // bottom | footnote private static final BitSet ALLOWED = setFor( - new IdentValue[] { IdentValue.LEFT, IdentValue.RIGHT, IdentValue.NONE }); + new IdentValue[] { + IdentValue.LEFT, IdentValue.RIGHT, IdentValue.NONE, + IdentValue.BOTTOM, IdentValue.FOOTNOTE }); @Override protected BitSet getAllowed() { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java index 51ea6fb22..64721b5d4 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java @@ -868,6 +868,10 @@ public boolean isFloatedRight() { return isIdent(CSSName.FLOAT, IdentValue.RIGHT); } + public boolean isFootnote() { + return isIdent(CSSName.FLOAT, IdentValue.FOOTNOTE); + } + public boolean isRelative() { return isIdent(CSSName.POSITION, IdentValue.RELATIVE); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index 1bd296ded..484d85b05 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -63,6 +63,7 @@ import com.openhtmltopdf.render.FloatedBoxData; import com.openhtmltopdf.render.FlowingColumnBox; import com.openhtmltopdf.render.FlowingColumnContainerBox; +import com.openhtmltopdf.render.FootnoteData; import com.openhtmltopdf.render.InlineBox; /** @@ -1038,7 +1039,11 @@ private static List createGeneratedMarginBoxContent( private static BlockBox createBlockBox( CalculatedStyle style, ChildBoxInfo info, boolean generated) { - if (style.isFloated() && !(style.isAbsolute() || style.isFixed())) { + if (style.isFootnote()) { + BlockBox result = new BlockBox(); + result.setFootnoteData(new FootnoteData()); + return result; + } else if (style.isFloated() && !(style.isAbsolute() || style.isFixed())) { BlockBox result; if (style.isTable() || style.isInlineTable()) { result = new TableBox(); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java index 3d6625a27..1846fe515 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java @@ -2400,6 +2400,10 @@ public boolean hasMargin() { return maxPositive != 0 || maxNegative != 0; } } + + public void setFootnoteData(FootnoteData footnoteData) { + // TODO Auto-generated method stub + } } /* diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java new file mode 100644 index 000000000..7e5fd2516 --- /dev/null +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java @@ -0,0 +1,5 @@ +package com.openhtmltopdf.render; + +public class FootnoteData { + +} From d28dc9b1fe8809fbfc61d253800cfbac07171c1d Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 25 May 2021 17:28:02 +1000 Subject: [PATCH 03/54] #364 Progress on pseudo classes plus cleanup of BoxBuilder. --- .../css/constants/IdentValue.java | 1 + .../openhtmltopdf/css/parser/CSSParser.java | 3 + .../css/style/CalculatedStyle.java | 354 +----------------- .../com/openhtmltopdf/layout/BoxBuilder.java | 331 +++++++++------- .../com/openhtmltopdf/render/BlockBox.java | 8 +- .../com/openhtmltopdf/render/InlineBox.java | 14 + .../html/issue-364-footnotes-basic.html | 4 +- 7 files changed, 235 insertions(+), 480 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java index 00f23a544..116020cb1 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/constants/IdentValue.java @@ -260,6 +260,7 @@ public class IdentValue implements FSDerivedValue { * CSS footnotes for use in float: footnote */ public static final IdentValue FOOTNOTE = addValue("footnote"); + public static final IdentValue FS_FOOTNOTE_BODY = addValue("-fs-footnote-body"); /** * Constructor for the IdentValue object diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java index 0f0692978..cdcb8da73 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java @@ -47,6 +47,9 @@ public class CSSParser { SUPPORTED_PSEUDO_ELEMENTS.add("before"); SUPPORTED_PSEUDO_ELEMENTS.add("after"); + SUPPORTED_PSEUDO_ELEMENTS.add("footnote-call"); + SUPPORTED_PSEUDO_ELEMENTS.add("footnote-marker"); + CSS21_PSEUDO_ELEMENTS = new HashSet<>(); CSS21_PSEUDO_ELEMENTS.add("first-line"); CSS21_PSEUDO_ELEMENTS.add("first-letter"); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java index 64721b5d4..094f9b26c 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java @@ -872,6 +872,10 @@ public boolean isFootnote() { return isIdent(CSSName.FLOAT, IdentValue.FOOTNOTE); } + public boolean isFootnoteBody() { + return isIdent(CSSName.DISPLAY, IdentValue.FS_FOOTNOTE_BODY); + } + public boolean isRelative() { return isIdent(CSSName.POSITION, IdentValue.RELATIVE); } @@ -1449,353 +1453,3 @@ public List getBackgroundImages() { return backgrounds; } } - -/* - * $Id$ - * - * $Log$ - * Revision 1.110 2010/01/12 14:33:27 peterbrant - * Ignore auto margins when calculating table min/max width. Also, when deciding whether or not to proceed with the auto margin calculation for a table, make sure we compare consistently with how the table min width is actually set. - * - * Revision 1.109 2009/11/08 23:52:48 peterbrant - * Treat percentage widths as auto when calculating min/max widths - * - * Revision 1.108 2009/05/09 14:17:41 pdoubleya - * FindBugs: static field should not be mutable; use inner class to declare CSS 4-side properties - * - * Revision 1.107 2009/04/25 10:48:42 pdoubleya - * Small opt, don't pull Ident unless needed, patch from Peter Fassev issue #263 - * - * Revision 1.106 2008/12/14 19:27:16 peterbrant - * Always treat running elements as blocks - * - * Revision 1.105 2008/12/14 13:53:32 peterbrant - * Implement -fs-keep-with-inline: keep property that instructs FS to try to avoid breaking a box so that only borders and padding appear on a page - * - * Revision 1.104 2008/09/06 18:21:50 peterbrant - * Need to account for list-marker-position: inside when calculating inline min/max widths - * - * Revision 1.103 2008/08/01 22:23:54 peterbrant - * Fix various bugs related to collapsed table borders (one manifestation found by Olly Headey) - * - * Revision 1.102 2008/07/27 00:21:48 peterbrant - * Implement CMYK color support for PDF output, starting with patch from Mykola Gurov / Banish java.awt.Color from FS core layout classes - * - * Revision 1.101 2008/07/14 11:12:37 peterbrant - * Fix two bugs when -fs-table-paginate is paginate. Block boxes in cells in a that were also early on the page could be positioned incorrectly. Line boxes contained within inline-block or inline-table content in a paginated table were generally placed incorrectly. - * - * Revision 1.100 2007/08/29 22:18:19 peterbrant - * Experiment with text justification - * - * Revision 1.99 2007/08/27 19:44:06 peterbrant - * Rename -fs-table-pagination to -fs-table-paginate - * - * Revision 1.98 2007/08/19 22:22:53 peterbrant - * Merge R8pbrant changes to HEAD - * - * Revision 1.97.2.4 2007/08/17 23:53:32 peterbrant - * Get rid of layer hack for overflow: hidden - * - * Revision 1.97.2.3 2007/08/16 22:38:48 peterbrant - * Further progress on table pagination - * - * Revision 1.97.2.2 2007/07/11 22:48:29 peterbrant - * Further progress on running headers and footers - * - * Revision 1.97.2.1 2007/07/09 22:18:04 peterbrant - * Begin work on running headers and footers and named pages - * - * Revision 1.97 2007/06/26 18:24:52 peterbrant - * Improve calculation of line-height: normal / If leading is positive, recalculate to center glyph area in inline box - * - * Revision 1.96 2007/06/19 22:31:46 peterbrant - * Only cache all zeros margin, border, padding. See discussion on bug #147 for more info. - * - * Revision 1.95 2007/06/14 22:39:31 tobega - * Handling counters in LayoutContext instead. We still need to get the value from the counter function and change list-item counting. - * - * Revision 1.94 2007/06/13 14:16:00 peterbrant - * Comment out body of resolveCounters() for now - * - * Revision 1.93 2007/06/12 22:59:23 tobega - * Handling counters is done. Now we just need to get the values appropriately. - * - * Revision 1.92 2007/06/05 19:29:54 peterbrant - * More progress on counter support - * - * Revision 1.91 2007/05/24 19:56:52 peterbrant - * Add support for cursor property (predefined cursors only) - * - * Patch from Sean Bright - * - * Revision 1.90 2007/04/16 01:10:06 peterbrant - * Vertical margin and padding with percentage values may be incorrect if box participated in a shrink-to-fit calculation. Fix margin calculation. - * - * Revision 1.89 2007/04/14 20:09:39 peterbrant - * Add method to clear cached rects - * - * Revision 1.88 2007/03/01 20:17:10 peterbrant - * Tables with collapsed borders don't have padding - * - * Revision 1.87 2007/02/28 18:16:32 peterbrant - * Support multiple values for text-decoration (per spec) - * - * Revision 1.86 2007/02/26 16:25:51 peterbrant - * Method name change to avoid confusion with visibility: hidden / Don't create empty inline boxes after all (inline layout will ignore them anyway) / Robustness improvements to generated content (treat display: table/table row groups/table-row as regular block boxes) - * - * Revision 1.85 2007/02/24 00:46:38 peterbrant - * Paint root element background over entire canvas (or it's first child if the root element doesn't define a background) - * - * Revision 1.84 2007/02/23 21:04:26 peterbrant - * Implement complete support for background-position and background-attachment - * - * Revision 1.83 2007/02/23 16:54:38 peterbrant - * Allow special ident -fs-intial-value to reset a property value to its initial value (used by border related shorthand properties as 'color' won't be known at property construction time) - * - * Revision 1.82 2007/02/22 18:21:20 peterbrant - * Add support for overflow: visible/hidden - * - * Revision 1.81 2007/02/21 01:19:12 peterbrant - * Need to take unit into account when creating Length objects with non-pixel units - * - * Revision 1.80 2007/02/20 20:05:40 peterbrant - * Complete support for absolute and relative font sizes - * - * Revision 1.79 2007/02/20 16:11:11 peterbrant - * Comment out references to CSSName.OVERFLOW - * - * Revision 1.78 2007/02/20 01:17:11 peterbrant - * Start CSS parser cleanup - * - * Revision 1.77 2007/02/20 00:01:12 peterbrant - * asColor() fix - * - * Revision 1.76 2007/02/19 23:18:43 peterbrant - * Further work on new CSS parser / Misc. bug fixes - * - * Revision 1.75 2007/02/19 14:53:43 peterbrant - * Integrate new CSS parser - * - * Revision 1.74 2007/02/07 16:33:28 peterbrant - * Initial commit of rewritten table support and associated refactorings - * - * Revision 1.73 2007/01/16 16:11:38 peterbrant - * Don't copy derived values as they propagate down the style tree (don't need to anymore - * now that we don't cache length values in LengthValue and PointValue) - * - * Revision 1.72 2006/10/04 23:52:57 peterbrant - * Implement support for margin: auto (centering blocks in their containing block) - * - * Revision 1.71 2006/09/06 22:21:43 peterbrant - * Fixes to shrink-to-fit implementation / Implement min/max-width (non-replaced content) only - * - * Revision 1.70 2006/09/01 23:49:40 peterbrant - * Implement basic margin collapsing / Various refactorings in preparation for shrink-to-fit / Add hack to treat auto margins as zero - * - * Revision 1.69 2006/08/29 17:29:14 peterbrant - * Make Style object a thing of the past - * - * Revision 1.68 2006/08/27 00:36:16 peterbrant - * Initial commit of (initial) R7 work - * - * Revision 1.67 2006/05/15 05:46:51 pdoubleya - * Return value from abs value check never assigned! - * - * Revision 1.66 2006/05/08 21:24:24 pdoubleya - * Log, don't throw exception, if we check for an absolute unit but it doesn't make sense to do so (IdentValue.hasAbsoluteUnit()). - * - * Revision 1.65 2006/05/08 20:56:09 pdoubleya - * Clean exception handling for case where assigned property value is not understood as a valid value; use initial value instead. - * - * Revision 1.64 2006/02/21 19:30:34 peterbrant - * Reset negative values for padding/border-width to 0 - * - * Revision 1.63 2006/02/01 01:30:16 peterbrant - * Initial commit of PDF work - * - * Revision 1.62 2006/01/27 01:15:44 peterbrant - * Start on better support for different output devices - * - * Revision 1.61 2006/01/03 17:04:54 peterbrant - * Many pagination bug fixes / Add ability to position absolute boxes in margin area - * - * Revision 1.60 2006/01/03 02:11:15 peterbrant - * Expose asString() for all - * - * Revision 1.59 2006/01/01 02:38:22 peterbrant - * Merge more pagination work / Various minor cleanups - * - * Revision 1.58 2005/12/13 02:41:36 peterbrant - * Initial implementation of vertical-align: top/bottom (not done yet) / Minor cleanup and optimization - * - * Revision 1.57 2005/12/08 02:16:11 peterbrant - * Thread safety fix - * - * Revision 1.56 2005/12/05 00:09:04 peterbrant - * Couple of optimizations which improve layout speed by about 10% - * - * Revision 1.55 2005/11/25 16:57:26 peterbrant - * Initial commit of inline content refactoring - * - * Revision 1.54 2005/11/10 22:15:41 peterbrant - * Fix (hopefully) exception on identifiers which are converted by the CSS layer (e.g. thick becomes 3px) - * - * Revision 1.53 2005/11/08 22:53:44 tobega - * added getLineHeight method to CalculatedStyle and hacked in some list-item support - * - * Revision 1.52 2005/10/31 22:43:15 tobega - * Some memory optimization of the Matcher. Probably cleaner code, too. - * - * Revision 1.51 2005/10/31 19:02:12 pdoubleya - * support for inherited padding and margins. - * - * Revision 1.50 2005/10/31 18:01:44 pdoubleya - * InheritedLength is created per-length, to accomodate calls that need to defer to a specific parent. - * - * Revision 1.49 2005/10/31 12:38:14 pdoubleya - * Additional inheritance fixes. - * - * Revision 1.48 2005/10/31 10:16:08 pdoubleya - * Preliminary support for inherited lengths. - * - * Revision 1.47 2005/10/25 15:38:28 pdoubleya - * Moved guessType() to ValueConstants, applied fix to method suggested by Chris Oliver, to avoid exception-based catch. - * - * Revision 1.46 2005/10/25 00:38:47 tobega - * Reduced memory footprint of Matcher and stopped trying to cache the possibly uncache-able CascadedStyles, the fingerprint works just as well or better as a key in CalculatedStyle! - * - * Revision 1.45 2005/10/24 15:37:35 pdoubleya - * Caching border, margin and property instances directly. - * - * Revision 1.44 2005/10/24 10:19:40 pdoubleya - * CSSName FS_ID is now public and final, allowing direct access to the id, bypassing getAssignedID(); micro-optimization :); getAssignedID() and setAssignedID() have been removed. IdentValue string property is also final (as should have been). - * - * Revision 1.43 2005/10/22 22:58:15 peterbrant - * Box level restyle works again (really this time!) - * - * Revision 1.42 2005/10/21 23:51:48 peterbrant - * Rollback ill-advised change in revision 1.40 - * - * Revision 1.41 2005/10/21 23:11:26 pdoubleya - * Store key for margin, border and padding in each style instance, was re-creating on each call. - * - * Revision 1.40 2005/10/21 23:04:02 peterbrant - * Make box level restyle work again - * - * Revision 1.39 2005/10/21 18:49:46 pdoubleya - * Fixed border painting bug. - * - * Revision 1.38 2005/10/21 18:14:59 pdoubleya - * set initial capacity for cached rects. - * - * Revision 1.37 2005/10/21 18:10:50 pdoubleya - * Support for cachable borders. Still buggy on some pages, but getting there. - * - * Revision 1.36 2005/10/21 13:02:20 pdoubleya - * Changed to cache padding in RectPropertySet. - * - * Revision 1.35 2005/10/21 12:20:04 pdoubleya - * Added array for margin side props. - * - * Revision 1.34 2005/10/21 12:16:18 pdoubleya - * Removed use of MarginPropertySet; using RectPS now. - * - * Revision 1.33 2005/10/21 12:01:13 pdoubleya - * Added cachable rect property for margin, cleanup minor in styling. - * - * Revision 1.32 2005/10/21 10:02:54 pdoubleya - * Cleanup, removed unneeded vars, reorg code in CS. - * - * Revision 1.31 2005/10/20 20:48:01 pdoubleya - * Updates for refactoring to style classes. CalculatedStyle now has lookup methods to cover all general cases, so propertyByName() is private, which means the backing classes for styling were able to be replaced. - * - * Revision 1.30 2005/10/03 23:44:43 tobega - * thread-safer css code and improved style caching - * - * Revision 1.29 2005/09/11 20:43:15 tobega - * Fixed table-css interaction bug, colspan now works again - * - * Revision 1.28 2005/07/20 22:47:33 joshy - * fix for 94, percentage for top absolute position - * - * Revision 1.27 2005/06/22 23:48:41 tobega - * Refactored the css package to allow a clean separation from the core. - * - * Revision 1.26 2005/06/21 08:23:13 pdoubleya - * Added specific list and count of primitive, non shorthand properties, and CalculatedStyle now sizes array to this size. - * - * Revision 1.25 2005/06/16 07:24:46 tobega - * Fixed background image bug. - * Caching images in browser. - * Enhanced LinkListener. - * Some house-cleaning, playing with Idea's code inspection utility. - * - * Revision 1.24 2005/06/03 23:06:21 tobega - * Now uses value of "color" as initial value for "border-color" and rgb-triples are supported - * - * Revision 1.23 2005/06/01 00:47:02 tobega - * Partly confused hack trying to get width and height working properly for replaced elements. - * - * Revision 1.22 2005/05/29 16:38:58 tobega - * Handling of ex values should now be working well. Handling of em values improved. Is it correct? - * Also started defining dividing responsibilities between Context and RenderingContext. - * - * Revision 1.21 2005/05/13 11:49:57 tobega - * Started to fix up borders on inlines. Got caught up in refactoring. - * Boxes shouldn't cache borders and stuff unless necessary. Started to remove unnecessary references. - * Hover is not working completely well now, might get better when I'm done. - * - * Revision 1.20 2005/05/09 20:35:38 tobega - * Caching fonts in CalculatedStyle - * - * Revision 1.19 2005/05/08 15:37:28 tobega - * Fixed up style caching so it really works (internalize CascadedStyles and let each CalculatedStyle keep track of its derived children) - * - * Revision 1.18 2005/05/08 14:51:21 tobega - * Removed the need for the Styler - * - * Revision 1.17 2005/05/08 14:36:54 tobega - * Refactored away the need for having a context in a CalculatedStyle - * - * Revision 1.16 2005/04/07 16:33:34 pdoubleya - * Fix border width if set to "none" in CSS (Kevin). - * - * Revision 1.15 2005/03/24 23:16:33 pdoubleya - * Added use of SharedContext (Kevin). - * - * Revision 1.14 2005/02/03 23:15:50 pdoubleya - * . - * - * Revision 1.13 2005/01/29 20:22:20 pdoubleya - * Clean/reformat code. Removed commented blocks, checked copyright. - * - * Revision 1.12 2005/01/25 12:46:12 pdoubleya - * Refactored duplicate code into separate method. - * - * Revision 1.11 2005/01/24 22:46:43 pdoubleya - * Added support for ident-checks using IdentValue instead of string comparisons. - * - * Revision 1.10 2005/01/24 19:01:05 pdoubleya - * Mass checkin. Changed to use references to CSSName, which now has a Singleton instance for each property, everywhere property names were being used before. Removed commented code. Cascaded and Calculated style now store properties in arrays rather than maps, for optimization. - * - * Revision 1.9 2005/01/24 14:36:31 pdoubleya - * Mass commit, includes: updated for changes to property declaration instantiation, and new use of DerivedValue. Removed any references to older XR... classes (e.g. XRProperty). Cleaned imports. - * - * Revision 1.8 2004/12/05 18:11:36 tobega - * Now uses style cache for pseudo-element styles. Also started preparing to replace inline node handling with inline content handling. - * - * Revision 1.7 2004/12/05 00:48:54 tobega - * Cleaned up so that now all property-lookups use the CalculatedStyle. Also added support for relative values of top, left, width, etc. - * - * Revision 1.6 2004/11/15 12:42:23 pdoubleya - * Across this checkin (all may not apply to this particular file) - * Changed default/package-access members to private. - * Changed to use XRRuntimeException where appropriate. - * Began move from System.err.println to std logging. - * Standard code reformat. - * Removed some unnecessary SAC member variables that were only used in initialization. - * CVS log section. - * - * - */ - diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index 484d85b05..00968a497 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -65,6 +65,7 @@ import com.openhtmltopdf.render.FlowingColumnContainerBox; import com.openhtmltopdf.render.FootnoteData; import com.openhtmltopdf.render.InlineBox; +import com.openhtmltopdf.util.OpenUtil; /** * This class is responsible for creating the box tree from the DOM. This is @@ -95,10 +96,10 @@ private static void splitParagraphs(LayoutContext c, Document document) { c.getParagraphSplitter().splitRoot(c, document); c.getParagraphSplitter().runBidiOnParagraphs(c); } - + public static BlockBox createRootBox(LayoutContext c, Document document) { splitParagraphs(c, document); - + Element root = document.getDocumentElement(); CalculatedStyle style = c.getSharedContext().getStyle(root); @@ -120,6 +121,8 @@ public static BlockBox createRootBox(LayoutContext c, Document document) { public static void createChildren(LayoutContext c, BlockBox parent) { if (parent.shouldBeReplaced()) { + // Don't create boxes for elements in a SVG element. + // This avoids many warnings and improves performance. parent.setChildrenContentType(BlockBox.CONTENT_EMPTY); return; } @@ -132,7 +135,7 @@ public static void createChildren(LayoutContext c, BlockBox parent) { boolean parentIsNestingTableContent = isNestingTableContent(parent.getStyle().getIdent( CSSName.DISPLAY)); - + if (!parentIsNestingTableContent && !info.isContainsTableContent()) { resolveChildren(c, parent, children, info); } else { @@ -780,7 +783,7 @@ private static CounterFunction makeCounterFunction(FSFunction function, LayoutCo } private static String getAttributeValue(FSFunction attrFunc, Element e) { - PropertyValue value = (PropertyValue) attrFunc.getParameters().get(0); + PropertyValue value = attrFunc.getParameters().get(0); return e.getAttribute(value.getStringValue()); } @@ -891,11 +894,10 @@ private static List createGeneratedContentList( public static BlockBox getRunningBlock(LayoutContext c, PropertyValue value) { List params = value.getFunction().getParameters(); - String ident = ((PropertyValue)params.get(0)).getStringValue(); + String ident = params.get(0).getStringValue(); PageElementPosition position = null; if (params.size() == 2) { - position = PageElementPosition.valueOf( - ((PropertyValue)params.get(1)).getStringValue()); + position = PageElementPosition.valueOf(params.get(1).getStringValue()); } if (position == null) { position = PageElementPosition.FIRST; @@ -907,13 +909,16 @@ public static BlockBox getRunningBlock(LayoutContext c, PropertyValue value) { private static void insertGeneratedContent( LayoutContext c, Element element, CalculatedStyle parentStyle, String peName, List children, ChildBoxInfo info) { + CascadedStyle peStyle = c.getCss().getPseudoElementStyle(element, peName); + if (peStyle != null) { PropertyDeclaration contentDecl = peStyle.propertyByName(CSSName.CONTENT); PropertyDeclaration counterResetDecl = peStyle.propertyByName(CSSName.COUNTER_RESET); PropertyDeclaration counterIncrDecl = peStyle.propertyByName(CSSName.COUNTER_INCREMENT); CalculatedStyle calculatedStyle = null; + if (contentDecl != null || counterResetDecl != null || counterIncrDecl != null) { calculatedStyle = parentStyle.deriveStyle(peStyle); if (calculatedStyle.isDisplayNone()) return; @@ -1125,152 +1130,226 @@ private static InlineBox createInlineBox( return result; } + private static class CreateChildrenContext { + CreateChildrenContext( + boolean needStartText, boolean needEndText, + CalculatedStyle parentStyle, boolean inline) { + this.needStartText = needStartText; + this.needEndText = needEndText; + this.parentStyle = parentStyle; + this.inline = inline; + } + + boolean needStartText; + boolean needEndText; + boolean inline; + + InlineBox previousIB = null; + final CalculatedStyle parentStyle; + } + + private static void createElementChild( + LayoutContext c, + Element parent, + BlockBox blockParent, + Node working, + List children, + ChildBoxInfo info, + CreateChildrenContext context) { + + Styleable child = null; + SharedContext sharedContext = c.getSharedContext(); + Element element = (Element) working; + CalculatedStyle style = sharedContext.getStyle(element); + + if (style.isDisplayNone()) { + return; + } + + resolveElementCounters(c, working, element, style); + + if (style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN) || + style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN_GROUP)) { + + if ((blockParent != null) && + (blockParent.getStyle().isTable() || blockParent.getStyle().isInlineTable())) { + TableBox table = (TableBox) blockParent; + addColumnOrColumnGroup(c, table, element, style); + } + + return; + } + + if (style.isFootnote()) { + List footnoteChildren = new ArrayList<>(); + ChildBoxInfo footnoteChildInfo = new ChildBoxInfo(); + + // Create the out-of-flow footnote-body box as a block box. + BlockBox footnoteBody = new BlockBox(); + footnoteBody.setElement(element); + footnoteBody.setFootnoteData(new FootnoteData()); + footnoteBody.setStyle(style.createAnonymousStyle(IdentValue.FS_FOOTNOTE_BODY)); + + // The footnote marker followed by footnote element children. + insertGeneratedContent(c, element, style, "footnote-marker", footnoteChildren, footnoteChildInfo); + createChildren(c, footnoteBody, element, footnoteChildren, footnoteChildInfo, style.isInline()); + + // This is purely a marker box for the footnote so we + // can figure out in layout when to add the footnote body. + InlineBox iB = createInlineBox("", parent, context.parentStyle, null); + iB.setStartsHere(true); + iB.setEndsHere(true); + iB.setFootnote(footnoteBody); + children.add(iB); + context.previousIB = iB; + + // This is the official marker content that can generate zero or more boxes + // depending on user for ::footnote-call pseudo element. + insertGeneratedContent(c, element, style, "footnote-call", children, info); + + } else if (style.isInline()) { + + if (context.needStartText) { + context.needStartText = false; + InlineBox iB = createInlineBox("", parent, context.parentStyle, null); + iB.setStartsHere(true); + iB.setEndsHere(false); + children.add(iB); + context.previousIB = iB; + } + + createChildren(c, null, element, children, info, true); + + if (context.inline) { + if (context.previousIB != null) { + context.previousIB.setEndsHere(false); + } + context.needEndText = true; + } + } else { + if (style.hasColumns() && c.isPrint()) { + child = new FlowingColumnContainerBox(); + } else { + child = createBlockBox(style, info, false); + } + + child.setStyle(style); + child.setElement(element); + + if (style.hasColumns() && c.isPrint()) { + createColumnContainer(c, child, element, style); + } + + if (style.isListItem()) { + BlockBox block = (BlockBox) child; + block.setListCounter(c.getCounterContext(style).getCurrentCounterValue("list-item")); + } + + if (style.isTable() || style.isInlineTable()) { + TableBox table = (TableBox) child; + table.ensureChildren(c); + + child = reorderTableContent(c, table); + } + + if (!info.isContainsBlockLevelContent() + && !style.isLayedOutInInlineContext()) { + info.setContainsBlockLevelContent(true); + } + + BlockBox block = (BlockBox) child; + + if (block.getStyle().mayHaveFirstLine()) { + block.setFirstLineStyle(c.getCss().getPseudoElementStyle(element, + "first-line")); + } + if (block.getStyle().mayHaveFirstLetter()) { + block.setFirstLetterStyle(c.getCss().getPseudoElementStyle(element, + "first-letter")); + } + + // I think we need to do this to evaluate counters correctly + block.ensureChildren(c); + } + + if (child != null) { + children.add(child); + } + } + + private static void createColumnContainer( + LayoutContext c, Styleable child, Element element, CalculatedStyle style) { + + FlowingColumnContainerBox cont = (FlowingColumnContainerBox) child; + cont.setOnlyChild(c, new FlowingColumnBox(cont)); + cont.getChild().setStyle(style.createAnonymousStyle(IdentValue.BLOCK)); + cont.getChild().setElement(element); + cont.getChild().ensureChildren(c); + } + + private static void resolveElementCounters( + LayoutContext c, Node working, Element element, CalculatedStyle style) { + + Integer attrValue = null; + + if ("ol".equals(working.getNodeName()) && element.hasAttribute("start")) { + attrValue = OpenUtil.parseIntegerOrNull(element.getAttribute("start")); + } else if ("li".equals(working.getNodeName()) && element.hasAttribute("value")) { + attrValue = OpenUtil.parseIntegerOrNull(element.getAttribute("value")); + } + + if (attrValue != null) { + c.resolveCounters(style, attrValue - 1); + } else { + c.resolveCounters(style, null); + } + } + private static void createChildren( LayoutContext c, BlockBox blockParent, Element parent, List children, ChildBoxInfo info, boolean inline) { - SharedContext sharedContext = c.getSharedContext(); + SharedContext sharedContext = c.getSharedContext(); CalculatedStyle parentStyle = sharedContext.getStyle(parent); insertGeneratedContent(c, parent, parentStyle, "before", children, info); Node working = parent.getFirstChild(); - boolean needStartText = inline; - boolean needEndText = inline; + CreateChildrenContext context = null; + if (working != null) { - InlineBox previousIB = null; + context = new CreateChildrenContext(inline, inline, parentStyle, inline); + do { - Styleable child = null; short nodeType = working.getNodeType(); - if (nodeType == Node.ELEMENT_NODE) { - Element element = (Element) working; - CalculatedStyle style = sharedContext.getStyle(element); - if (style.isDisplayNone()) { - continue; - } - - Integer start = null; - if ("ol".equals(working.getNodeName())) { - Node startAttribute = working.getAttributes().getNamedItem("start"); - if (startAttribute != null) { - try { - start = Integer.valueOf(Integer.parseInt(startAttribute.getNodeValue()) - 1); - } catch (NumberFormatException e) { - // ignore - } - } - } else if ("li".equals(working.getNodeName())) { - Node valueAttribute = working.getAttributes().getNamedItem("value"); - if (valueAttribute != null) { - try { - start = Integer.valueOf(Integer.parseInt(valueAttribute.getNodeValue()) - 1); - } catch (NumberFormatException e) { - // ignore - } - } - } - - c.resolveCounters(style, start); - - if (style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN) - || style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN_GROUP)) { - if ((blockParent != null) && - (blockParent.getStyle().isTable() || blockParent.getStyle().isInlineTable())) { - TableBox table = (TableBox) blockParent; - addColumnOrColumnGroup(c, table, element, style); - } - - continue; - } - - if (style.isInline()) { - if (needStartText) { - needStartText = false; - InlineBox iB = createInlineBox("", parent, parentStyle, null); - iB.setStartsHere(true); - iB.setEndsHere(false); - children.add(iB); - previousIB = iB; - } - createChildren(c, null, element, children, info, true); - if (inline) { - if (previousIB != null) { - previousIB.setEndsHere(false); - } - needEndText = true; - } - } else { - if (style.hasColumns() && c.isPrint()) { - child = new FlowingColumnContainerBox(); - } else { - child = createBlockBox(style, info, false); - } - - child.setStyle(style); - child.setElement(element); - - if (style.hasColumns() && c.isPrint()) { - FlowingColumnContainerBox cont = (FlowingColumnContainerBox) child; - cont.setOnlyChild(c, new FlowingColumnBox(cont)); - cont.getChild().setStyle(style.createAnonymousStyle(IdentValue.BLOCK)); - cont.getChild().setElement(element); - cont.getChild().ensureChildren(c); - } - - if (style.isListItem()) { - BlockBox block = (BlockBox) child; - block.setListCounter(c.getCounterContext(style).getCurrentCounterValue("list-item")); - } - - if (style.isTable() || style.isInlineTable()) { - TableBox table = (TableBox) child; - table.ensureChildren(c); - - child = reorderTableContent(c, table); - } - - if (!info.isContainsBlockLevelContent() - && !style.isLayedOutInInlineContext()) { - info.setContainsBlockLevelContent(true); - } - - BlockBox block = (BlockBox) child; - if (block.getStyle().mayHaveFirstLine()) { - block.setFirstLineStyle(c.getCss().getPseudoElementStyle(element, - "first-line")); - } - if (block.getStyle().mayHaveFirstLetter()) { - block.setFirstLetterStyle(c.getCss().getPseudoElementStyle(element, - "first-letter")); - } - //I think we need to do this to evaluate counters correctly - block.ensureChildren(c); - } + if (nodeType == Node.ELEMENT_NODE) { + createElementChild( + c, parent, blockParent, working, children, info, context); } else if (nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE) { - needStartText = false; - needEndText = false; + context.needStartText = false; + context.needEndText = false; Text textNode = (Text) working; // Ignore the text belonging to a textarea. if (!textNode.getParentNode().getNodeName().equals("textarea")) { - previousIB = doBidi(c, textNode, parent, parentStyle, previousIB, children); + context.previousIB = doBidi(c, textNode, parent, parentStyle, context.previousIB, children); } - child = null; - } - - if (child != null) { - children.add(child); } } while ((working = working.getNextSibling()) != null); } + + boolean needStartText = context != null ? context.needStartText : inline; + boolean needEndText = context != null ? context.needEndText : inline; + if (needStartText || needEndText) { InlineBox iB = createInlineBox("", parent, parentStyle, null); iB.setStartsHere(needStartText); iB.setEndsHere(needEndText); children.add(iB); } + insertGeneratedContent(c, parent, parentStyle, "after", children, info); } @@ -1441,10 +1520,6 @@ private static void insertAnonymousBlocks( createAnonymousBlock(c, parent, inline, savedParents); } - private static void createAnonymousInlineBlock(SharedContext c, Box parent, List inline, List savedParents) { - createAnonymousBlock(c, parent, inline, savedParents, IdentValue.INLINE_BLOCK); - } - private static void createAnonymousBlock(SharedContext c, Box parent, List inline, List savedParents) { createAnonymousBlock(c, parent, inline, savedParents, IdentValue.BLOCK); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java index 1846fe515..fa927b92c 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java @@ -112,6 +112,8 @@ public class BlockBox extends Box implements InlinePaintable { private boolean _isReplaced; + private FootnoteData _footnoteData; + public BlockBox() { super(); } @@ -2402,7 +2404,11 @@ public boolean hasMargin() { } public void setFootnoteData(FootnoteData footnoteData) { - // TODO Auto-generated method stub + this._footnoteData = footnoteData; + } + + public boolean isFootnoteBody() { + return _footnoteData != null; } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineBox.java index d375c57e3..b55554516 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineBox.java @@ -85,6 +85,8 @@ public InlineBox(String text) { } private byte _textDirection; + + private BlockBox _footnoteBody; /** * @param direction either LTR or RTL from {@link BidiSplitter} interface. @@ -525,4 +527,16 @@ public void truncateText() { _text = ""; _originalText = ""; } + + public void setFootnote(BlockBox footnoteBody) { + _footnoteBody = footnoteBody; + } + + public boolean hasFootnote() { + return getFootnoteBody() != null; + } + + public BlockBox getFootnoteBody() { + return _footnoteBody; + } } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html index fdc808ac1..24b4bb4e1 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html @@ -13,6 +13,7 @@ } } +::footnote-call { counter-increment: footnote; } span.footnote { float: footnote; } .footnote::footnote-call { content: counter(footnote) " "; } .footnote::footnote-marker { content: counter(footnote) ". "; } @@ -20,7 +21,8 @@

- This text needs some footnotes.This is a footnote. + This text needs some footnotes. This is a footnote. + Also a footnote for this sentence. Another footnote!

From 630842f789f9f19e2cef532b8e74c0f810b2cb7e Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 25 May 2021 20:45:17 +1000 Subject: [PATCH 04/54] #364 counter-increment support for footnotes. Still struggling with correct counter-reset behavior. --- .../openhtmltopdf/css/parser/CounterData.java | 9 +- .../css/style/CalculatedStyle.java | 9 +- .../com/openhtmltopdf/layout/BoxBuilder.java | 22 +- .../openhtmltopdf/layout/LayoutContext.java | 138 +----- .../openhtmltopdf/layout/SharedContext.java | 415 +----------------- .../counter/AbstractCounterContext.java | 11 + .../layout/counter/CounterContext.java | 136 ++++++ .../layout/counter/RootCounterContext.java | 46 ++ .../html/issue-364-footnotes-basic.html | 31 +- 9 files changed, 267 insertions(+), 550 deletions(-) create mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/AbstractCounterContext.java create mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/CounterContext.java create mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/RootCounterContext.java diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CounterData.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CounterData.java index c3379be65..c2c6e7445 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CounterData.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CounterData.java @@ -22,12 +22,12 @@ public class CounterData { private final String _name; private final int _value; - + public CounterData(String name, int value) { _name = name; _value = value; } - + public String getName() { return _name; } @@ -35,4 +35,9 @@ public String getName() { public int getValue() { return _value; } + + @Override + public String toString() { + return String.format("CounterData [_name=%s, _value=%s]", _name, _value); + } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java index 094f9b26c..10ec71ee4 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java @@ -50,12 +50,14 @@ import com.openhtmltopdf.css.style.derived.NumberValue; import com.openhtmltopdf.css.style.derived.RectPropertySet; import com.openhtmltopdf.css.value.FontSpecification; +import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.newtable.TableBox; import com.openhtmltopdf.render.Box; import com.openhtmltopdf.render.FSFont; import com.openhtmltopdf.render.FSFontMetrics; import com.openhtmltopdf.render.RenderingContext; import com.openhtmltopdf.util.LogMessageId; +import com.openhtmltopdf.util.ThreadCtx; import com.openhtmltopdf.util.WebDoc; import com.openhtmltopdf.util.WebDocLocations; import com.openhtmltopdf.util.XRLog; @@ -191,7 +193,7 @@ private void checkBordersAllowed() { * @param matched the CascadedStyle to apply * @return The derived child style */ - public synchronized CalculatedStyle deriveStyle(CascadedStyle matched) { + public CalculatedStyle deriveStyle(CascadedStyle matched) { String fingerprint = matched.getFingerprint(); CalculatedStyle cs = _childCache.get(fingerprint); @@ -199,6 +201,11 @@ public synchronized CalculatedStyle deriveStyle(CascadedStyle matched) { cs = new CalculatedStyle(this, matched); _childCache.put(fingerprint, cs); } + + RootCounterContext cc = ThreadCtx.get().sharedContext().getGlobalCounterContext(); + cc.resetCounterValue(cs); + cc.incrementCounterValue(cs); + return cs; } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index 00968a497..fb32919d7 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -52,6 +52,9 @@ import com.openhtmltopdf.css.style.CalculatedStyle; import com.openhtmltopdf.css.style.EmptyStyle; import com.openhtmltopdf.css.style.FSDerivedValue; +import com.openhtmltopdf.layout.counter.AbstractCounterContext; +import com.openhtmltopdf.layout.counter.CounterContext; +import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.newtable.TableBox; import com.openhtmltopdf.newtable.TableCellBox; import com.openhtmltopdf.newtable.TableColumn; @@ -704,7 +707,9 @@ public static boolean isElementFunction(FSFunction function) { return false; } - private static CounterFunction makeCounterFunction(FSFunction function, LayoutContext c, CalculatedStyle style) { + private static CounterFunction makeCounterFunction( + FSFunction function, LayoutContext c, CalculatedStyle style) { + if (function.getName().equals("counter")) { List params = function.getParameters(); if (params.size() < 1 || params.size() > 2) { @@ -737,7 +742,19 @@ private static CounterFunction makeCounterFunction(FSFunction function, LayoutCo } } - int counterValue = c.getCounterContext(style).getCurrentCounterValue(counter); + if ("footnote".equals(s)) { + RootCounterContext rootCc = c.getSharedContext().getGlobalCounterContext(); + + //rootCc.resetCounterValue(style); + //rootCc.incrementCounterValue(style); + + int counterValue = rootCc.getCurrentCounterValue(s); + return new CounterFunction(counterValue, listStyleType); + } + + AbstractCounterContext cc = c.getCounterContext(style); + + int counterValue = cc.getCurrentCounterValue(counter); return new CounterFunction(counterValue, listStyleType); } else if (function.getName().equals("counters")) { @@ -935,6 +952,7 @@ private static void insertGeneratedContent( }); calculatedStyle = parentStyle.deriveStyle(newPeStyle); } + c.resolveCounters(calculatedStyle); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java index 990f1c107..863201737 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java @@ -20,10 +20,8 @@ package com.openhtmltopdf.layout; import java.awt.Rectangle; -import java.util.ArrayList; import java.util.HashMap; import java.util.LinkedList; -import java.util.List; import java.util.Map; import com.openhtmltopdf.bidi.BidiReorderer; @@ -34,9 +32,6 @@ import com.openhtmltopdf.bidi.SimpleBidiSplitterFactory; import com.openhtmltopdf.context.ContentFunctionFactory; import com.openhtmltopdf.context.StyleReference; -import com.openhtmltopdf.css.constants.CSSName; -import com.openhtmltopdf.css.constants.IdentValue; -import com.openhtmltopdf.css.parser.CounterData; import com.openhtmltopdf.css.style.CalculatedStyle; import com.openhtmltopdf.css.style.CssContext; import com.openhtmltopdf.css.value.FontSpecification; @@ -46,6 +41,9 @@ import com.openhtmltopdf.extend.ReplacedElementFactory; import com.openhtmltopdf.extend.TextRenderer; import com.openhtmltopdf.extend.UserAgentCallback; +import com.openhtmltopdf.layout.counter.AbstractCounterContext; +import com.openhtmltopdf.layout.counter.CounterContext; +import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.render.Box; import com.openhtmltopdf.render.FSFont; import com.openhtmltopdf.render.FSFontMetrics; @@ -77,7 +75,7 @@ public class LayoutContext implements CssContext { private int _extraSpaceTop; private int _extraSpaceBottom; - private final Map _counterContextMap = new HashMap<>(); + public final Map _counterContextMap = new HashMap<>(); private String _pendingPageName; private String _pageName; @@ -413,7 +411,7 @@ public void setExtraSpaceTop(int extraSpaceTop) { public void resolveCounters(CalculatedStyle style, Integer startIndex) { //new context for child elements - CounterContext cc = new CounterContext(style, startIndex); + CounterContext cc = new CounterContext(this, style, startIndex); _counterContextMap.put(style, cc); } @@ -421,7 +419,7 @@ public void resolveCounters(CalculatedStyle style) { resolveCounters(style, null); } - public CounterContext getCounterContext(CalculatedStyle style) { + public AbstractCounterContext getCounterContext(CalculatedStyle style) { return _counterContextMap.get(style); } @@ -429,130 +427,6 @@ public FSFontMetrics getFSFontMetrics(FSFont font) { return getTextRenderer().getFSFontMetrics(getFontContext(), font, ""); } - public class CounterContext { - private Map _counters = new HashMap<>(); - /** - * This is different because it needs to work even when the counter- properties cascade - * and it should also logically be redefined on each level (think list-items within list-items) - */ - private CounterContext _parent; - - /** - * A CounterContext should really be reflected in the element hierarchy, but CalculatedStyles - * reflect the ancestor hierarchy just as well and also handles pseudo-elements seamlessly. - * - * @param style - */ - CounterContext(CalculatedStyle style, Integer startIndex) { - // Numbering restarted via
    - if (startIndex != null) { - _counters.put("list-item", startIndex); - } - _parent = _counterContextMap.get(style.getParent()); - if (_parent == null) _parent = new CounterContext();//top-level context, above root element - //first the explicitly named counters - List resets = style.getCounterReset(); - if (resets != null) { - resets.forEach(_parent::resetCounter); - } - - List increments = style.getCounterIncrement(); - if (increments != null) { - for (CounterData cd : increments) { - if (!_parent.incrementCounter(cd)) { - _parent.resetCounter(new CounterData(cd.getName(), 0)); - _parent.incrementCounter(cd); - } - } - } - - // then the implicit list-item counter - if (style.isIdent(CSSName.DISPLAY, IdentValue.LIST_ITEM)) { - // Numbering restarted via
  1. - if (startIndex != null) { - _parent._counters.put("list-item", startIndex); - } - _parent.incrementListItemCounter(1); - } - } - - private CounterContext() { - - } - - /** - * @param cd - * @return true if a counter was found and incremented - */ - private boolean incrementCounter(CounterData cd) { - // list-item is a reserved name for list-item counter in CSS3 - if ("list-item".equals(cd.getName())) { - incrementListItemCounter(cd.getValue()); - return true; - } else { - Integer currentValue = _counters.get(cd.getName()); - if (currentValue == null) { - if (_parent == null) { - return false; - } - return _parent.incrementCounter(cd); - } else { - _counters.put(cd.getName(), currentValue + cd.getValue()); - return true; - } - } - } - - private void incrementListItemCounter(int increment) { - Integer currentValue = _counters.get("list-item"); - if (currentValue == null) { - currentValue = 0; - } - _counters.put("list-item", currentValue + increment); - } - - private void resetCounter(CounterData cd) { - _counters.put(cd.getName(), cd.getValue()); - } - - public int getCurrentCounterValue(String name) { - //only the counters of the parent are in scope - //_parent is never null for a publicly accessible CounterContext - Integer value = _parent.getCounter(name); - if (value == null) { - _parent.resetCounter(new CounterData(name, 0)); - return 0; - } else { - return value.intValue(); - } - } - - private Integer getCounter(String name) { - Integer value = _counters.get(name); - if (value != null) return value; - if (_parent == null) return null; - return _parent.getCounter(name); - } - - public List getCurrentCounterValues(String name) { - //only the counters of the parent are in scope - //_parent is never null for a publicly accessible CounterContext - List values = new ArrayList<>(); - _parent.getCounterValues(name, values); - if (values.size() == 0) { - _parent.resetCounter(new CounterData(name, 0)); - values.add(Integer.valueOf(0)); - } - return values; - } - - private void getCounterValues(String name, List values) { - if (_parent != null) _parent.getCounterValues(name, values); - Integer value = _counters.get(name); - if (value != null) values.add(value); - } - } - public String getPageName() { return _pageName; } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java index f1c9e97cb..5da3ab2f8 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java @@ -24,6 +24,7 @@ import com.openhtmltopdf.css.style.EmptyStyle; import com.openhtmltopdf.css.value.FontSpecification; import com.openhtmltopdf.extend.*; +import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.render.Box; import com.openhtmltopdf.render.FSFont; import com.openhtmltopdf.render.FSFontMetrics; @@ -125,7 +126,9 @@ public class SharedContext { public String _preferredTransformerFactoryImplementationClass = null; public String _preferredDocumentBuilderFactoryImplementationClass = null; - + + private final RootCounterContext _rootCounterContext = new RootCounterContext(); + public SharedContext() { } @@ -610,410 +613,8 @@ public void setUnicodeToUpperTransformer(FSTextTransformer tr) { public void setUnicodeToTitleTransformer(FSTextTransformer tr) { this._unicodeToTitleTransformer = tr; } -} -/* - * - * $Log$ - * Revision 1.46 2009/05/08 12:22:30 pdoubleya - * Merge Vianney's SWT branch to trunk. Passes regress.verify and browser still works :). - * - * Revision 1.42 2008/01/22 00:29:24 peterbrant - * Need to propagate changes to user agent in SharedContext to containing StyleReference - * - * Revision 1.41 2007/08/19 22:22:52 peterbrant - * Merge R8pbrant changes to HEAD - * - * Revision 1.39.2.2 2007/08/07 17:06:30 peterbrant - * Implement named pages / Implement page-break-before/after: left/right / Experiment with efficient selection - * - * Revision 1.39.2.1 2007/07/04 14:12:33 peterbrant - * Permit a custom user agent with rendering to PDF - * - * Revision 1.39 2007/05/26 19:04:13 peterbrant - * Implement support for removing all references to a particular Element (in order to support limited dynamic DOM changes) - * - * Revision 1.38 2007/04/16 20:56:49 pdoubleya - * New image rendering based on PDF rendering approach. Hacked small change in SharedContext which is dependent on panel for sizing, currently. - * - * Revision 1.37 2007/04/02 17:08:36 peterbrant - * Improve method name - * - * Revision 1.36 2007/04/02 16:56:20 peterbrant - * Maintain ReplacedElementFactory across layout runs (to allow component caching to work) / Add reset() to ReplacedElementFactory to allow implementations to clean up after navigating away from a page - * - * Revision 1.35 2007/03/17 22:55:51 peterbrant - * Remove distinction between box IDs and named anchors - * - * Revision 1.34 2007/02/22 15:30:43 peterbrant - * Internal links should be able to target block boxes too (plus other minor cleanup) - * - * Revision 1.33 2007/02/20 17:07:13 peterbrant - * Clean up ex calculation - * - * Revision 1.32 2007/02/07 16:33:35 peterbrant - * Initial commit of rewritten table support and associated refactorings - * - * Revision 1.31 2006/08/29 17:29:10 peterbrant - * Make Style object a thing of the past - * - * Revision 1.30 2006/08/27 00:35:38 peterbrant - * Initial commit of (initial) R7 work - * - * Revision 1.29 2006/03/01 00:42:52 peterbrant - * Provide ability to remove named anchors - * - * Revision 1.28 2006/02/28 01:31:36 peterbrant - * Add ability to define PDF bookmarks in header - * - * Revision 1.27 2006/02/02 19:25:20 peterbrant - * Fix (silly) field name mistake - * - * Revision 1.26 2006/02/02 13:04:34 peterbrant - * Make "dots" the fundamental unit of measure, pixels are now some number of dots - * - * Revision 1.25 2006/02/01 01:30:12 peterbrant - * Initial commit of PDF work - * - * Revision 1.24 2006/01/27 01:15:30 peterbrant - * Start on better support for different output devices - * - * Revision 1.23 2006/01/01 02:38:15 peterbrant - * Merge more pagination work / Various minor cleanups - * - * Revision 1.22 2005/12/28 00:50:49 peterbrant - * Continue ripping out first try at pagination / Minor method name refactoring - * - * Revision 1.21 2005/12/21 02:36:26 peterbrant - * - Calculate absolute positions incrementally (prep work for pagination) - * - Light cleanup - * - Fix bug where floats nested in floats could cause the outer float to be positioned in the wrong place - * - * Revision 1.20 2005/12/07 20:34:46 peterbrant - * Remove unused fields/methods from RenderingContext / Paint line content using absolute coords (preparation for relative inline layers) - * - * Revision 1.19 2005/11/08 01:53:49 tobega - * Corrected x-height and line-through by taking StrikethroughThickness into account. - * - * Revision 1.18 2005/10/27 00:09:01 tobega - * Sorted out Context into RenderingContext and LayoutContext - * - * Revision 1.17 2005/09/29 21:34:03 joshy - * minor updates to a lot of files. pulling in more incremental rendering code. - * fixed another resize bug - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.16 2005/09/27 23:48:39 joshy - * first merge of basicpanel reworking and incremental layout. more to come. - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.15 2005/07/18 17:53:32 joshy - * fixed anchor jumping - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.14 2005/07/02 07:26:59 joshy - * better support for jumping to anchor tags - * also some testing for the resize issue - * need to investigate making the history remember document position. - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.13 2005/06/22 23:48:45 tobega - * Refactored the css package to allow a clean separation from the core. - * - * Revision 1.12 2005/06/16 07:24:51 tobega - * Fixed background image bug. - * Caching images in browser. - * Enhanced LinkListener. - * Some house-cleaning, playing with Idea's code inspection utility. - * - * Revision 1.11 2005/05/08 14:36:57 tobega - * Refactored away the need for having a context in a CalculatedStyle - * - * Revision 1.10 2005/03/24 23:12:56 pdoubleya - * EmptyStyle now takes SC in constructor. - * - * Revision 1.9 2005/01/29 20:19:24 pdoubleya - * Clean/reformat code. Removed commented blocks, checked copyright. - * - * Revision 1.8 2005/01/13 00:48:46 tobega - * Added preparation of values for a form submission - * - * Revision 1.7 2005/01/08 11:55:17 tobega - * Started massaging the extension interfaces - * - * Revision 1.6 2005/01/05 17:56:35 tobega - * Reduced memory more, especially by using WeakHashMap for caching Mappers. Look over other caching to use similar schemes (cache when memory available). - * - * Revision 1.5 2005/01/05 01:10:15 tobega - * Went wild with code analysis tool. removed unused stuff. Lucky we have CVS... - * - * Revision 1.4 2005/01/02 12:22:19 tobega - * Cleaned out old layout code - * - * Revision 1.3 2005/01/02 01:00:09 tobega - * Started sketching in code for handling replaced elements in the NamespaceHandler - * - * Revision 1.2 2005/01/01 08:09:20 tobega - * Now using entirely static methods for render. Need to implement table. Need to clean. - * - * Revision 1.1 2004/12/29 10:39:33 tobega - * Separated current state Context into LayoutContext and the rest into SharedContext. - * - * Revision 1.40 2004/12/29 07:35:38 tobega - * Prepared for cloned Context instances by encapsulating fields - * - * Revision 1.39 2004/12/28 01:48:23 tobega - * More cleaning. Magically, the financial report demo is starting to look reasonable, without any effort being put on it. - * - * Revision 1.38 2004/12/27 09:40:47 tobega - * Moved more styling to render stage. Now inlines have backgrounds and borders again. - * - * Revision 1.37 2004/12/27 07:43:31 tobega - * Cleaned out border from box, it can be gotten from current style. Is it maybe needed for dynamic stuff? - * - * Revision 1.36 2004/12/16 17:22:25 joshy - * minor code cleanup - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.35 2004/12/16 17:10:41 joshy - * fixed box bug - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.34 2004/12/14 02:28:48 joshy - * removed some comments - * some bugs with the backgrounds still - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.33 2004/12/14 01:56:23 joshy - * fixed layout width bugs - * fixed extra border on document bug - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.32 2004/12/13 15:15:57 joshy - * fixed bug where inlines would pick up parent styles when they aren't supposed to - * fixed extra Xx's in printed text - * added conf boolean to turn on box outlines - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.31 2004/12/12 03:32:58 tobega - * Renamed x and u to avoid confusing IDE. But that got cvs in a twist. See if this does it - * - * Revision 1.30 2004/12/11 23:36:48 tobega - * Progressing on cleaning up layout and boxes. Still broken, won't even compile at the moment. Working hard to fix it, though. - * - * Revision 1.29 2004/12/11 18:18:10 tobega - * Still broken, won't even compile at the moment. Working hard to fix it, though. Replace the StyleReference interface with our only concrete implementation, it was a bother changing in two places all the time. - * - * Revision 1.28 2004/12/10 06:51:02 tobega - * Shamefully, I must now check in painfully broken code. Good news is that Layout is much nicer, and we also handle :before and :after, and do :first-line better than before. Table stuff must be brought into line, but most needed is to fix Render. IMO Render should work with Boxes and Content. If Render goes for a node, that is wrong. - * - * Revision 1.27 2004/12/05 05:22:35 joshy - * fixed NPEs in selection listener - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.26 2004/12/02 15:50:58 joshy - * added debugging - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.25 2004/12/01 14:02:52 joshy - * modified media to use the value from the rendering context - * added the inline-block box - * - j - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.24 2004/11/30 20:28:27 joshy - * support for multiple floats on a single line. - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.23 2004/11/28 23:29:02 tobega - * Now handles media on Stylesheets, still need to handle at-media-rules. The media-type should be set in Context.media (set by default to "screen") before calling setContext on StyleReference. - * - * Revision 1.22 2004/11/18 14:12:44 joshy - * added whitespace test - * cleaned up some code, spacing, and comments - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.21 2004/11/18 02:58:06 joshy - * collapsed the font resolver and font resolver test into one class, and removed - * the other - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.20 2004/11/17 14:58:18 joshy - * added actions for font resizing - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.19 2004/11/16 07:25:12 tobega - * Renamed HTMLPanel to BasicPanel - * - * Revision 1.18 2004/11/14 21:33:47 joshy - * new font rendering interface support - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.17 2004/11/14 16:40:58 joshy - * refactored layout factory - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.16 2004/11/14 06:26:39 joshy - * added better detection for width problems. should avoid most - * crashes - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.15 2004/11/12 22:02:00 joshy - * initial support for mouse copy selection - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.14 2004/11/12 17:05:24 joshy - * support for fixed positioning - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.13 2004/11/12 02:54:38 joshy - * removed more dead code - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.11 2004/11/12 02:47:33 joshy - * moved baseurl to rendering context - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.9 2004/11/10 17:28:54 joshy - * initial support for anti-aliased text w/ minium - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.8 2004/11/09 00:36:08 joshy - * fixed more text alignment - * added menu item to show font metrics - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.7 2004/11/08 16:56:51 joshy - * added first-line pseudo-class support - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.6 2004/11/03 23:54:33 joshy - * added hamlet and tables to the browser - * more support for absolute layout - * added absolute layout unit tests - * removed more dead code and moved code into layout factory - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.5 2004/11/03 15:17:04 joshy - * added intial support for absolute positioning - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.4 2004/11/02 20:44:55 joshy - * put in some prep work for float support - * removed some dead debugging code - * moved isBlock code to LayoutFactory - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.3 2004/10/23 13:46:46 pdoubleya - * Re-formatted using JavaStyle tool. - * Cleaned imports to resolve wildcards except for common packages (java.io, java.util, etc). - * Added CVS log comments at bottom. - * - * - */ + public RootCounterContext getGlobalCounterContext() { + return _rootCounterContext; + } +} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/AbstractCounterContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/AbstractCounterContext.java new file mode 100644 index 000000000..4f3702b2d --- /dev/null +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/AbstractCounterContext.java @@ -0,0 +1,11 @@ +package com.openhtmltopdf.layout.counter; + +import java.util.List; + +public interface AbstractCounterContext { + + int getCurrentCounterValue(String name); + + List getCurrentCounterValues(String name); + +} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/CounterContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/CounterContext.java new file mode 100644 index 000000000..85df6326e --- /dev/null +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/CounterContext.java @@ -0,0 +1,136 @@ +package com.openhtmltopdf.layout.counter; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import com.openhtmltopdf.css.constants.CSSName; +import com.openhtmltopdf.css.constants.IdentValue; +import com.openhtmltopdf.css.parser.CounterData; +import com.openhtmltopdf.css.style.CalculatedStyle; +import com.openhtmltopdf.layout.LayoutContext; + +public class CounterContext implements AbstractCounterContext { + private final Map _counters = new HashMap<>(); + /** + * This is different because it needs to work even when the counter- properties cascade + * and it should also logically be redefined on each level (think list-items within list-items) + */ + private CounterContext _parent; + + /** + * A CounterContext should really be reflected in the element hierarchy, but CalculatedStyles + * reflect the ancestor hierarchy just as well and also handles pseudo-elements seamlessly. + */ + public CounterContext(LayoutContext ctx, CalculatedStyle style, Integer startIndex) { + // Numbering restarted via
      + if (startIndex != null) { + _counters.put("list-item", startIndex); + } + _parent = ctx._counterContextMap.get(style.getParent()); + if (_parent == null) _parent = new CounterContext();//top-level context, above root element + //first the explicitly named counters + List resets = style.getCounterReset(); + if (resets != null) { + resets.forEach(_parent::resetCounter); + } + + List increments = style.getCounterIncrement(); + if (increments != null) { + for (CounterData cd : increments) { + if (!_parent.incrementCounter(cd)) { + _parent.resetCounter(new CounterData(cd.getName(), 0)); + _parent.incrementCounter(cd); + } + } + } + + // then the implicit list-item counter + if (style.isIdent(CSSName.DISPLAY, IdentValue.LIST_ITEM)) { + // Numbering restarted via
    1. + if (startIndex != null) { + _parent._counters.put("list-item", startIndex); + } + _parent.incrementListItemCounter(1); + } + } + + private CounterContext() { + + } + + /** + * @param cd + * @return true if a counter was found and incremented + */ + private boolean incrementCounter(CounterData cd) { + // list-item is a reserved name for list-item counter in CSS3 + if ("list-item".equals(cd.getName())) { + incrementListItemCounter(cd.getValue()); + return true; + } else { + Integer currentValue = _counters.get(cd.getName()); + if (currentValue == null) { + if (_parent == null) { + return false; + } + return _parent.incrementCounter(cd); + } else { + _counters.put(cd.getName(), currentValue + cd.getValue()); + return true; + } + } + } + + private void incrementListItemCounter(int increment) { + Integer currentValue = _counters.get("list-item"); + if (currentValue == null) { + currentValue = 0; + } + _counters.put("list-item", currentValue + increment); + } + + private void resetCounter(CounterData cd) { + _counters.put(cd.getName(), cd.getValue()); + } + + @Override + public int getCurrentCounterValue(String name) { + //only the counters of the parent are in scope + //_parent is never null for a publicly accessible CounterContext + Integer value = _parent.getCounter(name); + if (value == null) { + _parent.resetCounter(new CounterData(name, 0)); + return 0; + } else { + return value.intValue(); + } + } + + private Integer getCounter(String name) { + Integer value = _counters.get(name); + if (value != null) return value; + if (_parent == null) return null; + return _parent.getCounter(name); + } + + @Override + public List getCurrentCounterValues(String name) { + //only the counters of the parent are in scope + //_parent is never null for a publicly accessible CounterContext + List values = new ArrayList<>(); + _parent.getCounterValues(name, values); + if (values.size() == 0) { + _parent.resetCounter(new CounterData(name, 0)); + values.add(Integer.valueOf(0)); + } + return values; + } + + private void getCounterValues(String name, List values) { + if (_parent != null) _parent.getCounterValues(name, values); + Integer value = _counters.get(name); + if (value != null) values.add(value); + } +} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/RootCounterContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/RootCounterContext.java new file mode 100644 index 000000000..2d0b8ad8b --- /dev/null +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/counter/RootCounterContext.java @@ -0,0 +1,46 @@ +package com.openhtmltopdf.layout.counter; + +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import com.openhtmltopdf.css.parser.CounterData; +import com.openhtmltopdf.css.style.CalculatedStyle; + +public class RootCounterContext implements AbstractCounterContext { + private final Map counterMap = new HashMap<>(); + + public void resetCounterValue(CalculatedStyle style) { + List resets = style.getCounterReset(); + if (resets != null) { + resets.forEach(cd -> counterMap.put(cd.getName(), cd.getValue())); + } + } + + public void incrementCounterValue(CalculatedStyle style) { + List incs = style.getCounterIncrement(); + if (incs != null) { + for (CounterData cd : incs) { + counterMap.merge(cd.getName(), cd.getValue(), (old, newVal) -> old + newVal); + } + } + } + + @Override + public int getCurrentCounterValue(String name) { + Integer current = counterMap.get(name); + + if (current != null) { + return current; + } else { + counterMap.put(name, 0); + return 0; + } + } + + @Override + public List getCurrentCounterValues(String name) { + return Collections.singletonList(getCurrentCounterValue(name)); + } +} diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html index 24b4bb4e1..39154a6bf 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html @@ -3,7 +3,6 @@ @@ -24,5 +39,9 @@ This text needs some footnotes. This is a footnote. Also a footnote for this sentence. Another footnote!

      + +

      + Footnote numbers should be 3, 6 and 9. Just to be silly. +

      From 30e19b396142727c263ff33e272e6009f85dbbc0 Mon Sep 17 00:00:00 2001 From: danfickle Date: Wed, 26 May 2021 15:06:16 +1000 Subject: [PATCH 05/54] #364 Very early proof-of-concept for footnotes. Still needs loads of work but sample is rendering something. --- .../openhtmltopdf/css/newmatch/Matcher.java | 9 +- .../openhtmltopdf/css/newmatch/PageInfo.java | 42 +- .../openhtmltopdf/css/parser/CSSParser.java | 11 +- .../com/openhtmltopdf/css/sheet/PageRule.java | 13 +- .../com/openhtmltopdf/layout/BlockBoxing.java | 617 ------------------ .../com/openhtmltopdf/layout/BoxBuilder.java | 25 +- .../openhtmltopdf/layout/InlineBoxing.java | 14 +- .../java/com/openhtmltopdf/layout/Layer.java | 17 +- .../openhtmltopdf/layout/LayoutContext.java | 11 +- .../com/openhtmltopdf/render/BlockBox.java | 18 +- .../openhtmltopdf/render/FootnoteData.java | 5 - .../com/openhtmltopdf/render/PageBox.java | 43 +- .../com/openhtmltopdf/util/LambdaUtil.java | 80 ++- .../html/issue-364-footnotes-basic.html | 13 +- .../pdfboxout/PdfBoxRenderer.java | 13 +- 15 files changed, 254 insertions(+), 677 deletions(-) delete mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/Matcher.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/Matcher.java index e2ea4b562..c7343e953 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/Matcher.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/Matcher.java @@ -111,13 +111,18 @@ public CascadedStyle getPECascadedStyle(Object e, String pseudoElement) { } public PageInfo getPageCascadedStyle(String pageName, String pseudoPage) { - List props = new ArrayList<>(); + List props = new ArrayList<>(); Map> marginBoxes = new HashMap<>(); + List footnote = new ArrayList<>(); for (PageRule pageRule : _pageRules) { if (pageRule.applies(pageName, pseudoPage)) { props.addAll(pageRule.getRuleset().getPropertyDeclarations()); marginBoxes.putAll(pageRule.getMarginBoxes()); + + if (pageRule.getFootnoteAreaProperties() != null) { + footnote.addAll(pageRule.getFootnoteAreaProperties()); + } } } @@ -128,7 +133,7 @@ public PageInfo getPageCascadedStyle(String pageName, String pseudoPage) { style = new CascadedStyle(props.iterator()); } - return new PageInfo(props, style, marginBoxes); + return new PageInfo(props, style, marginBoxes, footnote); } public List getFontFaceRules() { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/PageInfo.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/PageInfo.java index d0e1e27b4..b3d9e46df 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/PageInfo.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/PageInfo.java @@ -20,28 +20,36 @@ package com.openhtmltopdf.css.newmatch; import java.util.ArrayList; +import java.util.Collections; import java.util.List; import java.util.Map; import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; import com.openhtmltopdf.css.constants.MarginBoxName; +import com.openhtmltopdf.css.parser.CSSPrimitiveValue; import com.openhtmltopdf.css.parser.PropertyValue; import com.openhtmltopdf.css.sheet.PropertyDeclaration; import com.openhtmltopdf.css.sheet.StylesheetInfo; public class PageInfo { - private final List _properties; private final CascadedStyle _pageStyle; private final Map> _marginBoxes; - + + private final List _properties; private final List _xmpPropertyList; - - public PageInfo(List properties, CascadedStyle pageStyle, Map> marginBoxes) { + private final List _footnote; + + public PageInfo( + List properties, + CascadedStyle pageStyle, + Map> marginBoxes, + List footnote) { _properties = properties; _pageStyle = pageStyle; _marginBoxes = marginBoxes; - + _footnote = footnote; + _xmpPropertyList = marginBoxes.remove(MarginBoxName.FS_PDF_XMP_METADATA); } @@ -56,10 +64,25 @@ public CascadedStyle getPageStyle() { public List getProperties() { return _properties; } - + + public CascadedStyle createFootnoteAreaStyle() { + if (_footnote == null || _footnote.isEmpty()) { + return new CascadedStyle(Collections.singletonList( + CascadedStyle.createLayoutPropertyDeclaration(CSSName.DISPLAY, IdentValue.BLOCK)).iterator()); + } + + List all = new ArrayList<>(2 + _footnote.size()); + + all.add(CascadedStyle.createLayoutPropertyDeclaration(CSSName.POSITION, IdentValue.ABSOLUTE)); + all.add(CascadedStyle.createLayoutPropertyDeclaration(CSSName.DISPLAY, IdentValue.BLOCK)); + all.addAll(this._footnote); + + return new CascadedStyle(all.iterator()); + } + public CascadedStyle createMarginBoxStyle(MarginBoxName marginBox, boolean alwaysCreate) { List marginProps = _marginBoxes.get(marginBox); - + if ((marginProps == null || marginProps.size() == 0) && ! alwaysCreate) { return null; } @@ -97,9 +120,8 @@ public boolean hasAny(MarginBoxName[] marginBoxes) { return false; } - - public List getXMPPropertyList() - { + + public List getXMPPropertyList() { return _xmpPropertyList; } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java index cdcb8da73..dcca2e812 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/parser/CSSParser.java @@ -572,12 +572,14 @@ private void margin(Stylesheet stylesheet, PageRule pageRule) throws IOException } String name = getTokenValue(t); MarginBoxName marginBoxName = MarginBoxName.valueOf(name); - if (marginBoxName == null) { + if (marginBoxName == null && !"footnote".equals(name)) { error(new CSSParseException(name + " is not a valid margin box name", getCurrentLine()), "at rule", true); recover(true, false); return; } + boolean isFootnoteRule = "footnote".equals(name); + skip_whitespace(); try { t = next(); @@ -590,7 +592,12 @@ private void margin(Stylesheet stylesheet, PageRule pageRule) throws IOException push(t); throw new CSSParseException(t, Token.TK_RBRACE, getCurrentLine()); } - pageRule.addMarginBoxProperties(marginBoxName, ruleset.getPropertyDeclarations()); + + if (isFootnoteRule) { + pageRule.addFootnoteAreaProperties(ruleset.getPropertyDeclarations()); + } else { + pageRule.addMarginBoxProperties(marginBoxName, ruleset.getPropertyDeclarations()); + } } else { push(t); throw new CSSParseException(t, Token.TK_LBRACE, getCurrentLine()); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/sheet/PageRule.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/sheet/PageRule.java index dea643e20..673dc7507 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/sheet/PageRule.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/sheet/PageRule.java @@ -19,6 +19,7 @@ */ package com.openhtmltopdf.css.sheet; +import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -32,7 +33,9 @@ public class PageRule implements RulesetContainer { private int _origin; private final Map> _marginBoxes = new HashMap<>(); - + + private List _footnoteArea = null; + private int _pos; private int _specificityF; @@ -137,4 +140,12 @@ public int getPos() { public void setPos(int pos) { _pos = pos; } + + public void addFootnoteAreaProperties(List propertyDeclarations) { + this._footnoteArea = propertyDeclarations; + } + + public List getFootnoteAreaProperties() { + return this._footnoteArea; + } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java index 12c7f4850..c04ba3502 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java @@ -483,620 +483,3 @@ public void setChildOffset(int childOffset) { } } } - -/* - * $Id$ - * - * $Log$ - * Revision 1.69 2009/05/12 17:38:30 peterbrant - * Patch from Stefan Hoffmann - * - * Revision 1.68 2009/01/23 22:32:07 peterbrant - * Fix NPE reported by Christophe M (thanks Patrick) - * - * Revision 1.67 2008/12/14 13:53:30 peterbrant - * Implement -fs-keep-with-inline: keep property that instructs FS to try to avoid breaking a box so that only borders and padding appear on a page - * - * Revision 1.66 2008/04/12 01:04:13 peterbrant - * Optimize implementation of page-break-inside: avoid - * - * Revision 1.65 2008/02/03 12:35:06 peterbrant - * Need to update child offset when laying out a block again. We'll need it later if two "keep together" runs adjoin. - * - * Revision 1.64 2007/08/19 22:22:52 peterbrant - * Merge R8pbrant changes to HEAD - * - * Revision 1.63.2.3 2007/08/17 19:11:30 peterbrant - * When paginating a table, move table past page break if header would overlap the page break - * - * Revision 1.63.2.2 2007/08/17 17:11:01 peterbrant - * Try to avoid awkward row splits when paginating a table by making sure there is at least one line box on the same page as the start of the row - * - * Revision 1.63.2.1 2007/08/07 17:06:30 peterbrant - * Implement named pages / Implement page-break-before/after: left/right / Experiment with efficient selection - * - * Revision 1.63 2007/06/16 22:51:24 tobega - * We now support counters! - * - * Revision 1.62 2007/06/11 22:24:53 peterbrant - * Fix bug when calculating new initial position of a run of blocks tied together by page-break-before/after - * - * Revision 1.61 2007/06/07 16:56:30 peterbrant - * When vertically aligning table cell content, call layout again on cells as necessary to make sure pagination properties are respected at the cell's final position (and to make sure line boxes can't straddle page breaks). - * - * Revision 1.60 2007/05/22 15:55:15 peterbrant - * Minor cleanup - * - * Revision 1.59 2007/05/21 21:58:48 peterbrant - * More cleanup (remove experimental threading code) - * - * Revision 1.58 2007/04/25 18:09:41 peterbrant - * Always reset block box margin if it is the first thing on a page - * - * Revision 1.57 2007/03/12 21:11:21 peterbrant - * Documentation update - * - * Revision 1.56 2007/03/08 19:47:04 peterbrant - * Comment change - * - * Revision 1.55 2007/03/08 18:02:51 peterbrant - * Fix regression in page-break-before/after: always - * - * Revision 1.54 2007/02/21 23:49:41 peterbrant - * Can't calculate clearance until margins have been collapsed / Clearance must be calculated relative to the box's border edge, not margin edge - * - * Revision 1.53 2007/02/21 17:16:49 peterbrant - * Calculate position of next child and block height independently. They may not - * move in lockstep in the face of negative vertical margins. - * - * Revision 1.52 2007/02/07 16:33:35 peterbrant - * Initial commit of rewritten table support and associated refactorings - * - * Revision 1.51 2006/09/01 23:49:35 peterbrant - * Implement basic margin collapsing / Various refactorings in preparation for shrink-to-fit / Add hack to treat auto margins as zero - * - * Revision 1.50 2006/08/29 17:29:11 peterbrant - * Make Style object a thing of the past - * - * Revision 1.49 2006/08/27 00:35:42 peterbrant - * Initial commit of (initial) R7 work - * - * Revision 1.48 2006/03/01 00:45:03 peterbrant - * Provide LayoutContext when calling detach() and friends - * - * Revision 1.47 2006/02/07 00:02:51 peterbrant - * If "keep together" cannot be satisified, drop rule vs. pushing to next page / Fix bug with incorrect positioning of content following relative block layers - * - * Revision 1.46 2006/01/27 01:15:31 peterbrant - * Start on better support for different output devices - * - * Revision 1.45 2006/01/11 22:08:53 peterbrant - * Only increment list "counter" when display: list-item - * - * Revision 1.44 2006/01/10 20:11:31 peterbrant - * Fix bug in page-break-before/avoid: avoid - * - * Revision 1.43 2006/01/10 19:55:59 peterbrant - * Fix inappropriate box resizing when width: auto - * - * Revision 1.42 2006/01/04 19:50:15 peterbrant - * More pagination bug fixes / Implement simple pagination for tables - * - * Revision 1.41 2006/01/03 23:55:54 peterbrant - * Add support for proper page breaking of floats / More bug fixes to pagination support - * - * Revision 1.40 2006/01/03 17:04:46 peterbrant - * Many pagination bug fixes / Add ability to position absolute boxes in margin area - * - * Revision 1.39 2006/01/02 20:59:07 peterbrant - * Implement page-break-before/after: avoid - * - * Revision 1.38 2006/01/01 03:35:37 peterbrant - * In print mode, make sure block has a page on which to be drawn - * - * Revision 1.37 2006/01/01 03:14:27 peterbrant - * Implement page-break-inside: avoid - * - * Revision 1.36 2006/01/01 02:38:16 peterbrant - * Merge more pagination work / Various minor cleanups - * - * Revision 1.35 2005/12/30 01:32:35 peterbrant - * First merge of parts of pagination work - * - * Revision 1.34 2005/12/28 00:50:50 peterbrant - * Continue ripping out first try at pagination / Minor method name refactoring - * - * Revision 1.33 2005/12/21 02:36:26 peterbrant - * - Calculate absolute positions incrementally (prep work for pagination) - * - Light cleanup - * - Fix bug where floats nested in floats could cause the outer float to be positioned in the wrong place - * - * Revision 1.32 2005/12/17 02:24:07 peterbrant - * Remove last pieces of old (now non-working) clip region checking / Push down handful of fields from Box to BlockBox - * - * Revision 1.31 2005/12/07 00:33:12 peterbrant - * :first-letter and :first-line works again - * - * Revision 1.30 2005/12/05 00:13:54 peterbrant - * Improve list-item support (marker positioning is now correct) / Start support for relative inline layers - * - * Revision 1.29 2005/11/29 02:37:25 peterbrant - * Make clear work again / Rip out old pagination code - * - * Revision 1.28 2005/11/25 16:57:14 peterbrant - * Initial commit of inline content refactoring - * - * Revision 1.27 2005/11/05 18:45:05 peterbrant - * General cleanup / Remove obsolete code - * - * Revision 1.26 2005/11/05 03:29:30 peterbrant - * Start work on painting order and improved positioning implementation - * - * Revision 1.25 2005/11/03 20:58:41 peterbrant - * Bug fixes to rewritten float code. Floated block positioning should be very solid now. - * - * Revision 1.24 2005/11/03 17:58:16 peterbrant - * Float rewrite (still stomping bugs, but demos work) - * - * Revision 1.23 2005/11/02 18:15:25 peterbrant - * First merge of Tobe's and my stacking context work / Rework float code (not done yet) - * - * Revision 1.22 2005/10/27 00:08:58 tobega - * Sorted out Context into RenderingContext and LayoutContext - * - * Revision 1.21 2005/10/18 20:57:01 tobega - * Patch from Peter Brant - * - * Revision 1.20 2005/10/16 23:57:14 tobega - * Starting experiment with flat representation of render tree - * - * Revision 1.19 2005/10/12 21:17:12 tobega - * patch from Peter Brant - * - * Revision 1.18 2005/10/08 17:40:20 tobega - * Patch from Peter Brant - * - * Revision 1.17 2005/10/06 03:20:20 tobega - * Prettier incremental rendering. Ran into more trouble than expected and some creepy crawlies and a few pages don't look right (forms.xhtml, splash.xhtml) - * - * Revision 1.16 2005/10/02 21:42:53 tobega - * Only do incremental rendering if we are in an interactive context - * - * Revision 1.15 2005/10/02 21:29:58 tobega - * Fixed a lot of concurrency (and other) issues from incremental rendering. Also some house-cleaning. - * - * Revision 1.14 2005/09/29 21:34:02 joshy - * minor updates to a lot of files. pulling in more incremental rendering code. - * fixed another resize bug - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.13 2005/09/27 23:48:39 joshy - * first merge of basicpanel reworking and incremental layout. more to come. - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.12 2005/07/20 18:11:41 joshy - * bug fixes to absolute pos layout and box finding within abs layout - * - * Revision 1.11 2005/06/19 23:31:32 joshy - * stop layout support - * clear bug fixes - * mouse busy cursor support - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.10 2005/06/16 18:34:09 joshy - * support for clear:right - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.9 2005/06/16 04:38:15 joshy - * finished support for clear - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.8 2005/06/15 16:49:48 joshy - * inital clear support - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.7 2005/06/05 01:02:34 tobega - * Very simple and not completely functional table layout - * - * Revision 1.6 2005/06/03 19:56:42 tobega - * Now uses first-line styles from all block-level ancestors - * - * Revision 1.5 2005/05/13 11:49:57 tobega - * Started to fix up borders on inlines. Got caught up in refactoring. - * Boxes shouldn't cache borders and stuff unless necessary. Started to remove unnecessary references. - * Hover is not working completely well now, might get better when I'm done. - * - * Revision 1.4 2005/01/31 22:50:17 pdoubleya - * . - * - * Revision 1.3 2005/01/29 20:24:27 pdoubleya - * Clean/reformat code. Removed commented blocks, checked copyright. - * - * Revision 1.2 2005/01/07 12:42:07 tobega - * Hacked improved support for custom components (read forms). Creates trouble with the image demo. Anyway, components work and are usually in the right place. - * - * Revision 1.1 2005/01/02 12:22:16 tobega - * Cleaned out old layout code - * - * Revision 1.62 2005/01/02 09:32:40 tobega - * Now using mostly static methods for layout - * - * Revision 1.61 2005/01/02 01:00:08 tobega - * Started sketching in code for handling replaced elements in the NamespaceHandler - * - * Revision 1.60 2005/01/01 23:38:37 tobega - * Cleaned out old rendering code - * - * Revision 1.59 2005/01/01 22:37:43 tobega - * Started adding in the table support. - * - * Revision 1.58 2004/12/29 10:39:32 tobega - * Separated current state Context into LayoutContext and the rest into SharedContext. - * - * Revision 1.57 2004/12/28 01:48:23 tobega - * More cleaning. Magically, the financial report demo is starting to look reasonable, without any effort being put on it. - * - * Revision 1.56 2004/12/27 09:40:47 tobega - * Moved more styling to render stage. Now inlines have backgrounds and borders again. - * - * Revision 1.55 2004/12/27 07:43:30 tobega - * Cleaned out border from box, it can be gotten from current style. Is it maybe needed for dynamic stuff? - * - * Revision 1.54 2004/12/24 08:46:49 tobega - * Starting to get some semblance of order concerning floats. Still needs more work. - * - * Revision 1.53 2004/12/20 23:25:31 tobega - * Cleaned up handling of absolute boxes and went back to correct use of anonymous boxes in ContentUtil - * - * Revision 1.52 2004/12/16 17:22:25 joshy - * minor code cleanup - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.51 2004/12/16 17:10:41 joshy - * fixed box bug - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.50 2004/12/16 15:53:08 joshy - * fixes for absolute layout - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.49 2004/12/14 02:28:47 joshy - * removed some comments - * some bugs with the backgrounds still - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.48 2004/12/14 01:56:22 joshy - * fixed layout width bugs - * fixed extra border on document bug - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.47 2004/12/13 15:15:56 joshy - * fixed bug where inlines would pick up parent styles when they aren't supposed to - * fixed extra Xx's in printed text - * added conf boolean to turn on box outlines - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.46 2004/12/13 01:29:40 tobega - * Got the scrollbars back (by accident), and now we should be able to display DocumentFragments as well as Documents, if someone finds that useful. - * - * Revision 1.45 2004/12/12 18:06:51 tobega - * Made simple layout (inline and box) a bit easier to understand - * - * Revision 1.44 2004/12/12 05:51:48 tobega - * Now things run. But there is a lot to do before it looks as nice as it did. At least we now have :before and :after content and handling of breaks by css. - * - * Revision 1.43 2004/12/12 04:18:56 tobega - * Now the core compiles at least. Now we must make it work right. Table layout is one point that really needs to be looked over - * - * Revision 1.42 2004/12/12 03:32:58 tobega - * Renamed x and u to avoid confusing IDE. But that got cvs in a twist. See if this does it - * - * Revision 1.41 2004/12/12 03:04:31 tobega - * Making progress - * - * Revision 1.40 2004/12/11 23:36:48 tobega - * Progressing on cleaning up layout and boxes. Still broken, won't even compile at the moment. Working hard to fix it, though. - * - * Revision 1.39 2004/12/11 21:14:48 tobega - * Prepared for handling run-in content (OK, I know, a side-track). Still broken, won't even compile at the moment. Working hard to fix it, though. - * - * Revision 1.38 2004/12/11 18:18:10 tobega - * Still broken, won't even compile at the moment. Working hard to fix it, though. Replace the StyleReference interface with our only concrete implementation, it was a bother changing in two places all the time. - * - * Revision 1.37 2004/12/10 06:51:02 tobega - * Shamefully, I must now check in painfully broken code. Good news is that Layout is much nicer, and we also handle :before and :after, and do :first-line better than before. Table stuff must be brought into line, but most needed is to fix Render. IMO Render should work with Boxes and Content. If Render goes for a node, that is wrong. - * - * Revision 1.36 2004/12/09 21:18:52 tobega - * precaution: code still works - * - * Revision 1.35 2004/12/09 00:11:51 tobega - * Almost ready for Content-based inline generation. - * - * Revision 1.34 2004/12/08 00:42:34 tobega - * More cleaning of use of Node, more preparation for Content-based inline generation. Also fixed 2 irritating bugs! - * - * Revision 1.33 2004/12/06 23:41:14 tobega - * More cleaning of use of Node, more preparation for Content-based inline generation. - * - * Revision 1.32 2004/12/05 05:00:39 joshy - * fixed bug that prevented explict box heights from working. - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.31 2004/12/05 00:48:57 tobega - * Cleaned up so that now all property-lookups use the CalculatedStyle. Also added support for relative values of top, left, width, etc. - * - * Revision 1.30 2004/12/01 01:57:00 joshy - * more updates for float support. - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.29 2004/11/30 20:38:49 joshy - * cleaned up the float and absolute interfaces a bit - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.28 2004/11/30 20:28:27 joshy - * support for multiple floats on a single line. - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.27 2004/11/27 15:46:38 joshy - * lots of cleanup to make the code clearer - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.26 2004/11/18 19:10:04 joshy - * added bottom support to absolute positioning - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.25 2004/11/18 18:49:48 joshy - * fixed the float issue. - * commented out more dead code - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.24 2004/11/18 14:26:22 joshy - * more code cleanup - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.23 2004/11/18 02:51:14 joshy - * moved more code out of the box into custom classes - * added more preload logic to the default layout's preparebox method - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.21 2004/11/16 07:25:09 tobega - * Renamed HTMLPanel to BasicPanel - * - * Revision 1.20 2004/11/15 15:20:38 joshy - * fixes for absolute layout - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.19 2004/11/14 16:40:58 joshy - * refactored layout factory - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.18 2004/11/12 18:51:00 joshy - * fixed repainting issue for background-attachment: fixed - * added static util methods and get minimum size to graphics 2d renderer - * added test for graphics 2d renderer - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.17 2004/11/12 17:05:24 joshy - * support for fixed positioning - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.16 2004/11/09 15:53:48 joshy - * initial support for hover (currently disabled) - * moved justification code into it's own class in a new subpackage for inline - * layout (because it's so blooming complicated) - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.15 2004/11/08 20:50:58 joshy - * improved float support - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.14 2004/11/08 15:10:10 joshy - * added support for styling :first-letter inline boxes - * updated the absolute positioning tests - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.13 2004/11/07 13:39:17 joshy - * fixed missing borders on the table - * changed td and th to display:table-cell - * updated isBlockLayout() code to fix double border problem with tables - * - * -j - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.12 2004/11/06 22:49:51 joshy - * cleaned up alice - * initial support for inline borders and backgrounds - * moved all of inlinepainter back into inlinerenderer, where it belongs. - * - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.11 2004/11/05 18:45:14 joshy - * support for floated blocks (not just inline blocks) - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.10 2004/11/04 15:35:44 joshy - * initial float support - * includes right and left float - * cannot have more than one float per line per side - * floats do not extend beyond enclosing block - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.9 2004/11/03 23:54:33 joshy - * added hamlet and tables to the browser - * more support for absolute layout - * added absolute layout unit tests - * removed more dead code and moved code into layout factory - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.8 2004/11/03 15:17:04 joshy - * added intial support for absolute positioning - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.7 2004/10/28 02:13:40 joshy - * finished moving the painting code into the renderers - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.6 2004/10/28 01:34:23 joshy - * moved more painting code into the renderers - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.5 2004/10/26 00:13:14 joshy - * added threaded layout support to the BasicPanel - * - * - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.4 2004/10/23 13:46:46 pdoubleya - * Re-formatted using JavaStyle tool. - * Cleaned imports to resolve wildcards except for common packages (java.io, java.util, etc). - * Added CVS log comments at bottom. - * - * - */ - diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index fb32919d7..be1f434b5 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -53,7 +53,6 @@ import com.openhtmltopdf.css.style.EmptyStyle; import com.openhtmltopdf.css.style.FSDerivedValue; import com.openhtmltopdf.layout.counter.AbstractCounterContext; -import com.openhtmltopdf.layout.counter.CounterContext; import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.newtable.TableBox; import com.openhtmltopdf.newtable.TableCellBox; @@ -66,7 +65,6 @@ import com.openhtmltopdf.render.FloatedBoxData; import com.openhtmltopdf.render.FlowingColumnBox; import com.openhtmltopdf.render.FlowingColumnContainerBox; -import com.openhtmltopdf.render.FootnoteData; import com.openhtmltopdf.render.InlineBox; import com.openhtmltopdf.util.OpenUtil; @@ -745,9 +743,6 @@ private static CounterFunction makeCounterFunction( if ("footnote".equals(s)) { RootCounterContext rootCc = c.getSharedContext().getGlobalCounterContext(); - //rootCc.resetCounterValue(style); - //rootCc.incrementCounterValue(style); - int counterValue = rootCc.getCurrentCounterValue(s); return new CounterFunction(counterValue, listStyleType); } @@ -1064,7 +1059,6 @@ private static BlockBox createBlockBox( CalculatedStyle style, ChildBoxInfo info, boolean generated) { if (style.isFootnote()) { BlockBox result = new BlockBox(); - result.setFootnoteData(new FootnoteData()); return result; } else if (style.isFloated() && !(style.isAbsolute() || style.isFixed())) { BlockBox result; @@ -1204,14 +1198,28 @@ private static void createElementChild( // Create the out-of-flow footnote-body box as a block box. BlockBox footnoteBody = new BlockBox(); + footnoteBody.setElement(element); - footnoteBody.setFootnoteData(new FootnoteData()); - footnoteBody.setStyle(style.createAnonymousStyle(IdentValue.FS_FOOTNOTE_BODY)); + footnoteBody.setStyle(style.createAnonymousStyle(IdentValue.BLOCK)); + footnoteBody.setChildrenContentType(BlockBox.CONTENT_INLINE); + footnoteBody.setContainingBlock(c.getFootnoteLayer().getMaster().getContainingBlock()); + + Layer layer = new Layer(footnoteBody, c, true); + + footnoteBody.setLayer(layer); + footnoteBody.setContainingLayer(layer); + c.pushLayer(layer); // The footnote marker followed by footnote element children. insertGeneratedContent(c, element, style, "footnote-marker", footnoteChildren, footnoteChildInfo); createChildren(c, footnoteBody, element, footnoteChildren, footnoteChildInfo, style.isInline()); + footnoteBody.setInlineContent(footnoteChildren); + + footnoteChildInfo.setContainsBlockLevelContent(false); + + c.popLayer(); + // This is purely a marker box for the footnote so we // can figure out in layout when to add the footnote body. InlineBox iB = createInlineBox("", parent, context.parentStyle, null); @@ -1219,7 +1227,6 @@ private static void createElementChild( iB.setEndsHere(true); iB.setFootnote(footnoteBody); children.add(iB); - context.previousIB = iB; // This is the official marker content that can generate zero or more boxes // depending on user for ::footnote-call pseudo element. diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java index 9abbc31a6..0efec8ea3 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java @@ -48,6 +48,7 @@ import com.openhtmltopdf.render.InlineText; import com.openhtmltopdf.render.LineBox; import com.openhtmltopdf.render.MarkerData; +import com.openhtmltopdf.render.PageBox; import com.openhtmltopdf.render.StrutMetrics; import com.openhtmltopdf.render.TextDecoration; import com.openhtmltopdf.util.XRLog; @@ -78,7 +79,9 @@ static class StateVariables { InlineLayoutBox layoutBox; } - public static void layoutContent(LayoutContext c, BlockBox box, int initialY, int breakAtLine) { + public static void layoutContent( + LayoutContext c, BlockBox box, int initialY, int breakAtLine) { + Element blockElement = box.getElement(); Paragraph para = c.getParagraphSplitter().lookupBlockElement(blockElement); byte blockLayoutDirection = para.getActualDirection(); @@ -86,7 +89,7 @@ public static void layoutContent(LayoutContext c, BlockBox box, int initialY, in SpaceVariables space = new SpaceVariables(box.getContentWidth()); StateVariables current = new StateVariables(); StateVariables previous = new StateVariables(); - + current.line = newLine(c, initialY, box); current.line.setDirectionality(blockLayoutDirection); @@ -145,7 +148,12 @@ public static void layoutContent(LayoutContext c, BlockBox box, int initialY, in InlineBox inlineBox = (InlineBox)node; CalculatedStyle style = inlineBox.getStyle(); - + + if (inlineBox.hasFootnote() && c.isPrint()) { + PageBox page = c.getRootLayer().getPage(c, current.line.getAbsY()); + page.addFootnoteBody(c, inlineBox.getFootnoteBody()); + } + if (inlineBox.isStartsHere()) { startInlineBox(c, space, current, previous, openInlineBoxes, iBMap, inlineBox, style); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java index d495ae841..ad1f12c80 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java @@ -101,6 +101,8 @@ public class Layer { private AffineTransform _ctm; private final boolean _hasLocalTransform; + private boolean _isolated; + /** * Creates the root layer. */ @@ -109,6 +111,17 @@ public Layer(Box master, CssContext c) { setStackingContext(true); } + public Layer(Box master, CssContext c, boolean isolated) { + this(master, c); + if (isolated) { + setIsolated(true); + } + } + + private void setIsolated(boolean b) { + _isolated = b; + } + /** * Creates a child layer. */ @@ -278,7 +291,7 @@ public List collectLayers(int which) { for (Layer child : children) { if (! child.isStackingContext()) { - if (child.isForDeletion()) { + if (child.isForDeletion() || child._isolated) { // Do nothing... } else if (which == AUTO && child.isZIndexAuto()) { result.add(child); @@ -301,7 +314,7 @@ private List getStackingContextLayers(int which) { List children = getChildren(); for (Layer target : children) { - if (target.isForDeletion()) { + if (target.isForDeletion() || target._isolated) { // Do nothing... } else if (target.isStackingContext()) { if (!target.isZIndexAuto()) { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java index 863201737..520be8215 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java @@ -43,7 +43,6 @@ import com.openhtmltopdf.extend.UserAgentCallback; import com.openhtmltopdf.layout.counter.AbstractCounterContext; import com.openhtmltopdf.layout.counter.CounterContext; -import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.render.Box; import com.openhtmltopdf.render.FSFont; import com.openhtmltopdf.render.FSFontMetrics; @@ -68,6 +67,8 @@ public class LayoutContext implements CssContext { private LinkedList _bfcs; private LinkedList _layers; + private Layer _footnoteLayer; + private FontContext _fontContext; private final ContentFunctionFactory _contentFunctionFactory = new ContentFunctionFactory(); @@ -494,4 +495,12 @@ public BreakAtLineContext getBreakAtLineContext() { public void setBreakAtLineContext(BreakAtLineContext breakAtLineContext) { _breakAtLineContext = breakAtLineContext; } + + public void setFootnoteLayer(Layer footnoteLayer) { + _footnoteLayer = footnoteLayer; + } + + public Layer getFootnoteLayer() { + return _footnoteLayer; + } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java index fa927b92c..b953ac1d0 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java @@ -112,8 +112,6 @@ public class BlockBox extends Box implements InlinePaintable { private boolean _isReplaced; - private FootnoteData _footnoteData; - public BlockBox() { super(); } @@ -991,9 +989,9 @@ public void layout(LayoutContext c, int contentStart) { boolean pushedLayer = false; if (isRoot()) { - pushedLayer = true; + pushedLayer = true; c.pushLayer(this); - + if (c.isPrint()) { if (!style.isIdent(CSSName.PAGE, IdentValue.AUTO)) { c.setPageName(style.getStringProperty(CSSName.PAGE)); @@ -1063,9 +1061,9 @@ public void layout(LayoutContext c, int contentStart) { setTx(tx); setTy(ty); c.translate(getTx(), getTy()); - if (! isReplaced()) + if (! isReplaced()) { layoutChildren(c, contentStart); - else { + } else { setState(Box.DONE); } c.translate(-getTx(), -getTy()); @@ -2402,14 +2400,6 @@ public boolean hasMargin() { return maxPositive != 0 || maxNegative != 0; } } - - public void setFootnoteData(FootnoteData footnoteData) { - this._footnoteData = footnoteData; - } - - public boolean isFootnoteBody() { - return _footnoteData != null; - } } /* diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java deleted file mode 100644 index 7e5fd2516..000000000 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/FootnoteData.java +++ /dev/null @@ -1,5 +0,0 @@ -package com.openhtmltopdf.render; - -public class FootnoteData { - -} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java index d74d716ad..4dc789486 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java @@ -24,9 +24,11 @@ import java.awt.Rectangle; import java.io.IOException; import java.io.Writer; +import java.util.ArrayList; import java.util.Iterator; import java.util.List; import org.w3c.dom.Element; +import org.w3c.dom.Node; import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; @@ -38,6 +40,7 @@ import com.openhtmltopdf.css.sheet.PropertyDeclaration; import com.openhtmltopdf.css.style.CalculatedStyle; import com.openhtmltopdf.css.style.CssContext; +import com.openhtmltopdf.css.style.EmptyStyle; import com.openhtmltopdf.css.style.derived.LengthValue; import com.openhtmltopdf.css.style.derived.RectPropertySet; import com.openhtmltopdf.extend.StructureType; @@ -46,6 +49,7 @@ import com.openhtmltopdf.layout.LayoutContext; import com.openhtmltopdf.newtable.TableBox; import com.openhtmltopdf.render.simplepainter.SimplePainter; +import com.openhtmltopdf.util.LambdaUtil; import com.openhtmltopdf.util.ThreadCtx; public class PageBox { @@ -86,7 +90,10 @@ public class PageBox { private int _basePagePdfPageIndex; private int _shadowPageCount; - + + private final List _footnotes = new ArrayList<>(); + private int _totalFootnoteHeight; + public void setBasePagePdfPageIndex(int idx) { this._basePagePdfPageIndex = idx; } @@ -316,8 +323,8 @@ public Rectangle getDocumentCoordinatesContentBoundsForInsertedPage(CssContext c */ public int getMaxShadowPagesForXPos(CssContext c, int x) { IdentValue dir = getCutOffPageDirection(); - float fx = (float) x; - float fw = (float) getContentWidth(c); + float fx = x; + float fw = getContentWidth(c); if (fw == 0f) { return 0; @@ -437,6 +444,27 @@ public void paintMarginAreas(RenderingContext c, int additionalClearance, short } currentMarginAreaContainer = null; } + + public void paintFootnoteArea(RenderingContext c) { + int start = getBottom() - _totalFootnoteHeight; + int x = getMarginBorderPadding(c, CalculatedStyle.LEFT); + + if (!_footnotes.isEmpty()) { + // TODO: Not running structure type! + for (BlockBox bx : _footnotes) { + Object token = c.getOutputDevice().startStructure(StructureType.RUNNING, bx); + + bx.setAbsX(x); + bx.setAbsY(start); + bx.calcChildLocations(); + + SimplePainter painter = new SimplePainter(0, 0); + painter.paintLayer(c, bx.getLayer()); + start += bx.getHeight(); + c.getOutputDevice().endStructure(token); + } + } + } public MarginBoxName[] getCurrentMarginBoxNames() { if( currentMarginAreaContainer == null ) @@ -856,4 +884,13 @@ public Point getPaintingPosition( return new Point(left, top); } } + + public void addFootnoteBody(LayoutContext c, BlockBox footnoteBody) { + footnoteBody.layout(c); + + int height = footnoteBody.getHeight(); + _totalFootnoteHeight += height; + + _footnotes.add(footnoteBody); + } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java index 8b08c3846..6e8fba034 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java @@ -1,14 +1,90 @@ package com.openhtmltopdf.util; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; import java.util.function.Predicate; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import com.openhtmltopdf.layout.Layer; +import com.openhtmltopdf.render.Box; public class LambdaUtil { private LambdaUtil() { } - + + /** + * Null-safe way to look up the ancestor tree as a stream. + * Does not include starting box. + * Will return a empty stream if either bx or bx.getParent() is null. + */ + public static Stream ancestors(Box bx) { + List list = new ArrayList<>(); + while (bx != null && bx.getParent() != null) { + list.add(bx.getParent()); + bx = bx.getParent(); + } + return list.stream(); + } + + /** + * Null-safe identity hash code. + * Debug only. + */ + public static String objectId(Object obj) { + return obj == null ? "null" : Integer.toHexString(System.identityHashCode(obj)); + } + + /** + * Null-safe box description including object id, layer, containing layer and impl class. + * Debug only. + */ + public static String boxDescription(Box box) { + if (box != null) { + return String.format("%s => %s, layer = %s, containing = %s, class = %s", + objectId(box), box, objectId(box.getLayer()), objectId(box.getContainingLayer()), box.getClass().getName()); + } + + return "[null box]"; + } + + /** + * Null-safe layer description including object id, toString and master box description. + * Debug only. + */ + public static String layerDescription(Layer layer) { + if (layer != null) { + return String.format( + "%s, master = %s, parent = %s", + objectId(layer), boxDescription(layer.getMaster()), objectId(layer.getParent())); + } + + return "[null layer]"; + } + + /** + * Ancestor dump to string including starting box and referenced layers. + * Debug only. + */ + public static String ancestorDump(Box bx) { + return + boxDescription(bx) + + ancestors(bx) + .map(LambdaUtil::boxDescription) + .collect(Collectors.joining("\n ", "\nANCESTORS = [\n ", "\n]")) + + Stream.concat( + Stream.of(bx.getLayer(), bx.getContainingLayer()), + ancestors(bx).flatMap(box -> Stream.of(box.getLayer(), box.getContainingLayer())) + ).filter(Objects::nonNull) + .distinct() + .map(LambdaUtil::layerDescription) + .collect(Collectors.joining("\n ", "\nREFED LAYERS = [\n ", "\n]")); + } + public static Predicate alwaysTrue() { return (unused) -> true; } - + public static Predicate alwaysFalse() { return (unused) -> false; } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html index 39154a6bf..5a40c5057 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html @@ -2,13 +2,14 @@ -

      +

      This text needs some footnotes. This is a footnote. Also a footnote for this sentence. Another footnote!

      diff --git a/openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java b/openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java index c2c84de3a..97fe6cb4d 100644 --- a/openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java +++ b/openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java @@ -346,12 +346,6 @@ public void layout() { BlockBox root = BoxBuilder.createRootBox(c, _doc); Box viewport = new ViewportBox(getInitialExtents(c)); - BlockBox footnoteArea = new BlockBox(); - footnoteArea.setStyle(new EmptyStyle()); - footnoteArea.setContainingBlock(viewport); - Layer footnoteLayer = new Layer(footnoteArea, c, true); - c.setFootnoteLayer(footnoteLayer); - root.setContainingBlock(viewport); root.layout(c); Dimension dim = root.getLayer().getPaintingDimension(c); From 0edc5767795ce82d5598c0be89f1c68c1c33110a Mon Sep 17 00:00:00 2001 From: danfickle Date: Fri, 28 May 2021 18:46:13 +1000 Subject: [PATCH 09/54] Better box building, at least when footnote is inline. --- .../com/openhtmltopdf/layout/BoxBuilder.java | 25 +++++++++++++------ .../html/issue-364-footnotes-basic.html | 1 + 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index d947fb1dd..8ebab1517 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -971,6 +971,11 @@ private static List createGeneratedContent( List inlineBoxes = createGeneratedContentList( c, element, property, peName, style, CONTENT_LIST_DOCUMENT, childInfo); + return wrapGeneratedContent(element, peName, style, info, childInfo, inlineBoxes); + } + + private static List wrapGeneratedContent(Element element, String peName, CalculatedStyle style, + ChildBoxInfo info, ChildBoxInfo childInfo, List inlineBoxes) { if (childInfo.isContainsBlockLevelContent()) { List inlines = new ArrayList<>(); @@ -1282,10 +1287,10 @@ private static BlockBox createFootnoteBody(LayoutContext c, Element element, Cal // Create the out-of-flow footnote-body box as a block box. BlockBox footnoteBody = new BlockBox(); + CalculatedStyle footnoteBodyStyle = style.createAnonymousStyle(IdentValue.BLOCK); footnoteBody.setElement(element); - footnoteBody.setStyle(style.createAnonymousStyle(IdentValue.BLOCK)); - footnoteBody.setChildrenContentType(BlockBox.CONTENT_INLINE); + footnoteBody.setStyle(footnoteBodyStyle); footnoteBody.setContainingBlock(null); Layer layer = new Layer(footnoteBody, c, true); @@ -1296,12 +1301,9 @@ private static BlockBox createFootnoteBody(LayoutContext c, Element element, Cal c.pushLayer(layer); // The footnote marker followed by footnote element children. - insertGeneratedContent(c, element, style, "footnote-marker", footnoteChildren, footnoteChildInfo); - createChildren(c, footnoteBody, element, footnoteChildren, footnoteChildInfo, style.isInline()); - - footnoteBody.setInlineContent(footnoteChildren); - - footnoteChildInfo.setContainsBlockLevelContent(false); + insertGeneratedContent(c, element, footnoteBodyStyle, "footnote-marker", footnoteChildren, footnoteChildInfo); + createChildren(c, footnoteBody, element, footnoteChildren, footnoteChildInfo, footnoteBodyStyle.isInline()); + resolveChildren(c, footnoteBody, footnoteChildren, footnoteChildInfo); c.popLayer(); @@ -1601,5 +1603,12 @@ public boolean isLayoutRunningBlocks() { public void setLayoutRunningBlocks(boolean layoutRunningBlocks) { _layoutRunningBlocks = layoutRunningBlocks; } + + @Override + public String toString() { + return String.format( + "ChildBoxInfo [_containsBlockLevelContent=%s, _containsTableContent=%s, _layoutRunningBlocks=%s]", + _containsBlockLevelContent, _containsTableContent, _layoutRunningBlocks); + } } } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html index 6e77ff854..86483e06d 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html @@ -10,6 +10,7 @@ float: bottom; /* The only supported position */ width: 100%; /* Same width as body */ margin: 0 10px; /* Make the left-right margin same as body */ + padding: 3px; /* Same with padding */ border: 1px solid green; } } From 46b796df86b476ecbe8dc2c705195901f6ee06f8 Mon Sep 17 00:00:00 2001 From: danfickle Date: Sat, 29 May 2021 22:12:42 +1000 Subject: [PATCH 10/54] #364 Start the work of the meeting of in-flow content with footnotes. Specifically, line boxes that meet with footnotes will now behave somewhat correctly. --- .../openhtmltopdf/css/style/CssContext.java | 13 +- .../openhtmltopdf/layout/InlineBoxing.java | 4 + .../java/com/openhtmltopdf/layout/Layer.java | 14 +- .../openhtmltopdf/layout/LayoutContext.java | 30 +- .../com/openhtmltopdf/render/BlockBox.java | 6 +- .../java/com/openhtmltopdf/render/Box.java | 534 +----------------- .../com/openhtmltopdf/render/LineBox.java | 299 ++-------- .../com/openhtmltopdf/render/PageBox.java | 164 ++++-- .../render/RenderingContext.java | 20 +- .../java/com/openhtmltopdf/util/BoxUtil.java | 64 +++ .../java/com/openhtmltopdf/util/OpenUtil.java | 13 + .../html/issue-364-footnotes-basic.html | 17 +- 12 files changed, 335 insertions(+), 843 deletions(-) create mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/BoxUtil.java diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CssContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CssContext.java index ac75f46cf..34e295c59 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CssContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CssContext.java @@ -7,13 +7,6 @@ import com.openhtmltopdf.render.FSFont; import com.openhtmltopdf.render.FSFontMetrics; -/** - * Created by IntelliJ IDEA. - * User: tobe - * Date: 2005-jun-23 - * Time: 00:12:50 - * To change this template use File | Settings | File Templates. - */ public interface CssContext { float getMmPerDot(); @@ -35,4 +28,10 @@ public interface CssContext { FontContext getFontContext(); TextRenderer getTextRenderer(); + + /** + * Returns true if we are laying out the footnote area rather + * than general content. + */ + boolean isInFloatBottom(); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java index 0efec8ea3..080bcfe4c 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java @@ -152,6 +152,10 @@ public static void layoutContent( if (inlineBox.hasFootnote() && c.isPrint()) { PageBox page = c.getRootLayer().getPage(c, current.line.getAbsY()); page.addFootnoteBody(c, inlineBox.getFootnoteBody()); + + // We also need to associate it with a line box in case the line moves + // pages. + current.line.addReferencedFootnoteBody(inlineBox.getFootnoteBody()); } if (inlineBox.isStartsHere()) { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java index 7e75ce565..0825d6fe9 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java @@ -1252,12 +1252,24 @@ public PageBox getLastPage() { return pages.size() == 0 ? null : pages.get(pages.size()-1); } + /** + * Returns whether the a box with the given top and bottom would cross a page break. + *

      + * Requirements: top is >= 0. + *

      + * Important: This method will take into account any float: bottom + * content when used in in-flow content. For example, if the top/bottom pair overlaps + * the footnote area, returns true. It also takes into account space set aside for + * paginated table header/footer. + *

      + * See {@link CssContext#isInFloatBottom()} {@link LayoutContext#getExtraSpaceBottom()} + */ public boolean crossesPageBreak(LayoutContext c, int top, int bottom) { if (top < 0) { return false; } PageBox page = getPage(c, top); - return bottom >= page.getBottom() - c.getExtraSpaceBottom(); + return bottom >= page.getBottom(c) - c.getExtraSpaceBottom(); } public Layer findRoot() { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java index fef59812e..2c21c974b 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java @@ -89,9 +89,11 @@ public class LayoutContext implements CssContext { private boolean _lineBreakedBecauseOfNoWrap = false; private BreakAtLineContext _breakAtLineContext; - + private Boolean isPrintOverride = null; // True, false, or null for no override. + private boolean _isInFloatBottom; + @Override public TextRenderer getTextRenderer() { return _sharedContext.getTextRenderer(); @@ -396,18 +398,30 @@ public SharedContext getSharedContext() { return _sharedContext; } + /** + * Returns the extra space set aside for the footers of paginated tables. + */ public int getExtraSpaceBottom() { return _extraSpaceBottom; } + /** + * See {@link #getExtraSpaceBottom()} + */ public void setExtraSpaceBottom(int extraSpaceBottom) { _extraSpaceBottom = extraSpaceBottom; } + /** + * Returns the extra space set aside for the head section of paginated tables. + */ public int getExtraSpaceTop() { return _extraSpaceTop; } + /** + * See {@link #getExtraSpaceTop()} + */ public void setExtraSpaceTop(int extraSpaceTop) { _extraSpaceTop = extraSpaceTop; } @@ -497,4 +511,18 @@ public BreakAtLineContext getBreakAtLineContext() { public void setBreakAtLineContext(BreakAtLineContext breakAtLineContext) { _breakAtLineContext = breakAtLineContext; } + + /** + * See {@link #isInFloatBottom()} + */ + public void setIsInFloatBottom(boolean inFloatBottom) { + _isInFloatBottom = inFloatBottom; + } + + /** + * {@inheritDoc} + */ + public boolean isInFloatBottom() { + return _isInFloatBottom; + } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java index 292aa611f..66582eab0 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java @@ -569,7 +569,7 @@ public void positionAbsolute(CssContext cssCtx, int direction) { public boolean isPageBreakNeededBecauseOfMinHeight(LayoutContext context){ float minHeight = getStyle().getFSPageBreakMinHeight(context); PageBox page = context.getRootLayer().getFirstPage(context, this); - return page != null && getAbsY() + minHeight > page.getBottom(); + return page != null && getAbsY() + minHeight > page.getBottom(context); } @@ -1261,7 +1261,7 @@ private void satisfyWidowsAndOrphans(LayoutContext c, int contentStart, boolean int cCount = getChildCount(); while (i < cCount) { LineBox lB = (LineBox)getChild(i); - if (lB.getAbsY() >= firstPage.getBottom()) { + if (lB.getAbsY() >= firstPage.getBottom(c)) { break; } if (! lB.isContainsContent()) { @@ -1279,7 +1279,7 @@ private void satisfyWidowsAndOrphans(LayoutContext c, int contentStart, boolean List pages = c.getRootLayer().getPages(); PageBox lastPage = pages.get(firstPage.getPageNo()+1); while (lastPage.getPageNo() != pages.size() - 1 && - lastPage.getBottom() < lastLineBox.getAbsY()) { + lastPage.getBottom(c) < lastLineBox.getAbsY()) { lastPage = pages.get(lastPage.getPageNo()+1); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java index cf9684953..6b4f293f5 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java @@ -50,6 +50,7 @@ import java.util.List; import java.util.function.Predicate; import java.util.logging.Level; +import java.util.stream.Collectors; public abstract class Box implements Styleable, DisplayListItem { protected static final String LINE_SEPARATOR = System.getProperty("line.separator"); @@ -811,6 +812,9 @@ public int forcePageBreakBefore(LayoutContext c, IdentValue pageBreakValue, bool } } + /** + * Forces a page break after this box. + */ public void forcePageBreakAfter(LayoutContext c, IdentValue pageBreakValue) { boolean needSecondPageBreak = false; PageBox page = c.getRootLayer().getLastPage(c, this); @@ -841,6 +845,11 @@ public void forcePageBreakAfter(LayoutContext c, IdentValue pageBreakValue) { } } + /** + * Whether this box would cross a page break. + *

      + * See {@link Layer#crossesPageBreak(LayoutContext, int, int)} for extra info. + */ public boolean crossesPageBreak(LayoutContext c) { if (! c.isPageBreaksAllowed()) { return false; @@ -850,7 +859,7 @@ public boolean crossesPageBreak(LayoutContext c) { if (pageBox == null) { return false; } else { - return getAbsY() + getHeight() >= pageBox.getBottom() - c.getExtraSpaceBottom(); + return getAbsY() + getHeight() >= pageBox.getBottom(c) - c.getExtraSpaceBottom(); } } @@ -1409,526 +1418,3 @@ public void findColumnBreakOpportunities(ColumnBreakStore store) { } } - -/* - * $Id$ - * - * $Log$ - * Revision 1.147 2010/01/11 01:27:41 peterbrant - * Correct background-position calculation. Detective work and initial patch from Stefano Bagnara. - * - * 14.2 says backgrounds are painted over the border box. However, background-position is calculated relative to the padding box (spec 14.2.1). We were calculating it relative to the border box. - * - * Revision 1.146 2008/11/07 18:34:33 peterbrant - * Add API to retrieve PDF page and coordinates for boxes with an ID attribute - * - * Revision 1.145 2008/07/27 00:21:47 peterbrant - * Implement CMYK color support for PDF output, starting with patch from Mykola Gurov / Banish java.awt.Color from FS core layout classes - * - * Revision 1.144 2008/04/30 23:02:42 peterbrant - * Fix for bug #239 (detective work by Ludovic Durand-Texte) - * - * Revision 1.143 2008/01/26 15:34:52 peterbrant - * Make getNextSibling() and getPreviousSibling() work with InlineLayoutBox (or as well as it can in that context) - * - * Revision 1.142 2007/08/23 20:52:31 peterbrant - * Begin work on AcroForm support - * Revision 1.141 2007/08/19 22:22:50 peterbrant Merge - * R8pbrant changes to HEAD - * - * Revision 1.140.2.10 2007/08/18 00:52:44 peterbrant When paginating a table, - * clip cells that span multiple pages to the effective content area visible on - * the current page - * - * Revision 1.140.2.9 2007/08/15 21:29:31 peterbrant Initial draft of support - * for running headers and footers on tables - * - * Revision 1.140.2.8 2007/08/14 16:10:30 peterbrant Remove obsolete code - * - * Revision 1.140.2.7 2007/08/13 22:57:03 peterbrant Make sure trailing pages - * with only a header and footer are exported when exporting to text - * - * Revision 1.140.2.6 2007/08/13 22:41:13 peterbrant First pass at exporting the - * render tree as text - * - * Revision 1.140.2.5 2007/08/09 20:18:16 peterbrant Bug fixes to improved - * pagination support - * - * Revision 1.140.2.4 2007/08/08 18:28:25 peterbrant Further progress on CSS3 - * paged media - * - * Revision 1.140.2.3 2007/08/07 17:06:32 peterbrant Implement named pages / - * Implement page-break-before/after: left/right / Experiment with efficient - * selection - * - * Revision 1.140.2.2 2007/07/30 00:43:15 peterbrant Start implementing text - * selection and copying - * - * Revision 1.140.2.1 2007/07/09 22:18:03 peterbrant Begin work on running - * headers and footers and named pages - * - * Revision 1.140 2007/06/11 22:30:15 peterbrant Minor cleanup to LayoutContext / - * Start adding infrastructure to support better table pagination - * - * Revision 1.139 2007/04/25 18:09:41 peterbrant Always reset block box margin - * if it is the first thing on a page - * - * Revision 1.138 2007/04/16 01:10:05 peterbrant Vertical margin and padding - * with percentage values may be incorrect if box participated in a - * shrink-to-fit calculation. Fix margin calculation. - * - * Revision 1.137 2007/04/15 00:34:40 peterbrant Allow inline-block / - * inline-table content to be relatively positioned - * - * Revision 1.136 2007/03/17 22:55:51 peterbrant Remove distinction between box - * IDs and named anchors - * - * Revision 1.135 2007/03/08 01:46:34 peterbrant Fix calculation of - * viewport/page rectangle when calculating fixed background positions - * - * Revision 1.134 2007/02/24 01:57:30 peterbrant toString() changes - * - * Revision 1.133 2007/02/24 01:36:57 peterbrant Fix potential NPE if layout - * fails - * - * Revision 1.132 2007/02/24 00:46:38 peterbrant Paint root element background - * over entire canvas (or it's first child if the root element doesn't define a - * background) - * - * Revision 1.131 2007/02/23 15:50:37 peterbrant Fix incorrect absolute box - * positioning with print medium - * - * Revision 1.130 2007/02/22 18:21:19 peterbrant Add support for overflow: - * visible/hidden - * - * Revision 1.129 2007/02/22 16:10:54 peterbrant Remove unused API - * - * Revision 1.128 2007/02/22 15:52:46 peterbrant Restyle generated content - * correctly (although the CSS matcher needs more work before restyle with - * generated content and dynamic pseudo classes will work) - * - * Revision 1.127 2007/02/22 15:30:42 peterbrant Internal links should be able - * to target block boxes too (plus other minor cleanup) - * - * Revision 1.126 2007/02/21 23:49:41 peterbrant Can't calculate clearance until - * margins have been collapsed / Clearance must be calculated relative to the - * box's border edge, not margin edge - * - * Revision 1.125 2007/02/21 23:11:03 peterbrant Correct margin edge calculation - * (as it turns out the straightforward approach is also the correct one) - * - * Revision 1.124 2007/02/21 19:15:05 peterbrant right and bottom need to push - * the opposite direction as left and top with position: relative - * - * Revision 1.123 2007/02/19 23:42:54 peterbrant Fix resetChildren() typo - * - * Revision 1.122 2007/02/19 14:53:36 peterbrant Integrate new CSS parser - * - * Revision 1.121 2007/02/11 23:10:59 peterbrant Make sure bounds information is - * calculated for fixed layers - * - * Revision 1.120 2007/02/07 16:33:22 peterbrant Initial commit of rewritten - * table support and associated refactorings - * - * Revision 1.119 2006/10/04 23:52:57 peterbrant Implement support for margin: - * auto (centering blocks in their containing block) - * - * Revision 1.118 2006/10/04 19:49:08 peterbrant Improve calculation of - * available width when calculating shrink-to-fit width - * - * Revision 1.117 2006/09/08 15:41:58 peterbrant Calculate containing block - * width accurately when collapsing margins / Provide collapsed bottom margin to - * floats / Revive :first-line and :first-letter / Minor simplication in - * InlineBoxing (get rid of now-superfluous InlineBoxInfo) - * - * Revision 1.116 2006/09/05 23:03:44 peterbrant Initial draft of shrink-to-fit - * support - * - * Revision 1.115 2006/09/01 23:49:38 peterbrant Implement basic margin - * collapsing / Various refactorings in preparation for shrink-to-fit / Add hack - * to treat auto margins as zero - * - * Revision 1.114 2006/08/30 18:25:41 peterbrant Further refactoring / Bug fix - * for problem reported by Mike Curtis - * - * Revision 1.113 2006/08/29 17:29:13 peterbrant Make Style object a thing of - * the past - * - * Revision 1.112 2006/08/27 00:36:44 peterbrant Initial commit of (initial) R7 - * work - * - * Revision 1.111 2006/03/01 00:45:02 peterbrant Provide LayoutContext when - * calling detach() and friends - * - * Revision 1.110 2006/02/22 02:20:19 peterbrant Links and hover work again - * - * Revision 1.109 2006/02/21 20:43:45 peterbrant right was actually using left, - * bottom was actually using top (relative positioning) - * - * Revision 1.108 2006/02/20 23:29:20 peterbrant Fix positioning of replaced - * elements with margins, borders, padding - * - * Revision 1.107 2006/02/07 00:02:52 peterbrant If "keep together" cannot be - * satisified, drop rule vs. pushing to next page / Fix bug with incorrect - * positioning of content following relative block layers - * - * Revision 1.106 2006/02/01 01:30:14 peterbrant Initial commit of PDF work - * - * Revision 1.105 2006/01/27 01:15:38 peterbrant Start on better support for - * different output devices - * - * Revision 1.104 2006/01/11 22:09:27 peterbrant toString() uses absolute - * coordinates now - * - * Revision 1.103 2006/01/10 19:56:00 peterbrant Fix inappropriate box resizing - * when width: auto - * - * Revision 1.102 2006/01/09 23:25:22 peterbrant Correct (?) position of debug - * outline - * - * Revision 1.101 2006/01/04 19:50:14 peterbrant More pagination bug fixes / - * Implement simple pagination for tables - * - * Revision 1.100 2006/01/03 23:55:57 peterbrant Add support for proper page - * breaking of floats / More bug fixes to pagination support - * - * Revision 1.99 2006/01/03 02:12:20 peterbrant Various pagination fixes / Fix - * fixed positioning - * - * Revision 1.98 2006/01/02 20:59:09 peterbrant Implement - * page-break-before/after: avoid - * - * Revision 1.97 2006/01/01 03:14:25 peterbrant Implement page-break-inside: - * avoid - * - * Revision 1.96 2006/01/01 02:38:19 peterbrant Merge more pagination work / - * Various minor cleanups - * - * Revision 1.95 2005/12/30 01:32:39 peterbrant First merge of parts of - * pagination work - * - * Revision 1.94 2005/12/28 00:50:52 peterbrant Continue ripping out first try - * at pagination / Minor method name refactoring - * - * Revision 1.93 2005/12/21 02:36:29 peterbrant - Calculate absolute positions - * incrementally (prep work for pagination) - Light cleanup - Fix bug where - * floats nested in floats could cause the outer float to be positioned in the - * wrong place - * - * Revision 1.92 2005/12/17 02:24:14 peterbrant Remove last pieces of old (now - * non-working) clip region checking / Push down handful of fields from Box to - * BlockBox - * - * Revision 1.91 2005/12/15 20:04:47 peterbrant Implement visibility: hidden - * - * Revision 1.90 2005/12/14 22:06:47 peterbrant Fix NPE - * - * Revision 1.89 2005/12/13 02:41:33 peterbrant Initial implementation of - * vertical-align: top/bottom (not done yet) / Minor cleanup and optimization - * - * Revision 1.88 2005/12/11 02:51:18 peterbrant Minor tweak (misread spec) - * - * Revision 1.87 2005/12/10 03:11:43 peterbrant Use margin edge not content edge - * - * Revision 1.86 2005/12/09 21:41:19 peterbrant Finish support for relative - * inline layers - * - * Revision 1.85 2005/12/09 01:24:56 peterbrant Initial commit of relative - * inline layers - * - * Revision 1.84 2005/12/08 02:21:26 peterbrant Fix positioning bug when CB of - * absolute block is a relative block - * - * Revision 1.83 2005/12/07 03:14:20 peterbrant Fixes to final float position - * when float BFC is not contained in the layer being positioned / Implement - * 10.6.7 of the spec - * - * Revision 1.82 2005/12/07 00:33:12 peterbrant :first-letter and :first-line - * works again - * - * Revision 1.81 2005/12/05 00:13:53 peterbrant Improve list-item support - * (marker positioning is now correct) / Start support for relative inline - * layers - * - * Revision 1.80 2005/11/29 02:37:24 peterbrant Make clear work again / Rip out - * old pagination code - * - * Revision 1.79 2005/11/25 16:57:20 peterbrant Initial commit of inline content - * refactoring - * - * Revision 1.78 2005/11/13 01:14:16 tobega Take into account the height of a - * first-letter. Also attempt to line-break better with inline padding. - * - * Revision 1.77 2005/11/10 18:27:28 peterbrant Position absolute box correctly - * when top: auto and bottom: auto. - * - * Revision 1.76 2005/11/10 01:55:16 peterbrant Further progress on layer work - * - * Revision 1.75 2005/11/09 18:41:28 peterbrant Fixes to vertical margin - * collapsing in the presence of floats / Paint floats as layers - * - * Revision 1.74 2005/11/08 20:03:57 peterbrant Further progress on painting - * order / improved positioning implementation - * - * Revision 1.73 2005/11/05 23:19:07 peterbrant Always add fixed layers to root - * layer / If element has fixed background just note this on the root layer - * instead of property in Box - * - * Revision 1.72 2005/11/05 18:45:06 peterbrant General cleanup / Remove - * obsolete code - * - * Revision 1.71 2005/11/05 03:30:01 peterbrant Start work on painting order and - * improved positioning implementation - * - * Revision 1.70 2005/11/03 17:58:41 peterbrant Float rewrite (still stomping - * bugs, but demos work) - * - * Revision 1.69 2005/11/02 18:15:29 peterbrant First merge of Tobe's and my - * stacking context work / Rework float code (not done yet) - * - * Revision 1.68 2005/10/30 22:06:15 peterbrant Only create child List if - * necessary - * - * Revision 1.67 2005/10/29 22:31:01 tobega House-cleaning - * - * Revision 1.66 2005/10/27 00:09:02 tobega Sorted out Context into - * RenderingContext and LayoutContext - * - * Revision 1.65 2005/10/18 20:57:05 tobega Patch from Peter Brant - * - * Revision 1.64 2005/10/15 23:39:18 tobega patch from Peter Brant - * - * Revision 1.63 2005/10/12 21:17:13 tobega patch from Peter Brant - * - * Revision 1.62 2005/10/08 17:40:21 tobega Patch from Peter Brant - * - * Revision 1.61 2005/10/06 03:20:22 tobega Prettier incremental rendering. Ran - * into more trouble than expected and some creepy crawlies and a few pages - * don't look right (forms.xhtml, splash.xhtml) - * - * Revision 1.60 2005/10/02 21:30:00 tobega Fixed a lot of concurrency (and - * other) issues from incremental rendering. Also some house-cleaning. - * - * Revision 1.59 2005/09/30 04:58:05 joshy fixed garbage when showing a document - * with a fixed positioned block - * - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.58 2005/09/29 21:34:04 joshy minor updates to a lot of files. - * pulling in more incremental rendering code. fixed another resize bug Issue - * number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.57 2005/09/26 22:40:21 tobega Applied patch from Peter Brant - * concerning margin collapsing - * - * Revision 1.56 2005/07/04 00:12:12 tobega text-align now works for table-cells - * too (is done in render, not in layout) - * - * Revision 1.55 2005/06/16 07:24:51 tobega Fixed background image bug. Caching - * images in browser. Enhanced LinkListener. Some house-cleaning, playing with - * Idea's code inspection utility. - * - * Revision 1.54 2005/06/16 04:31:30 joshy added clear support to the box Issue - * number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.53 2005/05/13 15:23:55 tobega Done refactoring box borders, margin - * and padding. Hover is working again. - * - * Revision 1.52 2005/05/13 11:49:59 tobega Started to fix up borders on - * inlines. Got caught up in refactoring. Boxes shouldn't cache borders and - * stuff unless necessary. Started to remove unnecessary references. Hover is - * not working completely well now, might get better when I'm done. - * - * Revision 1.51 2005/05/08 14:36:58 tobega Refactored away the need for having - * a context in a CalculatedStyle - * - * Revision 1.50 2005/04/22 17:19:19 joshy resovled conflicts in Box Issue - * number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.49 2005/04/21 18:16:08 tobega Improved handling of inline padding. - * Also fixed first-line handling according to spec. - * - * Revision 1.48 2005/04/19 17:51:18 joshy fixed absolute positioning bug - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.47 2005/04/19 13:59:48 pdoubleya Added defaults for margin, - * padding, border. - * - * Revision 1.46 2005/02/03 23:16:16 pdoubleya . - * - * Revision 1.45 2005/01/31 22:51:35 pdoubleya Added caching for - * padding/margin/border calcs, plus alternate calls to get their totals (with - * and without style available). Reformatted. - * - * Revision 1.44 2005/01/29 20:24:23 pdoubleya Clean/reformat code. Removed - * commented blocks, checked copyright. - * - * Revision 1.43 2005/01/24 22:46:42 pdoubleya Added support for ident-checks - * using IdentValue instead of string comparisons. - * - * Revision 1.42 2005/01/24 19:01:03 pdoubleya Mass checkin. Changed to use - * references to CSSName, which now has a Singleton instance for each property, - * everywhere property names were being used before. Removed commented code. - * Cascaded and Calculated style now store properties in arrays rather than - * maps, for optimization. - * - * Revision 1.41 2005/01/24 14:36:35 pdoubleya Mass commit, includes: updated - * for changes to property declaration instantiation, and new use of - * DerivedValue. Removed any references to older XR... classes (e.g. - * XRProperty). Cleaned imports. - * - * Revision 1.40 2005/01/16 18:50:05 tobega Re-introduced caching of styles, - * which make hamlet and alice scroll nicely again. Background painting still - * slow though. - * - * Revision 1.39 2005/01/09 15:22:50 tobega Prepared improved handling of - * margins, borders and padding. - * - * Revision 1.38 2005/01/07 00:29:29 tobega Removed Content reference from Box - * (mainly to reduce memory footprint). In the process stumbled over and cleaned - * up some messy stuff. - * - * Revision 1.37 2005/01/05 23:15:09 tobega Got rid of some redundant code for - * hover-styling - * - * Revision 1.36 2005/01/05 01:10:15 tobega Went wild with code analysis tool. - * removed unused stuff. Lucky we have CVS... - * - * Revision 1.35 2005/01/02 01:00:09 tobega Started sketching in code for - * handling replaced elements in the NamespaceHandler - * - * Revision 1.34 2004/12/29 12:57:27 tobega Trying to handle BFC:s right - * - * Revision 1.33 2004/12/28 02:15:19 tobega More cleaning. - * - * Revision 1.32 2004/12/28 01:48:24 tobega More cleaning. Magically, the - * financial report demo is starting to look reasonable, without any effort - * being put on it. - * - * Revision 1.31 2004/12/27 09:40:48 tobega Moved more styling to render stage. - * Now inlines have backgrounds and borders again. - * - * Revision 1.30 2004/12/27 07:43:32 tobega Cleaned out border from box, it can - * be gotten from current style. Is it maybe needed for dynamic stuff? - * - * Revision 1.29 2004/12/16 15:53:10 joshy fixes for absolute layout - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.28 2004/12/13 15:15:57 joshy fixed bug where inlines would pick up - * parent styles when they aren't supposed to fixed extra Xx's in printed text - * added conf boolean to turn on box outlines - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.27 2004/12/12 23:19:26 tobega Tried to get hover working. - * Something happens, but not all that's supposed to happen. - * - * Revision 1.26 2004/12/12 03:33:00 tobega Renamed x and u to avoid confusing - * IDE. But that got cvs in a twist. See if this does it - * - * Revision 1.25 2004/12/11 23:36:49 tobega Progressing on cleaning up layout - * and boxes. Still broken, won't even compile at the moment. Working hard to - * fix it, though. - * - * Revision 1.24 2004/12/11 18:18:11 tobega Still broken, won't even compile at - * the moment. Working hard to fix it, though. Replace the StyleReference - * interface with our only concrete implementation, it was a bother changing in - * two places all the time. - * - * Revision 1.23 2004/12/10 06:51:04 tobega Shamefully, I must now check in - * painfully broken code. Good news is that Layout is much nicer, and we also - * handle :before and :after, and do :first-line better than before. Table stuff - * must be brought into line, but most needed is to fix Render. IMO Render - * should work with Boxes and Content. If Render goes for a node, that is wrong. - * - * Revision 1.22 2004/12/09 21:18:53 tobega precaution: code still works - * - * Revision 1.21 2004/12/09 18:00:05 joshy fixed hover bugs fixed li's not being - * blocks bug - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.20 2004/12/05 05:22:36 joshy fixed NPEs in selection listener - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.19 2004/12/05 05:18:02 joshy made bullets be anti-aliased fixed - * bug in link listener that caused NPEs - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.18 2004/12/05 00:48:59 tobega Cleaned up so that now all - * property-lookups use the CalculatedStyle. Also added support for relative - * values of top, left, width, etc. - * - * Revision 1.17 2004/12/01 01:57:02 joshy more updates for float support. - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.16 2004/11/18 16:45:13 joshy improved the float code a bit. now - * floats are automatically forced to be blocks - * - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.15 2004/11/17 00:44:54 joshy fixed bug in the history manager - * added cursor support to the link listener - * - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.14 2004/11/15 15:20:39 joshy fixes for absolute layout - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.13 2004/11/12 20:25:18 joshy added hover support to the browser - * created hover demo fixed bug with inline borders - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.12 2004/11/12 17:05:25 joshy support for fixed positioning Issue - * number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.11 2004/11/09 02:04:23 joshy support for text-align: justify - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.10 2004/11/08 15:10:10 joshy added support for styling - * :first-letter inline boxes updated the absolute positioning tests - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.9 2004/11/07 16:23:18 joshy added support for lighten and darken - * to bordercolor added support for different colored sides - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.8 2004/11/06 22:49:52 joshy cleaned up alice initial support for - * inline borders and backgrounds moved all of inlinepainter back into - * inlinerenderer, where it belongs. - * - * - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.7 2004/11/03 23:54:34 joshy added hamlet and tables to the browser - * more support for absolute layout added absolute layout unit tests removed - * more dead code and moved code into layout factory - * - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.6 2004/11/03 15:17:05 joshy added intial support for absolute - * positioning - * - * Issue number: Obtained from: Submitted by: Reviewed by: - * - * Revision 1.5 2004/10/23 13:50:26 pdoubleya Re-formatted using JavaStyle tool. - * Cleaned imports to resolve wildcards except for common packages (java.io, - * java.util, etc). Added CVS log comments at bottom. - * - * - */ - diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java index 776a27437..d239b7008 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java @@ -77,7 +77,9 @@ public class LineBox extends Box implements InlinePaintable { private JustificationInfo _justificationInfo; private byte direction = BidiSplitter.LTR; - + + private List referencedFootnoteBodies; + public LineBox() { } @@ -681,11 +683,29 @@ public void checkPagePosition(LayoutContext c, boolean alwaysBreak) { int leastAbsY = getMinPaintingTop(); boolean needsPageBreak = - alwaysBreak || greatestAbsY >= pageBox.getBottom() - c.getExtraSpaceBottom(); + alwaysBreak || greatestAbsY >= pageBox.getBottom(c) - c.getExtraSpaceBottom(); if (needsPageBreak) { + if (hasFootnotes()) { + // Oh oh, we need to move the footnotes to the next page with + // this line. + List footnotes = getReferencedFootnoteBodies(); + pageBox.removeFootnoteBodies(c, footnotes); + } + forcePageBreakBefore(c, IdentValue.ALWAYS, false, leastAbsY); calcCanvasLocation(); + + if (hasFootnotes()) { + PageBox pageBoxAfter = c.getRootLayer().getFirstPage(c, this); + List footnotes = getReferencedFootnoteBodies(); + + for (BlockBox footnote : footnotes) { + // FIXME: Edge cases, what happens if both this line and its + // footnotes do not fit on a page? + pageBoxAfter.addFootnoteBody(c, footnote); + } + } } else if (pageBox.getTop() + c.getExtraSpaceTop() > getAbsY()) { int diff = pageBox.getTop() + c.getExtraSpaceTop() - getAbsY(); setY(getY() + diff); @@ -728,255 +748,30 @@ public boolean isEndsOnNL() { public void setEndsOnNL(boolean endsOnNL) { _isEndsOnNL = endsOnNL; } -} -/* - * $Id$ - * - * $Log$ - * Revision 1.73 2009/05/09 14:18:24 pdoubleya - * FindBugs: use of ref that is provably null - * - * Revision 1.72 2008/07/27 00:21:47 peterbrant - * Implement CMYK color support for PDF output, starting with patch from Mykola Gurov / Banish java.awt.Color from FS core layout classes - * - * Revision 1.71 2008/02/11 17:52:25 peterbrant - * Fix divide by zero error in justification algorithm - * - * Revision 1.70 2008/01/26 01:53:44 peterbrant - * Implement partial support for leader and target-counter (patch from Karl Tauber) - * - * Revision 1.69 2007/08/30 23:14:28 peterbrant - * Implement text-align: justify - * - * Revision 1.68 2007/08/29 22:18:18 peterbrant - * Experiment with text justification - * - * Revision 1.67 2007/08/28 22:31:26 peterbrant - * Implement widows and orphans properties - * - * Revision 1.66 2007/08/19 22:22:49 peterbrant - * Merge R8pbrant changes to HEAD - * - * Revision 1.65.2.6 2007/08/16 22:38:47 peterbrant - * Further progress on table pagination - * - * Revision 1.65.2.5 2007/08/15 21:29:30 peterbrant - * Initial draft of support for running headers and footers on tables - * - * Revision 1.65.2.4 2007/08/14 16:10:30 peterbrant - * Remove obsolete code - * - * Revision 1.65.2.3 2007/08/13 22:41:13 peterbrant - * First pass at exporting the render tree as text - * - * Revision 1.65.2.2 2007/08/07 17:06:32 peterbrant - * Implement named pages / Implement page-break-before/after: left/right / Experiment with efficient selection - * - * Revision 1.65.2.1 2007/07/30 00:43:15 peterbrant - * Start implementing text selection and copying - * - * Revision 1.65 2007/05/16 15:44:37 peterbrant - * inline-block/inline-table elements that take up no space should not be considered visible content - * - * Revision 1.64 2007/05/10 00:43:55 peterbrant - * Empty inline elements should generate boxes and participate in line height calculations - * - * Revision 1.63 2007/03/12 21:11:20 peterbrant - * Documentation update - * - * Revision 1.62 2007/03/07 17:15:16 peterbrant - * Minor fixes to dump() method - * - * Revision 1.61 2007/02/28 18:16:29 peterbrant - * Support multiple values for text-decoration (per spec) - * - * Revision 1.60 2007/02/22 15:52:46 peterbrant - * Restyle generated content correctly (although the CSS matcher needs more - * work before restyle with generated content and dynamic pseudo classes will work) - * - * Revision 1.59 2007/02/21 23:11:02 peterbrant - * Correct margin edge calculation (as it turns out the straightforward approach is also the correct one) - * - * Revision 1.58 2007/02/19 14:53:36 peterbrant - * Integrate new CSS parser - * - * Revision 1.57 2007/02/07 16:33:22 peterbrant - * Initial commit of rewritten table support and associated refactorings - * - * Revision 1.56 2006/08/29 17:29:12 peterbrant - * Make Style object a thing of the past - * - * Revision 1.55 2006/08/27 00:36:36 peterbrant - * Initial commit of (initial) R7 work - * - * Revision 1.54 2006/04/02 22:22:34 peterbrant - * Add function interface for generated content / Implement page counters in terms of this, removing previous hack / Add custom page numbering functions - * - * Revision 1.53 2006/03/01 00:45:02 peterbrant - * Provide LayoutContext when calling detach() and friends - * - * Revision 1.52 2006/02/22 02:20:19 peterbrant - * Links and hover work again - * - * Revision 1.51 2006/02/05 01:57:23 peterbrant - * Fix bug where final space on the final line of a block was not being collapsed away - * - * Revision 1.50 2006/02/03 23:57:53 peterbrant - * Implement counter(page) and counter(pages) / Bug fixes to alignment calculation - * - * Revision 1.49 2006/01/27 01:15:33 peterbrant - * Start on better support for different output devices - * - * Revision 1.48 2006/01/11 22:16:05 peterbrant - * Fix NPE when clip region is null - * - * Revision 1.47 2006/01/03 17:04:50 peterbrant - * Many pagination bug fixes / Add ability to position absolute boxes in margin area - * - * Revision 1.46 2006/01/01 03:14:24 peterbrant - * Implement page-break-inside: avoid - * - * Revision 1.45 2006/01/01 02:38:18 peterbrant - * Merge more pagination work / Various minor cleanups - * - * Revision 1.44 2005/12/21 02:36:28 peterbrant - * - Calculate absolute positions incrementally (prep work for pagination) - * - Light cleanup - * - Fix bug where floats nested in floats could cause the outer float to be positioned in the wrong place - * - * Revision 1.43 2005/12/15 20:04:47 peterbrant - * Implement visibility: hidden - * - * Revision 1.42 2005/12/14 15:03:12 peterbrant - * Revert ill-advised text-decoration change - * - * Revision 1.41 2005/12/13 20:46:04 peterbrant - * Improve list support (implement list-style-position: inside, marker "sticks" to first line box even if there are other block boxes in between, plus other minor fixes) / Experimental support for optionally extending text decorations to box edge vs line edge - * - * Revision 1.40 2005/12/13 02:41:32 peterbrant - * Initial implementation of vertical-align: top/bottom (not done yet) / Minor cleanup and optimization - * - * Revision 1.39 2005/12/09 21:41:18 peterbrant - * Finish support for relative inline layers - * - * Revision 1.38 2005/12/09 01:24:55 peterbrant - * Initial commit of relative inline layers - * - * Revision 1.37 2005/12/07 20:34:45 peterbrant - * Remove unused fields/methods from RenderingContext / Paint line content using absolute coords (preparation for relative inline layers) - * - * Revision 1.36 2005/11/29 16:39:04 peterbrant - * Complete line box clip region checking - * - * Revision 1.35 2005/11/29 15:26:16 peterbrant - * Implement text-decoration - * - * Revision 1.34 2005/11/29 03:12:25 peterbrant - * Fix clip region checking when a line contains an inline-block - * - * Revision 1.33 2005/11/29 02:37:23 peterbrant - * Make clear work again / Rip out old pagination code - * - * Revision 1.32 2005/11/25 22:42:05 peterbrant - * Wait until table has completed layout before doing line alignment - * - * Revision 1.31 2005/11/25 16:57:17 peterbrant - * Initial commit of inline content refactoring - * - * Revision 1.30 2005/11/12 21:55:27 tobega - * Inline enhancements: block box text decorations, correct line-height when it is a number, better first-letter handling - * - * Revision 1.29 2005/11/11 16:45:29 tobega - * Fixed vertical align calculations to use line-height properly - * - * Revision 1.28 2005/11/09 22:33:18 tobega - * fixed handling of first-line-style - * - * Revision 1.27 2005/11/08 20:03:56 peterbrant - * Further progress on painting order / improved positioning implementation - * - * Revision 1.26 2005/11/07 00:07:35 tobega - * Got text-decoration and relative inlines kind-of working - * - * Revision 1.25 2005/11/04 02:43:11 tobega - * Inline borders and backgrounds are back! - * - * Revision 1.24 2005/11/03 17:58:40 peterbrant - * Float rewrite (still stomping bugs, but demos work) - * - * Revision 1.23 2005/10/29 22:31:02 tobega - * House-cleaning - * - * Revision 1.22 2005/10/27 00:09:04 tobega - * Sorted out Context into RenderingContext and LayoutContext - * - * Revision 1.21 2005/10/16 23:57:17 tobega - * Starting experiment with flat representation of render tree - * - * Revision 1.20 2005/10/12 21:17:14 tobega - * patch from Peter Brant - * - * Revision 1.19 2005/10/08 17:40:21 tobega - * Patch from Peter Brant - * - * Revision 1.18 2005/10/06 03:20:23 tobega - * Prettier incremental rendering. Ran into more trouble than expected and some creepy crawlies and a few pages don't look right (forms.xhtml, splash.xhtml) - * - * Revision 1.17 2005/08/06 22:12:24 tobega - * Fixed issue 110 - * - * Revision 1.16 2005/07/14 22:25:17 joshy - * major updates to float code. should fix *most* issues. - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.15 2005/05/09 23:47:15 tobega - * Cleaned up some getting of LineMetrics and optimized InlineRendering - * - * Revision 1.14 2005/05/08 13:02:41 tobega - * Fixed a bug whereby styles could get lost for inline elements, notably if root element was inline. Did a few other things which probably has no importance at this moment, e.g. refactored out some unused stuff. - * - * Revision 1.13 2005/01/29 20:21:04 pdoubleya - * Clean/reformat code. Removed commented blocks, checked copyright. - * - * Revision 1.12 2005/01/24 22:46:42 pdoubleya - * Added support for ident-checks using IdentValue instead of string comparisons. - * - * Revision 1.11 2005/01/10 01:58:37 tobega - * Simplified (and hopefully improved) handling of vertical-align. Added support for line-height. As always, provoked a few bugs in the process. - * - * Revision 1.10 2005/01/09 13:32:35 tobega - * Caching image components. Also fixed two bugs that were introduced fixing the last one. Code still too brittle... - * - * Revision 1.9 2005/01/09 00:29:28 tobega - * Removed XPath usages from core classes. Also happened to find and fix a layout-bug that I introduced a while ago. - * - * Revision 1.8 2005/01/06 09:49:38 tobega - * More cleanup, aiming to remove Content reference in box - * - * Revision 1.7 2005/01/05 01:10:16 tobega - * Went wild with code analysis tool. removed unused stuff. Lucky we have CVS... - * - * Revision 1.6 2004/12/29 10:39:35 tobega - * Separated current state Context into LayoutContext and the rest into SharedContext. - * - * Revision 1.5 2004/12/15 00:53:40 tobega - * Started playing a bit with inline box, provoked a few nasties, probably created some, seems to work now - * - * Revision 1.4 2004/12/12 03:33:01 tobega - * Renamed x and u to avoid confusing IDE. But that got cvs in a twist. See if this does it - * - * Revision 1.3 2004/12/10 06:51:05 tobega - * Shamefully, I must now check in painfully broken code. Good news is that Layout is much nicer, and we also handle :before and :after, and do :first-line better than before. Table stuff must be brought into line, but most needed is to fix Render. IMO Render should work with Boxes and Content. If Render goes for a node, that is wrong. - * - * Revision 1.2 2004/10/23 13:50:27 pdoubleya - * Re-formatted using JavaStyle tool. - * Cleaned imports to resolve wildcards except for common packages (java.io, java.util, etc). - * Added CVS log comments at bottom. - * - * - */ + /** + * Gets the list of footnote bodies which have calls in this line + * of text. Useful for moving those footnotes when this line is moved + * to a new page. + */ + public List getReferencedFootnoteBodies() { + return referencedFootnoteBodies; + } + /** + * See {@link #getReferencedFootnoteBodies()} + */ + public boolean hasFootnotes() { + return referencedFootnoteBodies != null; + } + + /** + * See {@link #getReferencedFootnoteBodies()} + */ + public void addReferencedFootnoteBody(BlockBox footnoteBody) { + if (referencedFootnoteBodies == null) { + referencedFootnoteBodies = new ArrayList<>(2); + } + referencedFootnoteBodies.add(footnoteBody); + } +} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java index c8634a0c9..0be641dbf 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java @@ -27,7 +27,6 @@ import java.util.Iterator; import java.util.List; import org.w3c.dom.Element; -import org.w3c.dom.Node; import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; @@ -48,7 +47,9 @@ import com.openhtmltopdf.layout.LayoutContext; import com.openhtmltopdf.newtable.TableBox; import com.openhtmltopdf.render.simplepainter.SimplePainter; +import com.openhtmltopdf.util.BoxUtil; import com.openhtmltopdf.util.LambdaUtil; +import com.openhtmltopdf.util.OpenUtil; import com.openhtmltopdf.util.ThreadCtx; public class PageBox { @@ -238,10 +239,40 @@ public void setStyle(CalculatedStyle style) { _style = style; } + /** + * Gets the document Y position in top down units (20 per CSS pixel for PDF) + *

      + * Example: If each page is 500px high and has a 50px margin, then if this is called + * on the second page it will return 16_000, which is 2 x 400px x 20. + *

      + * Note: Does not take into account footnotes and any other float: bottom + * content. For this, you can use {@link #getBottomUsable()}. + *

      + * Important: Prefer {@link #getBottom(CssContext)} over this method. + */ public int getBottom() { return _bottom; } + /** + * Gets the document Y position taking into account float: bottom + * content such as footnotes. When laying in-flow content we use this method + * while when in footnotes we use {@link #getBottom()}. + *

      + * Important: Prefer {@link #getBottom(CssContext)} over this method. + */ + public int getBottomUsable() { + return _bottom - _totalFootnoteHeight; + } + + /** + * If we are in a footnote calls {@link #getBottom()}, otherwise uses + * {@link #getBottomUsable()}. + */ + public int getBottom(CssContext c) { + return c.isInFloatBottom() ? getBottom() : getBottomUsable(); + } + public int getTop() { return _top; } @@ -444,11 +475,19 @@ public void paintMarginAreas(RenderingContext c, int additionalClearance, short currentMarginAreaContainer = null; } + /** + * Paint the footnote area layer if it exists. + */ public void paintFootnoteArea(RenderingContext c) { - int start = getHeight(c) - (_totalFootnoteHeight + getMarginBorderPadding(c, CalculatedStyle.BOTTOM)); - int x = getMarginBorderPadding(c, CalculatedStyle.LEFT); - if (_footnoteArea != null) { + Box body = BoxUtil.getBodyOrNull(c.getRootLayer().getMaster()); + int start = getHeight(c) - (_totalFootnoteHeight + getMarginBorderPadding(c, CalculatedStyle.BOTTOM)); + int x = getMarginBorderPadding(c, CalculatedStyle.LEFT); + + if (body != null) { + x += body.getMarginBorderPadding(c, CalculatedStyle.LEFT); + } + // FIXME: Wrong StructureType here. Object token = c.getOutputDevice().startStructure(StructureType.RUNNING, _footnoteArea); @@ -456,6 +495,8 @@ public void paintFootnoteArea(RenderingContext c) { _footnoteArea.setAbsY(start); _footnoteArea.calcChildLocations(); + // SimplePainter paints everything in the layer by + // assuming it is all on this page. SimplePainter painter = new SimplePainter(0, 0); painter.paintLayer(c, _footnoteArea.getLayer()); @@ -882,77 +923,53 @@ public Point getPaintingPosition( } } + /** - * Looks at the children of root. - * @return The body element, last element child of - * root or root in order of preference. + * Sets up the footnote area for this page. */ - private Element getBodyElement(Element root) { - Node child = root.getFirstChild(); - Element body = null; - - while (child != null) { - if (child instanceof Element) { - body = (Element) child; - if (child.getNodeName().equals("body")) { - return body; - } - } - child = child.getNextSibling(); - } - - return body != null ? body : root; - } - - private Box getBodyBox(Box root) { - Box secondBest = null; - for (Box child : root.getChildren()) { - if (child.getElement() != null && child.getElement().getNodeName().equals("body")) { - return child; - } - secondBest = child; - } - - return secondBest != null ? secondBest : root; - } - - private int firstNonZero(int... values) { - for (int value : values) { - if (value != 0) { - return value; - } - } - return 0; - } - private void createFootnoteArea(LayoutContext c) { + // Create style from @footnote page rules with absolute + // positioning and block display. CalculatedStyle style = new EmptyStyle().deriveStyle( _pageInfo.createFootnoteAreaStyle()); Box rootBox = c.getRootLayer().getMaster(); Element root = rootBox.getElement(); + + // We get a NPE if our new BlockBox doesn't have an element + // so just create one. Element me = root.getOwnerDocument().createElement("fs-footnote"); - Element body = getBodyElement(root); + Element body = BoxUtil.getBodyElementOrSomething(root); body.appendChild(me); - Box bodyBox = getBodyBox(c.getRootLayer().getMaster()); - int containingBlockWidth = - firstNonZero(bodyBox.getContentWidth(), bodyBox.getWidth(), + Box bodyBox = BoxUtil.getBodyBoxOrSomething(c.getRootLayer().getMaster()); + int containingBlockWidth = OpenUtil.firstNonZero( + bodyBox.getContentWidth(), bodyBox.getWidth(), rootBox.getContentWidth(), rootBox.getWidth(), getContentWidth(c), getWidth(c)); _footnoteArea = new BlockBox(); _footnoteArea.setContainingBlock(new ViewportBox(new Rectangle(0, 0, containingBlockWidth, 0))); _footnoteArea.setStyle(style); + + // For now we make sure all footnote bodies have block display. _footnoteArea.setChildrenContentType(BlockBox.CONTENT_BLOCK); _footnoteArea.setElement(me); + // Create an isolated layer, not connected to any other layers. + // This means we have to explicitly paint it. See #paintFootnoteArea. Layer footnoteLayer = new Layer(_footnoteArea, c, true); _footnoteArea.setLayer(footnoteLayer); _footnoteArea.setContainingLayer(footnoteLayer); } + /** + * Set the containing layer of all descendants. + *

      + * This means that the descendants can not have layers of their own, + * meaning no absolute, fixed or transforms. + */ private void correctLayer(Box parent, Layer l) { LambdaUtil.descendants(parent) .forEach(box -> { @@ -961,7 +978,16 @@ private void correctLayer(Box parent, Layer l) { }); } + /** + * Adds a footnote body to this page, creating the footnote area as required. + *

      + * Important: This changes the page break point by expanding the footnote area. + */ public void addFootnoteBody(LayoutContext c, BlockBox footnoteBody) { + // We need to know that we are in the footnote area during layout so we + // know which page bottom to use. + c.setIsInFloatBottom(true); + if (_footnoteArea == null) { createFootnoteArea(c); } @@ -978,5 +1004,45 @@ public void addFootnoteBody(LayoutContext c, BlockBox footnoteBody) { correctLayer(_footnoteArea, _footnoteArea.getLayer()); _totalFootnoteHeight = _footnoteArea.getHeight(); + + c.setIsInFloatBottom(false); + } + + /** + * Removes footnotes from a page. This is used when a line is moved to a + * new page. We remove from first page and add to the next. + */ + public void removeFootnoteBodies(LayoutContext c, List footnoteBodies) { + if (_footnoteArea != null) { + for (BlockBox footnote : footnoteBodies) { + _footnoteArea.removeChild(footnote); + } + + if (_footnoteArea.getChildCount() > 0) { + c.setIsInFloatBottom(true); + + _footnoteArea.layout(c); + + correctLayer(_footnoteArea, _footnoteArea.getLayer()); + + // TODO: Test this thoroughly, an unstable page break point + // at this stage may prove problematic! + // Confirmed - breaks layout. + //_totalFootnoteHeight = _footnoteArea.getHeight(); + + c.setIsInFloatBottom(false); + } else { + _footnoteArea = null; + //_totalFootnoteHeight = 0; + } + } + } + + /** + * Checks if this page has footnotes. May change if we have to move footnotes + * to subsequent page. + */ + public boolean hasFootnotes() { + return _footnoteArea != null; } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java index a28cf05f3..6922af355 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java @@ -54,7 +54,9 @@ public class RenderingContext implements CssContext, Cloneable { private boolean isFastRenderer = false; private boolean inPageMargins = false; - + + private boolean _isInFloatBottom; + /** * needs a new instance every run */ @@ -108,7 +110,7 @@ public TextRenderer getTextRenderer() { } private BidiReorderer _bidi = new SimpleBidiReorderer(); - + public void setBidiReorderer(BidiReorderer bidi) { this._bidi = bidi; } @@ -292,5 +294,19 @@ public Object clone() { return null; } } + + /** + * See {@link #isInFloatBottom()} + */ + public void setIsInFloatBottom(boolean inFloatBottom) { + _isInFloatBottom = inFloatBottom; + } + + /** + * {@inheritDoc} + */ + public boolean isInFloatBottom() { + return _isInFloatBottom; + } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/BoxUtil.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/BoxUtil.java new file mode 100644 index 000000000..76f85aad1 --- /dev/null +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/BoxUtil.java @@ -0,0 +1,64 @@ +package com.openhtmltopdf.util; + +import org.w3c.dom.Element; +import org.w3c.dom.Node; + +import com.openhtmltopdf.render.Box; + +public class BoxUtil { + /** + * Looks at the children of root. + * + * @return The body element, last element child of + * root or root in order of preference. + */ + public static Element getBodyElementOrSomething(Element root) { + Node child = root.getFirstChild(); + Element body = null; + + while (child != null) { + if (child instanceof Element) { + body = (Element) child; + if (child.getNodeName().equals("body")) { + return body; + } + } + child = child.getNextSibling(); + } + + return body != null ? body : root; + } + + private static boolean isBody(Box child) { + return child.getElement() != null && child.getElement().getNodeName().equals("body"); + } + + /** + * @return body box, last child of root or root in order of preference. + */ + public static Box getBodyBoxOrSomething(Box root) { + Box secondBest = null; + for (Box child : root.getChildren()) { + if (isBody(child)) { + return child; + } + secondBest = child; + } + + return secondBest != null ? secondBest : root; + } + + /** + * Looks at the direct children of root to find one with an element with + * node name body. + */ + public static Box getBodyOrNull(Box root) { + for (Box child : root.getChildren()) { + if (isBody(child)) { + return child; + } + } + + return null; + } +} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/OpenUtil.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/OpenUtil.java index e796f6c87..3b097267d 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/OpenUtil.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/OpenUtil.java @@ -65,4 +65,17 @@ public static Integer parseIntegerOrNull(String possibleInteger) { return null; } } + + /** + * First non-zero value or zero if none. + */ + public static int firstNonZero(int... values) { + for (int value : values) { + if (value != 0) { + return value; + } + } + return 0; + } + } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html index 86483e06d..403297a78 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html @@ -2,15 +2,13 @@ + + +

      + This is some text in a paragraph. + Not very exciting text. + More text, hopefully it shows the wrapping. + We need wrapping for this test so this is a very long footnote! + Even more text. +

      + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index 7be3c270f..dee39a666 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -32,6 +32,7 @@ import org.apache.pdfbox.pdmodel.common.PDRectangle; import org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo; import org.apache.pdfbox.pdmodel.interactive.action.PDActionURI; +import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation; import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment; import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink; import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget; @@ -439,7 +440,45 @@ public void testLinkOnOverflowTarget() throws IOException { remove("link-on-overflow-target", doc); } - + + /** + * Tests that ::footnote-call links are placed correctly and link + * to the correct ::footnote-marker. + */ + @Test + public void testIssue364FootnoteCallLink() throws IOException { + try (PDDocument doc = run("issue-364-footnote-call-link")) { + List annots0 = doc.getPage(0).getAnnotations(); + List annots1 = doc.getPage(1).getAnnotations(); + + assertEquals(1, annots0.size()); + assertEquals(1, annots1.size()); + + PDAnnotationLink link0 = (PDAnnotationLink) annots0.get(0); + PDAnnotationLink link1 = (PDAnnotationLink) annots1.get(0); + + assertEquals(106.5f, link0.getRectangle().getLowerLeftX(), 0.5f); + assertEquals(141.5f, link0.getRectangle().getLowerLeftY(), 0.5f); + assertEquals(15.7f, link0.getRectangle().getWidth(), 0.5f); + assertEquals(15.0f, link0.getRectangle().getHeight(), 0.5f); + + assertEquals(103.5f, link1.getRectangle().getLowerLeftX(), 0.5f); + assertEquals(158.9f, link1.getRectangle().getLowerLeftY(), 0.5f); + assertEquals(15.7f, link1.getRectangle().getWidth(), 0.5f); + assertEquals(15.0f, link1.getRectangle().getHeight(), 0.5f); + + PDActionGoTo goto0 = (PDActionGoTo) link0.getAction(); + PDPageXYZDestination dest0 = (PDPageXYZDestination) goto0.getDestination(); + assertEquals(51, dest0.getTop()); + + PDActionGoTo goto1 = (PDActionGoTo) link1.getAction(); + PDPageXYZDestination dest1 = (PDPageXYZDestination) goto1.getDestination(); + assertEquals(81, dest1.getTop()); + + remove("issue-364-footnote-call-link", doc); + } + } + /** * Tests that link annotation area is correctly translated-y. */ From b706ddf8e1e685bfde5a259b6028fcf49bdda79e Mon Sep 17 00:00:00 2001 From: danfickle Date: Sat, 5 Jun 2021 14:40:02 +1000 Subject: [PATCH 14/54] #364 Fix double painting of footnotes by making sure not linked to any in-flow layers. --- .../java/com/openhtmltopdf/render/Box.java | 14 +++++-- .../com/openhtmltopdf/render/PageBox.java | 41 +++++++++++++------ .../html/issue-364-footnote-call-link.html | 1 - .../html/issue-364-footnotes-basic.html | 2 +- 4 files changed, 41 insertions(+), 17 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java index 6b4f293f5..93c6418d0 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java @@ -50,7 +50,6 @@ import java.util.List; import java.util.function.Predicate; import java.util.logging.Level; -import java.util.stream.Collectors; public abstract class Box implements Styleable, DisplayListItem { protected static final String LINE_SEPARATOR = System.getProperty("line.separator"); @@ -149,7 +148,7 @@ private Box getClipParent() { /** * Gets the layer relative clip for the parent box. - * @see {@link #getClipBox(RenderingContext, Layer)} + * See {@link #getClipBox(RenderingContext, Layer)} */ public Rectangle getParentClipBox(RenderingContext c, Layer layer) { Box clipParent = getClipParent(); @@ -219,6 +218,7 @@ public int getWidth() { return getContentWidth() + getLeftMBP() + getRightMBP(); } + @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("Box: "); @@ -315,7 +315,7 @@ public Box getChild(int i) { if (_boxes == null) { throw new IndexOutOfBoundsException(); } else { - return (Box) _boxes.get(i); + return _boxes.get(i); } } @@ -694,8 +694,16 @@ public List getElementBoxes(Element elem) { return result; } + /** + * Responsible for resetting the state of the box before a repeat + * call to {@link BlockBox#layout(LayoutContext)} or other layout methods. + *

      + * Any layout operation that is not idempotent MUST be reset in this method. + * Layout may be called several times on the one box. + */ public void reset(LayoutContext c) { resetChildren(c); + if (_layer != null) { _layer.detach(); _layer = null; diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java index a2174d9e7..3a00e9372 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/PageBox.java @@ -93,6 +93,7 @@ public class PageBox { private BlockBox _footnoteArea; private int _totalFootnoteHeight; + private int _maxFootnoteHeight; public void setBasePagePdfPageIndex(int idx) { this._basePagePdfPageIndex = idx; @@ -979,9 +980,20 @@ private void createFootnoteArea(LayoutContext c) { * This means that the descendants can not have layers of their own, * meaning no absolute, fixed or transforms. */ - private void correctLayer(Box parent, Layer l) { - LambdaUtil.descendants(parent) + private void correctLayer(Layer l) { + if (_footnoteArea.getLayer() != null) { + _footnoteArea.getLayer().detach(); + } + + _footnoteArea.setLayer(l); + _footnoteArea.setContainingLayer(l); + + LambdaUtil.descendants(_footnoteArea) .forEach(box -> { + if (box.getLayer() != null) { + box.getLayer().detach(); + } + box.setLayer(null); box.setContainingLayer(l); }); @@ -1007,11 +1019,10 @@ public void addFootnoteBody(LayoutContext c, BlockBox footnoteBody) { footnoteBody.setContainingBlock(_footnoteArea.getContainingBlock()); _footnoteArea.addChild(footnoteBody); + Layer layer = _footnoteArea.getLayer(); + if (!createdArea) { - Layer layer = _footnoteArea.getLayer(); _footnoteArea.reset(c); - _footnoteArea.setLayer(layer); - _footnoteArea.setContainingLayer(layer); } else { footnoteBody.reset(c); } @@ -1020,11 +1031,13 @@ public void addFootnoteBody(LayoutContext c, BlockBox footnoteBody) { // is added. _footnoteArea.layout(c); + // FIXME: The layer for _footnoteArea may swap around in BlockBox::layout // so just fix up all descendants to point to the correct layer. - correctLayer(_footnoteArea, _footnoteArea.getLayer()); + correctLayer(layer); _totalFootnoteHeight = _footnoteArea.getHeight(); + _maxFootnoteHeight = Math.max(_maxFootnoteHeight, _totalFootnoteHeight); c.setIsInFloatBottom(false); } @@ -1040,20 +1053,24 @@ public void removeFootnoteBodies(LayoutContext c, List footnoteBodies) if (_footnoteArea.getChildCount() > 0) { c.setIsInFloatBottom(true); + Layer layer = _footnoteArea.getLayer(); + _footnoteArea.reset(c); _footnoteArea.layout(c); - correctLayer(_footnoteArea, _footnoteArea.getLayer()); + correctLayer(layer); - // TODO: Test this thoroughly, an unstable page break point - // at this stage may prove problematic! - // Confirmed - breaks layout. - //_totalFootnoteHeight = _footnoteArea.getHeight(); + _totalFootnoteHeight = _footnoteArea.getHeight(); + _maxFootnoteHeight = Math.max(_maxFootnoteHeight, _totalFootnoteHeight); c.setIsInFloatBottom(false); } else { + if (_footnoteArea.getLayer() != null) { + _footnoteArea.getLayer().detach(); + } + _footnoteArea = null; - //_totalFootnoteHeight = 0; + _totalFootnoteHeight = 0; } } } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnote-call-link.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnote-call-link.html index 70c0f3690..74733ee73 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnote-call-link.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnote-call-link.html @@ -2,7 +2,6 @@ + + +

      + Some text for page one. More text to overflow to page two. + One two three four five six seven eight nine ten eleven twelve thirteen +

      + +

      + thirty fourty fifty sixty seventy eighty ninety + +
      + fn1 + + + This is a very long footnote that will need wrapping. Someone once said + about footnotes that they are hard to implement! + We need another few lines to go over an entire page and a half to demonstrate + what happens with multi-page footnotes. + + + fn2 + + + start second footnote eleven twelve thirteen fourteen fifteen sixteen + seventeen eighteen nineteen twenty thirty fourty fifty sixty seventy + eighty ninety hundred footnote note foot lorem ipsum + etc start again one two three four five six seven eight + nine ten end. + +

      + +

      + Last page content. This is to make sure text after multi-page footnotes works. + Some more content. Even more. +

      + + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index f30d6feb0..82f84e068 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1422,6 +1422,15 @@ public void testIssue364FootnotesBasicExample() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-basic")); } + /** + * Tests that a line of text can contain two multi-page footnotes. + */ + @Test + @Ignore // Not perfect yet. + public void testIssue364FootnotesMultiPage() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-multi-page")); + } + // TODO: // + Elements that appear just on generated overflow pages. // + content property (page counters, etc) From 04ff3729bbab748b365baf2b102e5396a5c4620f Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 7 Jun 2021 23:54:46 +1000 Subject: [PATCH 17/54] #364 Cleanup and documentation. --- .../css/style/derived/RectPropertySet.java | 9 +- .../com/openhtmltopdf/layout/BlockBoxing.java | 10 +- .../com/openhtmltopdf/layout/BoxBuilder.java | 26 +- .../openhtmltopdf/layout/FootnoteManager.java | 2 +- .../java/com/openhtmltopdf/layout/Layer.java | 78 ++- .../openhtmltopdf/newtable/TableCellBox.java | 7 +- .../openhtmltopdf/newtable/TableRowBox.java | 10 +- .../com/openhtmltopdf/render/BlockBox.java | 653 +++++------------- .../java/com/openhtmltopdf/render/Box.java | 49 +- .../openhtmltopdf/render/InlineLayoutBox.java | 23 +- .../com/openhtmltopdf/render/LineBox.java | 17 +- .../com/openhtmltopdf/util/SearchUtil.java | 43 ++ 12 files changed, 397 insertions(+), 530 deletions(-) create mode 100644 openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/SearchUtil.java diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/RectPropertySet.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/RectPropertySet.java index e1f2d6314..c95df1d44 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/RectPropertySet.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/RectPropertySet.java @@ -56,7 +56,14 @@ public static RectPropertySet newInstance( @Override public String toString() { - return "RectPropertySet[top=" + _top + ",right=" + _right + ",bottom=" + _bottom + ",left=" + _left + "]"; + return toString("RectPropertySet"); + } + + /** + * Returns the four values prepended with name. + */ + public String toString(String name) { + return name + "[top=" + _top + ",right=" + _right + ",bottom=" + _bottom + ",left=" + _left + "]"; } public float top() { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java index c04ba3502..6a3f93fc4 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java @@ -32,6 +32,7 @@ import com.openhtmltopdf.render.Box; import com.openhtmltopdf.render.LineBox; import com.openhtmltopdf.render.PageBox; +import com.openhtmltopdf.render.BlockBox.ContentType; /** * Utility class for laying block content. It is called when a block box @@ -48,6 +49,10 @@ public class BlockBoxing { private BlockBoxing() { } + /** + * Lays out a {@link BlockBox} where {@link BlockBox#getChildrenContentType()} is + * {@link ContentType#BLOCK}. + */ public static void layoutContent(LayoutContext c, BlockBox block, int contentStart) { int offset = -1; @@ -65,13 +70,14 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta int pageCount = NO_PAGE_TRIM; BlockBox previousChildBox = null; + for (Iterator i = localChildren.iterator(); i.hasNext();) { BlockBox child = (BlockBox) i.next(); offset++; RelayoutData relayoutData = null; - boolean mayCheckKeepTogether = false; + if (c.isPrint()) { relayoutData = relayoutDataList.get(offset); relayoutData.setLayoutState(c.copyStateForRelayout()); @@ -93,10 +99,12 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta if (c.isPrint()) { boolean needPageClear = child.isNeedPageClear(); + if (needPageClear || mayCheckKeepTogether) { c.setMayCheckKeepTogether(mayCheckKeepTogether); boolean tryToAvoidPageBreak = child.getStyle().isAvoidPageBreakInside() && child.crossesPageBreak(c); boolean keepWithInline = child.isNeedsKeepWithInline(c); + if (tryToAvoidPageBreak || needPageClear || keepWithInline) { c.restoreStateForRelayout(relayoutData.getLayoutState()); child.reset(c); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index ffe43a5a1..bf298b38e 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -124,7 +124,7 @@ public static void createChildren(LayoutContext c, BlockBox parent) { if (parent.shouldBeReplaced()) { // Don't create boxes for elements in a SVG element. // This avoids many warnings and improves performance. - parent.setChildrenContentType(BlockBox.CONTENT_EMPTY); + parent.setChildrenContentType(BlockBox.ContentType.EMPTY); return; } @@ -189,14 +189,14 @@ public static TableBox createMarginTable( result.setStyle(tableStyle); result.setElement(source); result.setAnonymous(true); - result.setChildrenContentType(BlockBox.CONTENT_BLOCK); + result.setChildrenContentType(BlockBox.ContentType.BLOCK); CalculatedStyle tableSectionStyle = pageStyle.createAnonymousStyle(IdentValue.TABLE_ROW_GROUP); TableSectionBox section = (TableSectionBox)createBlockBox(tableSectionStyle, info, false); section.setStyle(tableSectionStyle); section.setElement(source); section.setAnonymous(true); - section.setChildrenContentType(BlockBox.CONTENT_BLOCK); + section.setChildrenContentType(BlockBox.ContentType.BLOCK); result.addChild(section); @@ -207,7 +207,7 @@ public static TableBox createMarginTable( row.setStyle(tableRowStyle); row.setElement(source); row.setAnonymous(true); - row.setChildrenContentType(BlockBox.CONTENT_BLOCK); + row.setChildrenContentType(BlockBox.ContentType.BLOCK); row.setHeightOverride(height); @@ -228,7 +228,7 @@ public static TableBox createMarginTable( row.setStyle(tableRowStyle); row.setElement(source); row.setAnonymous(true); - row.setChildrenContentType(BlockBox.CONTENT_BLOCK); + row.setChildrenContentType(BlockBox.ContentType.BLOCK); row.setHeightOverride(height); @@ -314,18 +314,18 @@ private static void resolveChildren( if (info.isContainsBlockLevelContent()) { insertAnonymousBlocks( c.getSharedContext(), owner, children, info.isLayoutRunningBlocks()); - owner.setChildrenContentType(BlockBox.CONTENT_BLOCK); + owner.setChildrenContentType(BlockBox.ContentType.BLOCK); } else { WhitespaceStripper.stripInlineContent(children); if (children.size() > 0) { owner.setInlineContent(children); - owner.setChildrenContentType(BlockBox.CONTENT_INLINE); + owner.setChildrenContentType(BlockBox.ContentType.INLINE); } else { - owner.setChildrenContentType(BlockBox.CONTENT_EMPTY); + owner.setChildrenContentType(BlockBox.ContentType.EMPTY); } } } else { - owner.setChildrenContentType(BlockBox.CONTENT_EMPTY); + owner.setChildrenContentType(BlockBox.ContentType.EMPTY); } } @@ -595,7 +595,7 @@ private static BlockBox reorderTableContent(LayoutContext c, TableBox table) { anonBox.setFromCaptionedTable(true); anonBox.setElement(table.getElement()); - anonBox.setChildrenContentType(BlockBox.CONTENT_BLOCK); + anonBox.setChildrenContentType(BlockBox.ContentType.BLOCK); anonBox.addAllChildren(topCaptions); anonBox.addChild(table); anonBox.addAllChildren(bottomCaptions); @@ -1070,7 +1070,7 @@ private static List wrapGeneratedContent(Element element, String peNa BlockBox result = createBlockBox(style, info, true); result.setStyle(anonStyle); result.setElement(element); - result.setChildrenContentType(BlockBox.CONTENT_INLINE); + result.setChildrenContentType(BlockBox.ContentType.INLINE); result.setPseudoElementOrClass(peName); CalculatedStyle anon = style.createAnonymousStyle(IdentValue.INLINE); @@ -1114,7 +1114,7 @@ private static List wrapGeneratedContent(Element element, String peNa result.setStyle(style); result.setInlineContent(inlineBoxes); result.setElement(element); - result.setChildrenContentType(BlockBox.CONTENT_INLINE); + result.setChildrenContentType(BlockBox.ContentType.INLINE); result.setPseudoElementOrClass(peName); if (! style.isLayedOutInInlineContext()) { @@ -1670,7 +1670,7 @@ private static void createAnonymousBlock(SharedContext c, Box parent, List + + +
      + This is + Footnote with large text! + a div with a large font-size. +
      + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index 82f84e068..6b0d3539a 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1431,6 +1431,16 @@ public void testIssue364FootnotesMultiPage() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-multi-page")); } + /** + * Test what happens when a line of in-flow text and a line of footnotes + * do not fit on a single page. + */ + @Test + @Ignore // Working well but waiting until footnote support is complete. + public void testIssue364FootnotesTooLarge() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-too-large")); + } + // TODO: // + Elements that appear just on generated overflow pages. // + content property (page counters, etc) From 541545e20a7e85ab730142d2ef9a01185ff032f6 Mon Sep 17 00:00:00 2001 From: danfickle Date: Thu, 10 Jun 2021 17:41:58 +1000 Subject: [PATCH 21/54] #364 Failing test for blocks in footnotes. Plus: + Overhauled BlockBoxing while trying to fix issue. Now better performance and cleaner code. + Added benchmarks for BlockBoxing. --- .../com/openhtmltopdf/layout/BlockBoxing.java | 319 +++++++++--------- .../openhtmltopdf/layout/InlineBoxing.java | 7 +- .../openhtmltopdf/layout/LayoutContext.java | 75 ++-- .../com/openhtmltopdf/layout/LayoutState.java | 130 ++++--- .../openhtmltopdf/layout/StyleTracker.java | 65 ++-- .../com/openhtmltopdf/render/BlockBox.java | 12 +- .../benchmark/RenderTextBenchmark.java | 41 ++- .../performance/PerformanceCaseGenerator.java | 60 +++- .../html/issue-364-footnotes-blocks.html | 70 ++++ .../VisualRegressionTest.java | 10 +- 10 files changed, 517 insertions(+), 272 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java index 6a3f93fc4..b69e863fd 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java @@ -21,10 +21,8 @@ package com.openhtmltopdf.layout; import java.awt.Dimension; -import java.util.ArrayList; -import java.util.Iterator; import java.util.List; -import java.util.RandomAccess; +import java.util.TreeSet; import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; @@ -54,34 +52,33 @@ private BlockBoxing() { * {@link ContentType#BLOCK}. */ public static void layoutContent(LayoutContext c, BlockBox block, int contentStart) { - int offset = -1; - List localChildren = block.getChildren(); - if (c.isPrint() && ! (localChildren instanceof RandomAccess)) { - localChildren = new ArrayList<>(localChildren); - } + int size = localChildren.size(); int childOffset = block.getHeight() + contentStart; - RelayoutDataList relayoutDataList = null; + AbstractRelayoutDataList relayoutDataList = null; + if (c.isPrint()) { - relayoutDataList = new RelayoutDataList(localChildren.size()); + relayoutDataList = new LiteRelayoutDataList(size); } int pageCount = NO_PAGE_TRIM; + BlockBox previousChildBox = null; - for (Iterator i = localChildren.iterator(); i.hasNext();) { - BlockBox child = (BlockBox) i.next(); - offset++; + for (int offset = 0; offset < size; offset++) { + BlockBox child = (BlockBox) localChildren.get(offset); - RelayoutData relayoutData = null; + LayoutState savedChildLayoutState = null; boolean mayCheckKeepTogether = false; if (c.isPrint()) { - relayoutData = relayoutDataList.get(offset); - relayoutData.setLayoutState(c.copyStateForRelayout()); - relayoutData.setChildOffset(childOffset); + savedChildLayoutState = c.copyStateForRelayout(); + + relayoutDataList.setLayoutState(offset, savedChildLayoutState); + relayoutDataList.setChildOffset(offset, childOffset); + pageCount = c.getRootLayer().getPages().size(); child.setNeedPageClear(false); @@ -94,28 +91,29 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta } layoutBlockChild( - c, block, child, false, childOffset, NO_PAGE_TRIM, - relayoutData == null ? null : relayoutData.getLayoutState()); + c, block, child, false, childOffset, NO_PAGE_TRIM, savedChildLayoutState); if (c.isPrint()) { boolean needPageClear = child.isNeedPageClear(); if (needPageClear || mayCheckKeepTogether) { c.setMayCheckKeepTogether(mayCheckKeepTogether); + boolean tryToAvoidPageBreak = child.getStyle().isAvoidPageBreakInside() && child.crossesPageBreak(c); boolean keepWithInline = child.isNeedsKeepWithInline(c); if (tryToAvoidPageBreak || needPageClear || keepWithInline) { - c.restoreStateForRelayout(relayoutData.getLayoutState()); + c.restoreStateForRelayout(savedChildLayoutState); + child.reset(c); layoutBlockChild( - c, block, child, true, childOffset, pageCount, relayoutData.getLayoutState()); + c, block, child, true, childOffset, pageCount, savedChildLayoutState); if (tryToAvoidPageBreak && child.crossesPageBreak(c) && ! keepWithInline) { - c.restoreStateForRelayout(relayoutData.getLayoutState()); + c.restoreStateForRelayout(savedChildLayoutState); child.reset(c); layoutBlockChild( - c, block, child, false, childOffset, pageCount, relayoutData.getLayoutState()); + c, block, child, false, childOffset, pageCount, savedChildLayoutState); } } } @@ -143,14 +141,15 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta } if (previousChildBox != null) { - relayoutDataList.markRun(offset, previousChildBox, child); + relayoutDataList.configureRun(offset, previousChildBox, child); } - RelayoutRunResult runResult = - processPageBreakAvoidRun( - c, block, localChildren, offset, relayoutDataList, relayoutData, child); - if (runResult.isChanged()) { - childOffset = runResult.getChildOffset(); + Integer newChildOffset = + processPageBreakAvoidRun( + c, block, localChildren, offset, relayoutDataList, child); + + if (newChildOffset != null) { + childOffset = newChildOffset; if (childOffset > block.getHeight()) { block.setHeight(childOffset); } @@ -161,56 +160,73 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta } } - private static RelayoutRunResult processPageBreakAvoidRun(final LayoutContext c, final BlockBox block, - List localChildren, int offset, - RelayoutDataList relayoutDataList, RelayoutData relayoutData, - BlockBox childBox) { - RelayoutRunResult result = new RelayoutRunResult(); + private static Integer processPageBreakAvoidRun( + LayoutContext c, + BlockBox block, + List localChildren, + int offset, + AbstractRelayoutDataList relayoutDataList, + BlockBox childBox) { + if (offset > 0) { boolean mightNeedRelayout = false; int runEnd = -1; - if (offset == localChildren.size() - 1 && relayoutData.isEndsRun()) { + + if (offset == localChildren.size() - 1 && relayoutDataList.isEndsRun(offset)) { mightNeedRelayout = true; runEnd = offset; } else if (offset > 0) { - RelayoutData previousRelayoutData = relayoutDataList.get(offset - 1); - if (previousRelayoutData.isEndsRun()) { + if (relayoutDataList.isEndsRun(offset - 1)) { mightNeedRelayout = true; runEnd = offset - 1; } } + if (mightNeedRelayout) { int runStart = relayoutDataList.getRunStart(runEnd); + int newChildOffset; + if ( isPageBreakBetweenChildBoxes(relayoutDataList, runStart, runEnd, c, block) ) { - result.setChanged(true); block.resetChildren(c, runStart, offset); - result.setChildOffset(relayoutRun(c, localChildren, block, - relayoutDataList, runStart, offset, true)); + + newChildOffset = relayoutRun( + c, localChildren, block, + relayoutDataList, runStart, offset, true); + if ( isPageBreakBetweenChildBoxes(relayoutDataList, runStart, runEnd, c, block) ) { block.resetChildren(c, runStart, offset); - result.setChildOffset(relayoutRun(c, localChildren, block, - relayoutDataList, runStart, offset, false)); + newChildOffset = relayoutRun( + c, localChildren, block, + relayoutDataList, runStart, offset, false); } + + return Integer.valueOf(newChildOffset); } } } - return result; + + return null; } - private static boolean isPageBreakBetweenChildBoxes(RelayoutDataList relayoutDataList, + private static boolean isPageBreakBetweenChildBoxes( + AbstractRelayoutDataList relayoutDataList, int runStart, int runEnd, LayoutContext c, BlockBox block) { + for ( int i = runStart; i < runEnd; i++ ) { Box prevChild = block.getChild(i); Box nextChild = block.getChild(i+1); + // if nextChild is made of several lines, then only the first line // is relevant for "page-break-before: avoid". Box nextLine = getFirstLine(nextChild) == null ? nextChild : getFirstLine(nextChild); int prevChildEnd = prevChild.getAbsY() + prevChild.getHeight(); int nextLineEnd = nextLine.getAbsY() + nextLine.getHeight(); + if ( c.getRootLayer().crossesPageBreak(c, prevChildEnd, nextLineEnd) ) { return true; } } + return false; } @@ -225,8 +241,8 @@ private static LineBox getFirstLine(Box box) { private static int relayoutRun( LayoutContext c, List localChildren, BlockBox block, - RelayoutDataList relayoutDataList, int start, int end, boolean onNewPage) { - int childOffset = relayoutDataList.get(start).getChildOffset(); + AbstractRelayoutDataList relayoutDataList, int start, int end, boolean onNewPage) { + int childOffset = relayoutDataList.getChildOffset(start); if (onNewPage) { Box startBox = localChildren.get(start); @@ -237,44 +253,47 @@ private static int relayoutRun( // reset height of parent as it is used for Y-setting of children block.setHeight(childOffset); - for (int i = start; i <= end; i++) { BlockBox child = (BlockBox) localChildren.get(i); - - RelayoutData relayoutData = relayoutDataList.get(i); - int pageCount = c.getRootLayer().getPages().size(); - //TODO:handle run-ins. For now, treat them as blocks + LayoutState restoredChildLayoutState = relayoutDataList.getLayoutState(i); + c.restoreStateForRelayout(restoredChildLayoutState); - c.restoreStateForRelayout(relayoutData.getLayoutState()); - relayoutData.setChildOffset(childOffset); + relayoutDataList.setChildOffset(i, childOffset); boolean mayCheckKeepTogether = false; + if ((child.getStyle().isAvoidPageBreakInside() || child.getStyle().isKeepWithInline()) && c.isMayCheckKeepTogether()) { mayCheckKeepTogether = true; c.setMayCheckKeepTogether(false); } + layoutBlockChild( - c, block, child, false, childOffset, NO_PAGE_TRIM, relayoutData.getLayoutState()); + c, block, child, false, childOffset, NO_PAGE_TRIM, restoredChildLayoutState); if (mayCheckKeepTogether) { c.setMayCheckKeepTogether(true); + boolean tryToAvoidPageBreak = child.getStyle().isAvoidPageBreakInside() && child.crossesPageBreak(c); + boolean needPageClear = child.isNeedPageClear(); boolean keepWithInline = child.isNeedsKeepWithInline(c); + if (tryToAvoidPageBreak || needPageClear || keepWithInline) { - c.restoreStateForRelayout(relayoutData.getLayoutState()); + c.restoreStateForRelayout(restoredChildLayoutState); child.reset(c); + layoutBlockChild( - c, block, child, true, childOffset, pageCount, relayoutData.getLayoutState()); + c, block, child, true, childOffset, pageCount, restoredChildLayoutState); if (tryToAvoidPageBreak && child.crossesPageBreak(c) && ! keepWithInline) { - c.restoreStateForRelayout(relayoutData.getLayoutState()); + c.restoreStateForRelayout(restoredChildLayoutState); child.reset(c); + layoutBlockChild( - c, block, child, false, childOffset, pageCount, relayoutData.getLayoutState()); + c, block, child, false, childOffset, pageCount, restoredChildLayoutState); } } } @@ -282,6 +301,7 @@ private static int relayoutRun( c.getRootLayer().ensureHasPage(c, child); Dimension relativeOffset = child.getRelativeOffset(); + if (relativeOffset == null) { childOffset = child.getY() + child.getHeight(); } else { @@ -362,132 +382,125 @@ private static void repositionBox(LayoutContext c, BlockBox child, int trimmedPa } } - private static class RelayoutDataList { - private List _hints; - - public RelayoutDataList(int size) { - _hints = new ArrayList<>(size); - for (int i = 0; i < size; i++) { - _hints.add(new RelayoutData()); - } - } + /** + * If we should try to avoid a page break between two block boxes. + */ + public static boolean avoidPageBreakBetween(BlockBox previous, BlockBox current) { + IdentValue previousAfter = + previous.getStyle().getIdent(CSSName.PAGE_BREAK_AFTER); + IdentValue currentBefore = + current.getStyle().getIdent(CSSName.PAGE_BREAK_BEFORE); + + return (previousAfter == IdentValue.AVOID && currentBefore == IdentValue.AUTO) || + (previousAfter == IdentValue.AUTO && currentBefore == IdentValue.AVOID) || + (previousAfter == IdentValue.AVOID && currentBefore == IdentValue.AVOID); + } - public RelayoutData get(int index) { - return _hints.get(index); - } + private abstract static class AbstractRelayoutDataList { + abstract int getChildOffset(int boxIndex); + abstract LayoutState getLayoutState(int boxIndex); - public void markRun(int offset, BlockBox previous, BlockBox current) { - RelayoutData previousData = get(offset - 1); - RelayoutData currentData = get(offset); + abstract void setLayoutState(int boxIndex, LayoutState state); + abstract void setChildOffset(int boxIndex, int childOffset); - IdentValue previousAfter = - previous.getStyle().getIdent(CSSName.PAGE_BREAK_AFTER); - IdentValue currentBefore = - current.getStyle().getIdent(CSSName.PAGE_BREAK_BEFORE); + abstract int getRunStart(int endRunIndex); - if ((previousAfter == IdentValue.AVOID && currentBefore == IdentValue.AUTO) || - (previousAfter == IdentValue.AUTO && currentBefore == IdentValue.AVOID) || - (previousAfter == IdentValue.AVOID && currentBefore == IdentValue.AVOID)) { - if (! previousData.isInRun()) { - previousData.setStartsRun(true); - } - previousData.setInRun(true); - currentData.setInRun(true); + abstract boolean isEndsRun(int boxIndex); - if (offset == _hints.size() - 1) { - currentData.setEndsRun(true); - } - } else { - if (previousData.isInRun()) { - previousData.setEndsRun(true); - } - } - } - - public int getRunStart(int runEnd) { - int offset = runEnd; - RelayoutData current = get(offset); - if (! current.isEndsRun()) { - throw new RuntimeException("Not the end of a run"); - } - while (! current.isStartsRun()) { - current = get(--offset); - } - return offset; - } + abstract void configureRun(int boxIndex, BlockBox previous, BlockBox current); } - private static class RelayoutRunResult { - private boolean _changed; - private int _childOffset; + private static class LiteRelayoutDataList extends AbstractRelayoutDataList { + final int[] childOffsets; + final LayoutState[] layoutStates; + TreeSet runStarts; + TreeSet runEnds; - public boolean isChanged() { - return _changed; + LiteRelayoutDataList(int size) { + childOffsets = new int[size]; + layoutStates = new LayoutState[size]; } - public void setChanged(boolean changed) { - _changed = changed; + @Override + int getChildOffset(int boxIndex) { + return childOffsets[boxIndex]; } - public int getChildOffset() { - return _childOffset; + @Override + LayoutState getLayoutState(int boxIndex) { + return layoutStates[boxIndex]; } - public void setChildOffset(int childOffset) { - _childOffset = childOffset; + @Override + void setLayoutState(int boxIndex, LayoutState state) { + layoutStates[boxIndex] = state; } - } - private static class RelayoutData { - private LayoutState _layoutState; - - private boolean _startsRun; - private boolean _endsRun; - private boolean _inRun; - - private int _childOffset; - - public RelayoutData() { - } - - public boolean isEndsRun() { - return _endsRun; + @Override + void setChildOffset(int boxIndex, int childOffset) { + childOffsets[boxIndex] = childOffset; } - public void setEndsRun(boolean endsRun) { - _endsRun = endsRun; + @Override + boolean isEndsRun(int boxIndex) { + return runEnds != null && runEnds.contains(boxIndex); } - public boolean isInRun() { - return _inRun; + @Override + int getRunStart(int endRunIndex) { + return runStarts.floor(endRunIndex); } - public void setInRun(boolean inRun) { - _inRun = inRun; - } + boolean isInRun(int boxIndex) { + if (runStarts == null) { + return false; + } - public LayoutState getLayoutState() { - return _layoutState; - } + Integer lastRunStart = runStarts.floor(boxIndex); + if (lastRunStart != null) { + Integer lastRunEnd = runEnds != null ? runEnds.floor(boxIndex) : null; + return (lastRunEnd == null || lastRunEnd >= boxIndex); + } - public void setLayoutState(LayoutState layoutState) { - _layoutState = layoutState; + return false; } - public boolean isStartsRun() { - return _startsRun; + void addRunStart(int boxIndex) { + if (runStarts == null) { + runStarts = new TreeSet<>(); + } + runStarts.add(boxIndex); } - public void setStartsRun(boolean startsRun) { - _startsRun = startsRun; + void addRunEnd(int boxIndex) { + if (runEnds == null) { + runEnds = new TreeSet<>(); + } + runEnds.add(boxIndex); } - public int getChildOffset() { - return _childOffset; - } + /** + * Marks two consecutive block boxes as being in a run of boxes where + * a page break should not occur between them as set in the + * page-break-after and page-break-before + * CSS properties. + */ + @Override + public void configureRun(int offset, BlockBox previous, BlockBox current) { + boolean previousInRun = isInRun(offset - 1); + + if (avoidPageBreakBetween(previous, current)) { + if (!previousInRun) { + addRunStart(offset - 1); + } - public void setChildOffset(int childOffset) { - _childOffset = childOffset; + if (offset == childOffsets.length) { + addRunEnd(offset); + } + } else if (previousInRun) { + addRunEnd(offset - 1); + } } } + } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java index 1d8628d4d..70777abe1 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java @@ -580,7 +580,9 @@ private static InlineLayoutBox addFirstLetterBox(LayoutContext c, LineBox curren lbContext.setStart(lbContext.getEnd()); - c.getFirstLettersTracker().clearStyles(); + c.setFirstLettersTracker( + StyleTracker.withNoStyles()); + currentIB.setStyle(previous); return iB; @@ -1066,7 +1068,8 @@ private static void saveLine(LineBox current, LayoutContext c, } if (hasFirstLinePCs && current.isFirstLine()) { - c.getFirstLinesTracker().clearStyles(); + c.setFirstLinesTracker( + StyleTracker.withNoStyles()); block.styleText(c); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java index 220f8d61f..f714b66e6 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java @@ -94,6 +94,8 @@ public class LayoutContext implements CssContext { private boolean _isInFloatBottom; + private LayoutState _savedLayoutState; + private int _footnoteIndex; private FootnoteManager _footnoteManager; @@ -175,13 +177,13 @@ public void setDefaultTextDirection(byte direction) { _bfcs = new LinkedList<>(); _layers = new LinkedList<>(); - _firstLines = new StyleTracker(); - _firstLetters = new StyleTracker(); + _firstLines = StyleTracker.withNoStyles(); + _firstLetters = StyleTracker.withNoStyles(); } public void reInit(boolean keepLayers) { - _firstLines = new StyleTracker(); - _firstLetters = new StyleTracker(); + _firstLines = StyleTracker.withNoStyles(); + _firstLetters = StyleTracker.withNoStyles(); _currentMarkerData = null; _bfcs = new LinkedList<>(); @@ -196,22 +198,23 @@ public void reInit(boolean keepLayers) { } public LayoutState captureLayoutState() { - LayoutState result = new LayoutState(); - - result.setFirstLines(_firstLines); - result.setFirstLetters(_firstLetters); - result.setCurrentMarkerData(_currentMarkerData); - - result.setBFCs(_bfcs); - - if (isPrint()) { - result.setPageName(getPageName()); - result.setExtraSpaceBottom(getExtraSpaceBottom()); - result.setExtraSpaceTop(getExtraSpaceTop()); - result.setNoPageBreak(getNoPageBreak()); + if (!isPrint()) { + return new LayoutState( + _bfcs, + _currentMarkerData, + _firstLetters, + _firstLines); + } else { + return new LayoutState( + _bfcs, + _currentMarkerData, + _firstLetters, + _firstLines, + getPageName(), + getExtraSpaceTop(), + getExtraSpaceBottom(), + getNoPageBreak()); } - - return result; } public void restoreLayoutState(LayoutState layoutState) { @@ -231,17 +234,24 @@ public void restoreLayoutState(LayoutState layoutState) { } public LayoutState copyStateForRelayout() { - LayoutState result = new LayoutState(); - - result.setFirstLetters(_firstLetters.copyOf()); - result.setFirstLines(_firstLines.copyOf()); - result.setCurrentMarkerData(_currentMarkerData); - - if (isPrint()) { - result.setPageName(getPageName()); + if (_savedLayoutState != null && + _savedLayoutState.equal( + _currentMarkerData, + _firstLetters, + _firstLines, + isPrint() ? getPageName() : null)) { + + return _savedLayoutState; } - return result; + _savedLayoutState = + new LayoutState( + _firstLetters, + _firstLines, + _currentMarkerData, + isPrint() ? getPageName() : null); + + return _savedLayoutState; } public void restoreStateForRelayout(LayoutState layoutState) { @@ -559,4 +569,13 @@ public FootnoteManager getFootnoteManager() { return _footnoteManager; } + + public void setFirstLettersTracker(StyleTracker firstLetters) { + _firstLetters = firstLetters; + } + + public void setFirstLinesTracker(StyleTracker firstLines) { + _firstLines = firstLines; + } + } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutState.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutState.java index e500ecc04..29863db4f 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutState.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutState.java @@ -20,89 +20,129 @@ package com.openhtmltopdf.layout; import java.util.LinkedList; +import java.util.Objects; import com.openhtmltopdf.render.MarkerData; /** - * A bean which captures all state necessary to lay out an arbitrary box. + * A bean which captures all state necessary to lay out an arbitrary box. * Mutable objects must be copied when provided to this class. It is far too - * expensive to maintain a bean of this class for each box. + * expensive to maintain a bean of this class for each box. * It is only created as needed. + *

      + * IMPORTANT: Immutable after construction. */ public class LayoutState { - private StyleTracker _firstLines; - private StyleTracker _firstLetters; - - private MarkerData _currentMarkerData; - - private LinkedList _BFCs; - - private String _pageName; - private int _extraSpaceTop; - private int _extraSpaceBottom; - private int _noPageBreak; - - public LinkedList getBFCs() { - return _BFCs; + private final StyleTracker _firstLines; + private final StyleTracker _firstLetters; + + private final MarkerData _currentMarkerData; + + private final LinkedList _BFCs; + + private final String _pageName; + private final int _extraSpaceTop; + private final int _extraSpaceBottom; + private final int _noPageBreak; + + public LayoutState( + LinkedList bfcs, + MarkerData markerData, + StyleTracker firstLetters, + StyleTracker firstLines, + String pageName, + int extraSpaceTop, + int extraSpaceBottom, + int noPageBreak) { + this._BFCs = bfcs; + this._currentMarkerData = markerData; + this._firstLetters = firstLetters; + this._firstLines = firstLines; + this._pageName = pageName; + this._extraSpaceTop = extraSpaceTop; + this._extraSpaceBottom = extraSpaceBottom; + this._noPageBreak = noPageBreak; + } + + public LayoutState( + LinkedList bfcs, + MarkerData currentMarkerData, + StyleTracker firstLetters, + StyleTracker firstLines) { + this(bfcs, currentMarkerData, firstLetters, firstLines, null, 0, 0, 0); + } + + public LayoutState( + StyleTracker firstLetters, + StyleTracker firstLines, + MarkerData currentMarkerData, + String pageName) { + this(null, currentMarkerData, firstLetters, firstLines, pageName, 0, 0, 0); + } + + public boolean equal( + LinkedList bfcs, + MarkerData markerData, + StyleTracker firstLetters, + StyleTracker firstLines, + String pageName, + int extraSpaceTop, + int extraSpaceBottom, + int noPageBreak) { + + return bfcs == _BFCs && + markerData == _currentMarkerData && + Objects.equals(firstLetters, _firstLetters) && + Objects.equals(firstLines, _firstLines) && + Objects.equals(pageName, _pageName) && + extraSpaceTop == _extraSpaceTop && + extraSpaceBottom == _extraSpaceBottom && + noPageBreak == _noPageBreak; + } + + public boolean equal( + MarkerData currentMarkerData, + StyleTracker firstLetters, + StyleTracker firstLines, + String pageName) { + + return currentMarkerData == _currentMarkerData && + Objects.equals(firstLetters, _firstLetters) && + Objects.equals(firstLines, _firstLines) && + Objects.equals(pageName, _pageName); } - public void setBFCs(LinkedList s) { - _BFCs = s; + + public LinkedList getBFCs() { + return _BFCs; } public MarkerData getCurrentMarkerData() { return _currentMarkerData; } - public void setCurrentMarkerData(MarkerData currentMarkerData) { - _currentMarkerData = currentMarkerData; - } - public StyleTracker getFirstLetters() { return _firstLetters; } - public void setFirstLetters(StyleTracker firstLetters) { - _firstLetters = firstLetters; - } - public StyleTracker getFirstLines() { return _firstLines; } - public void setFirstLines(StyleTracker firstLines) { - _firstLines = firstLines; - } - public String getPageName() { return _pageName; } - public void setPageName(String pageName) { - _pageName = pageName; - } - public int getExtraSpaceTop() { return _extraSpaceTop; } - public void setExtraSpaceTop(int extraSpaceTop) { - _extraSpaceTop = extraSpaceTop; - } - public int getExtraSpaceBottom() { return _extraSpaceBottom; } - public void setExtraSpaceBottom(int extraSpaceBottom) { - _extraSpaceBottom = extraSpaceBottom; - } - public int getNoPageBreak() { return _noPageBreak; } - public void setNoPageBreak(int noPageBreak) { - _noPageBreak = noPageBreak; - } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/StyleTracker.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/StyleTracker.java index 65722d050..f4d64d3b8 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/StyleTracker.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/StyleTracker.java @@ -20,7 +20,6 @@ package com.openhtmltopdf.layout; import java.util.ArrayList; -import java.util.Iterator; import java.util.List; import com.openhtmltopdf.css.newmatch.CascadedStyle; @@ -30,43 +29,67 @@ * A managed list of {@link CalculatedStyle} objects. It is used when keeping * track of the styles which apply to a :first-line or :first-letter pseudo * element. + *

      + * IMPORTANT: Immutable after constructor. */ public class StyleTracker { - private List _styles = new ArrayList<>(); - - public void addStyle(CascadedStyle style) { - _styles.add(style); + private final List _styles; + + private static final StyleTracker EMPTY_INSTANCE = new StyleTracker(0); + + public StyleTracker(int size) { + this._styles = new ArrayList<>(size); + } + + @Override + public boolean equals(Object obj) { + if (obj == null) { + return false; + } + + if (obj.getClass() != this.getClass()) { + return false; + } + + return ((StyleTracker) obj).getStyles().equals(this.getStyles()); + } + + public StyleTracker withStyle(CascadedStyle style) { + StyleTracker tracker = new StyleTracker(getStyles().size() + 1); + tracker._styles.addAll(getStyles()); + tracker._styles.add(style); + return tracker; } - public void removeLast() { - if (_styles.size() != 0) { - _styles.remove(_styles.size()-1); + public StyleTracker withOutLast() { + if (_styles.isEmpty()) { + return this; + } else if (_styles.size() == 1) { + return EMPTY_INSTANCE; } + + StyleTracker tracker = new StyleTracker(getStyles().size() - 1); + tracker._styles.addAll(getStyles().subList(0, getStyles().size() - 1)); + return tracker; } public boolean hasStyles() { - return _styles.size() != 0; + return !_styles.isEmpty(); } - public void clearStyles() { - _styles.clear(); + public static StyleTracker withNoStyles() { + return EMPTY_INSTANCE; } - + public CalculatedStyle deriveAll(CalculatedStyle start) { CalculatedStyle result = start; - for (Iterator i = getStyles().iterator(); i.hasNext(); ) { - result = result.deriveStyle(i.next()); + for (CascadedStyle style : getStyles()) { + result = result.deriveStyle(style); } return result; } - public List getStyles() { + private List getStyles() { return _styles; } - - public StyleTracker copyOf() { - StyleTracker result = new StyleTracker(); - result._styles.addAll(this._styles); - return result; - } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java index 5ca3e2fc4..50da727b7 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/BlockBox.java @@ -1247,10 +1247,12 @@ protected void layoutChildren(LayoutContext c, int contentStart) { ensureChildren(c); if (getFirstLetterStyle() != null) { - c.getFirstLettersTracker().addStyle(getFirstLetterStyle()); + c.setFirstLettersTracker( + c.getFirstLettersTracker().withStyle(getFirstLetterStyle())); } if (getFirstLineStyle() != null) { - c.getFirstLinesTracker().addStyle(getFirstLineStyle()); + c.setFirstLinesTracker( + c.getFirstLinesTracker().withStyle(getFirstLineStyle())); } switch (getChildrenContentType()) { @@ -1269,10 +1271,12 @@ protected void layoutChildren(LayoutContext c, int contentStart) { } if (getFirstLetterStyle() != null) { - c.getFirstLettersTracker().removeLast(); + c.setFirstLettersTracker( + c.getFirstLettersTracker().withOutLast()); } if (getFirstLineStyle() != null) { - c.getFirstLinesTracker().removeLast(); + c.setFirstLinesTracker( + c.getFirstLinesTracker().withOutLast()); } setState(Box.DONE); diff --git a/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/benchmark/RenderTextBenchmark.java b/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/benchmark/RenderTextBenchmark.java index 16b0107dc..18745dde9 100644 --- a/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/benchmark/RenderTextBenchmark.java +++ b/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/benchmark/RenderTextBenchmark.java @@ -1,15 +1,19 @@ package com.openhtmltopdf.benchmark; import com.openhtmltopdf.pdfboxout.PdfRendererBuilder; +import com.openhtmltopdf.performance.PerformanceCaseGenerator; import com.openhtmltopdf.util.XRLog; import org.apache.pdfbox.io.IOUtils; import org.openjdk.jmh.annotations.Benchmark; import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Fork; +import org.openjdk.jmh.annotations.Measurement; import org.openjdk.jmh.annotations.Mode; import org.openjdk.jmh.annotations.OutputTimeUnit; import org.openjdk.jmh.annotations.Scope; import org.openjdk.jmh.annotations.Setup; import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.Warmup; import org.openjdk.jmh.runner.Runner; import org.openjdk.jmh.runner.options.Options; import org.openjdk.jmh.runner.options.OptionsBuilder; @@ -24,17 +28,27 @@ import java.util.concurrent.TimeUnit; /** + * To run these benchmarks in the repo root directory: + * 
      + * mvn install -DskipTests
+ * java -jar ./openhtmltopdf-examples/target/benchmarks.jar
+ *
      + * + * They should take a couple of minutes. + * * @author schrader */ @BenchmarkMode(Mode.AverageTime) @OutputTimeUnit(TimeUnit.MILLISECONDS) @State(Scope.Thread) +@Warmup(iterations = 2, time = 3, timeUnit = TimeUnit.SECONDS) +@Measurement(iterations = 2, time = 6, timeUnit = TimeUnit.SECONDS) +@Fork(warmups = 0, value = 1) public class RenderTextBenchmark { public static void main(String[] args) throws Exception { Options opt = new OptionsBuilder() .include(RenderTextBenchmark.class.getSimpleName()) - .forks(1) .build(); new Runner(opt).run(); @@ -50,6 +64,11 @@ public void setUp() { "/benchmark/render-text-plain.html", "/benchmark/render-text-soft-hyphens.html" ).forEach(path -> contents.put(path, readContent(path))); + + contents.put("/performance/table-rows", PerformanceCaseGenerator.tableRows(1_000)); + contents.put("/performance/paragraphs", PerformanceCaseGenerator.paragraphs(100)); + contents.put("/performance/page-break-blocks", PerformanceCaseGenerator.pageBreakAvoidBlocks(300)); + contents.put("/performance/blocks", PerformanceCaseGenerator.blocks(300)); } @Benchmark @@ -62,6 +81,26 @@ public void renderText_SoftHyphens() throws Exception { runRenderer(contents.get("/benchmark/render-text-soft-hyphens.html")); } + @Benchmark + public void renderTableRows() throws IOException { + runRenderer(contents.get("/performance/table-rows")); + } + + @Benchmark + public void renderParagraphs() throws IOException { + runRenderer(contents.get("/performance/paragraphs")); + } + + @Benchmark + public void renderBlocksPageBreak() throws IOException { + runRenderer(contents.get("/performance/page-break-blocks")); + } + + @Benchmark + public void renderBlocks() throws IOException { + runRenderer(contents.get("/performance/blocks")); + } + private void runRenderer(String html) throws IOException { ByteArrayOutputStream actual = new ByteArrayOutputStream(); diff --git a/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/performance/PerformanceCaseGenerator.java b/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/performance/PerformanceCaseGenerator.java index ecf4bf237..ea84aa015 100644 --- a/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/performance/PerformanceCaseGenerator.java +++ b/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/performance/PerformanceCaseGenerator.java @@ -3,6 +3,8 @@ import java.util.stream.Collectors; import java.util.stream.IntStream; +import com.openhtmltopdf.layout.BlockBoxing; + public class PerformanceCaseGenerator { private static final String LOREM = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. " + @@ -10,29 +12,57 @@ public class PerformanceCaseGenerator { "eget bibendum nulla massa vel metus. Duis sed nunc ornare, convallis purus at, " + "fringilla ipsum. Quisque ullamcorper hendrerit ipsum at eleifend. Orci varius " + "natoque penatibus et magnis dis parturient montes, nascetur ridiculus."; - - + + private static String join(String hdr, String repeat, String ftr, int howMany) { + return IntStream.range(0, howMany) + .mapToObj(i -> repeat) + .collect(Collectors.joining("\n", hdr, ftr)); + } + public static String paragraphs(int howMany) { final String hdr = ""; final String paragraph = "

      " + LOREM + "

      "; final String ftr = ""; - - return IntStream.range(0, howMany) - .mapToObj(i -> paragraph) - .collect(Collectors.joining("\n", hdr, ftr)); + + return join(hdr, paragraph, ftr, howMany); } - + public static String tableRows(int howMany) { final String hdr = ""; final String tr = ""; final String ftr = "
      OneTwoThree
      "; - - return IntStream.range(0, howMany) - .mapToObj(i -> tr) - .collect(Collectors.joining("\n", hdr, ftr)); + + return join(hdr, tr, ftr, howMany); } - + + /** + * Performance of {@link BlockBoxing} + */ + public static String pageBreakAvoidBlocks(int howMany) { + final String hdr = ""; + final String block = "
      "; + final String ftr = ""; + + return join(hdr, block, ftr, howMany); + } + + /** + * Performance of {@link BlockBoxing} + */ + public static String blocks(int howMany) { + final String hdr = ""; + final String block = "
      "; + final String ftr = ""; + + return join(hdr, block, ftr, howMany); + } + /** * Performace case for: * Issue 396 - CSS border-radius makes pdf rendering very slow. @@ -47,10 +77,8 @@ public static String borderRadius(int howMany) { ""; final String div = "
      "; final String ftr = ""; - - return IntStream.range(0, howMany) - .mapToObj(i -> div) - .collect(Collectors.joining("\n", hdr, ftr)); + + return join(hdr, div, ftr, howMany); } } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html new file mode 100644 index 000000000..29a99a9b9 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html @@ -0,0 +1,70 @@ + + + + + +
      +
      + +
      +

      + Footnote with large text! +

      +

      + Another paragraph! +

      +
      +
      + This however is a purely inline footnote. +
      + +
      +
      +
      + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index 6b0d3539a..bf5b70a86 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1417,7 +1417,7 @@ public void testIssue649MultipleBgImagesPageBox() throws IOException { * Tests that we support CSS footnotes. */ @Test - @Ignore // Footnotes not implemented. + @Ignore // Working well, final touches. public void testIssue364FootnotesBasicExample() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-basic")); } @@ -1426,7 +1426,7 @@ public void testIssue364FootnotesBasicExample() throws IOException { * Tests that a line of text can contain two multi-page footnotes. */ @Test - @Ignore // Not perfect yet. + @Ignore // Final touches. public void testIssue364FootnotesMultiPage() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-multi-page")); } @@ -1441,6 +1441,12 @@ public void testIssue364FootnotesTooLarge() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-too-large")); } + @Test + @Ignore // Failing badly. + public void testIssue364FootnotesBlocks() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-blocks")); + } + // TODO: // + Elements that appear just on generated overflow pages. // + content property (page counters, etc) From c1af88d24fc8c1ede33bc82cce3e71077886f8fb Mon Sep 17 00:00:00 2001 From: danfickle Date: Thu, 10 Jun 2021 19:16:48 +1000 Subject: [PATCH 22/54] #364 Fix logic error and build in BlockBoxing. --- .../main/java/com/openhtmltopdf/layout/BlockBoxing.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java index b69e863fd..dabc532ee 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java @@ -458,8 +458,9 @@ boolean isInRun(int boxIndex) { Integer lastRunStart = runStarts.floor(boxIndex); if (lastRunStart != null) { - Integer lastRunEnd = runEnds != null ? runEnds.floor(boxIndex) : null; - return (lastRunEnd == null || lastRunEnd >= boxIndex); + Integer lastRunEnd = runEnds != null ? runEnds.ceiling(lastRunStart) : null; + return (lastRunEnd == null || + lastRunEnd >= boxIndex); } return false; @@ -494,7 +495,7 @@ public void configureRun(int offset, BlockBox previous, BlockBox current) { addRunStart(offset - 1); } - if (offset == childOffsets.length) { + if (offset == childOffsets.length - 1) { addRunEnd(offset); } } else if (previousInRun) { From f6d67fea949f28cd5738433ad5a3aae1fd94b3fa Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 14 Jun 2021 18:43:48 +1000 Subject: [PATCH 23/54] #364 Finally got boxing correct including for block content in footnotes. Also cleanup and documentation around styling code. --- .../openhtmltopdf/context/StyleReference.java | 189 ------------------ .../css/newmatch/CascadedStyle.java | 83 +------- .../css/style/CalculatedStyle.java | 139 ++++++++----- .../style/derived/DerivedValueFactory.java | 4 + .../com/openhtmltopdf/layout/BoxBuilder.java | 187 ++++++++++------- .../openhtmltopdf/layout/SharedContext.java | 36 ++-- .../java/com/openhtmltopdf/render/Box.java | 52 ----- .../openhtmltopdf/render/InlineLayoutBox.java | 28 +-- .../com/openhtmltopdf/render/LineBox.java | 21 +- .../html/issue-364-footnotes-blocks.html | 4 +- .../VisualRegressionTest.java | 7 +- 11 files changed, 239 insertions(+), 511 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/StyleReference.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/StyleReference.java index c926abc8b..9d54b1b86 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/StyleReference.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/StyleReference.java @@ -268,192 +268,3 @@ public void setSupportCMYKColors(boolean b) { _stylesheetFactory.setSupportCMYKColors(b); } } - -/* - * $Id$ - * - * $Log$ - * Revision 1.22 2008/07/27 00:21:46 peterbrant - * Implement CMYK color support for PDF output, starting with patch from Mykola Gurov / Banish java.awt.Color from FS core layout classes - * - * Revision 1.21 2008/04/04 13:32:38 peterbrant - * Fix method name - * - * Revision 1.20 2008/04/04 13:28:38 peterbrant - * Make sure user agent is provided to StyleReference when it's modified / Light cleanup - * - * Revision 1.19 2008/01/22 00:29:23 peterbrant - * Need to propagate changes to user agent in SharedContext to containing StyleReference - * - * Revision 1.18 2007/10/31 23:14:42 peterbrant - * Add rudimentary support for @font-face rules - * - * Revision 1.17 2007/08/19 22:22:52 peterbrant - * Merge R8pbrant changes to HEAD - * - * Revision 1.16.2.1 2007/07/09 22:18:04 peterbrant - * Begin work on running headers and footers and named pages - * - * Revision 1.16 2007/05/26 19:04:13 peterbrant - * Implement support for removing all references to a particular Element (in order to support limited dynamic DOM changes) - * - * Revision 1.15 2007/05/20 23:25:34 peterbrant - * Various code cleanups (e.g. remove unused imports) - * - * Patch from Sean Bright - * - * Revision 1.14 2007/05/16 22:27:14 peterbrant - * Only load default stylesheet once - * - * Revision 1.13 2007/02/20 23:44:51 peterbrant - * Minor formatting change - * - * Revision 1.12 2007/02/20 01:17:10 peterbrant - * Start CSS parser cleanup - * - * Revision 1.11 2007/02/19 14:53:42 peterbrant - * Integrate new CSS parser - * - * Revision 1.10 2006/09/11 19:23:29 peterbrant - * Parse element styles all at once - * - * Revision 1.9 2006/08/27 00:36:14 peterbrant - * Initial commit of (initial) R7 work - * - * Revision 1.8 2006/01/03 23:02:37 peterbrant - * Remove unused variable - * - * Revision 1.7 2005/12/30 01:32:43 peterbrant - * First merge of parts of pagination work - * - * Revision 1.6 2005/11/11 01:33:15 peterbrant - * Add ability to clear all cached stylesheets - * - * Revision 1.5 2005/10/27 00:08:51 tobega - * Sorted out Context into RenderingContext and LayoutContext - * - * Revision 1.4 2005/06/26 15:48:10 tobega - * Converted to almost standard html4 default css, which shook out a bug: position should not inherit - * - * Revision 1.3 2005/06/25 19:27:46 tobega - * UAC now supplies Resources - * - * Revision 1.2 2005/06/23 17:03:40 tobega - * css now independent of DOM - * - * Revision 1.1 2005/06/22 23:48:40 tobega - * Refactored the css package to allow a clean separation from the core. - * - * Revision 1.34 2005/06/16 12:59:23 pdoubleya - * Cleaned up support for reloading documents. - * - * Revision 1.33 2005/06/16 11:29:12 pdoubleya - * First cut support for reload page, flushes inline stylesheets. - * - * Revision 1.32 2005/06/16 07:24:48 tobega - * Fixed background image bug. - * Caching images in browser. - * Enhanced LinkListener. - * Some house-cleaning, playing with Idea's code inspection utility. - * - * Revision 1.31 2005/06/15 11:53:45 tobega - * Changed UserAgentCallback to getInputStream instead of getReader. Fixed up some consequences of previous change. - * - * Revision 1.30 2005/06/01 21:36:37 tobega - * Got image scaling working, and did some refactoring along the way - * - * Revision 1.29 2005/05/17 06:56:23 tobega - * Inline backgrounds now work correctly, as does mixing of inlines and blocks for style inheritance - * - * Revision 1.28 2005/05/08 15:37:29 tobega - * Fixed up style caching so it really works (internalize CascadedStyles and let each CalculatedStyle keep track of its derived children) - * - * Revision 1.27 2005/05/08 14:51:22 tobega - * Removed the need for the Styler - * - * Revision 1.26 2005/05/08 14:36:54 tobega - * Refactored away the need for having a context in a CalculatedStyle - * - * Revision 1.25 2005/03/24 23:18:38 pdoubleya - * Added use of SharedContext (Kevin). - * - * Revision 1.24 2005/01/29 20:19:22 pdoubleya - * Clean/reformat code. Removed commented blocks, checked copyright. - * - * Revision 1.23 2005/01/29 12:49:24 pdoubleya - * Fixed cast on get...PropertiesMap(). - * - * Revision 1.22 2005/01/24 19:01:09 pdoubleya - * Mass checkin. Changed to use references to CSSName, which now has a Singleton instance for each property, everywhere property names were being used before. Removed commented code. Cascaded and Calculated style now store properties in arrays rather than maps, for optimization. - * - * Revision 1.21 2005/01/24 14:36:30 pdoubleya - * Mass commit, includes: updated for changes to property declaration instantiation, and new use of DerivedValue. Removed any references to older XR... classes (e.g. XRProperty). Cleaned imports. - * - * Revision 1.20 2005/01/16 18:50:03 tobega - * Re-introduced caching of styles, which make hamlet and alice scroll nicely again. Background painting still slow though. - * - * Revision 1.19 2005/01/08 15:56:54 tobega - * Further work on extensibility interfaces. Documented it - see website. - * - * Revision 1.18 2005/01/08 11:55:16 tobega - * Started massaging the extension interfaces - * - * Revision 1.17 2005/01/04 10:19:11 tobega - * resolve selectors to styles direcly on match, should reduce memory footprint and not affect speed very much. - * - * Revision 1.16 2005/01/03 23:40:40 tobega - * Cleaned out unnecessary styling/matching code. styling/matching is now called during boxing/rendering rather than as a separate stage. - * - * Revision 1.15 2004/12/29 10:39:27 tobega - * Separated current state Context into LayoutContext and the rest into SharedContext. - * - * Revision 1.14 2004/12/28 01:48:22 tobega - * More cleaning. Magically, the financial report demo is starting to look reasonable, without any effort being put on it. - * - * Revision 1.13 2004/12/11 18:18:08 tobega - * Still broken, won't even compile at the moment. Working hard to fix it, though. Replace the StyleReference interface with our only concrete implementation, it was a bother changing in two places all the time. - * - * Revision 1.22 2004/12/05 18:11:36 tobega - * Now uses style cache for pseudo-element styles. Also started preparing to replace inline node handling with inline content handling. - * - * Revision 1.21 2004/12/05 14:35:38 tobega - * Cleaned up some usages of Node (and removed unused stuff) in layout code. The goal is to pass "better" objects than Node wherever possible in an attempt to shake out the bugs in tree-traversal (probably often unnecessary tree-traversal) - * - * Revision 1.20 2004/12/05 00:48:53 tobega - * Cleaned up so that now all property-lookups use the CalculatedStyle. Also added support for relative values of top, left, width, etc. - * - * Revision 1.19 2004/12/02 19:46:35 tobega - * Refactored handling of inline styles to fit with StylesheetInfo and media handling (is also now correct if there should be more than one style element) - * - * Revision 1.18 2004/12/01 14:02:51 joshy - * modified media to use the value from the rendering context - * added the inline-block box - * - j - * - * Revision 1.17 2004/11/30 23:47:56 tobega - * At-media rules should now work (not tested). Also fixed at-import rules, which got broken at previous modification. - * - * Revision 1.16 2004/11/29 23:25:37 tobega - * Had to redo thinking about Stylesheets and StylesheetInfos. Now StylesheetInfos are passed around instead of Stylesheets because any Stylesheet should only be linked to its URI. Bonus: the external sheets get lazy-loaded only if needed for the medium. - * - * Revision 1.15 2004/11/28 23:29:00 tobega - * Now handles media on Stylesheets, still need to handle at-media-rules. The media-type should be set in Context.media (set by default to "screen") before calling setContext on StyleReference. - * - * Revision 1.14 2004/11/15 22:22:08 tobega - * Now handles @import stylesheets - * - * Revision 1.13 2004/11/15 19:46:13 tobega - * Refactoring in preparation for handling @import stylesheets - * - * Revision 1.12 2004/11/15 12:42:22 pdoubleya - * Across this checkin (all may not apply to this particular file) - * Changed default/package-access members to private. - * Changed to use XRRuntimeException where appropriate. - * Began move from System.err.println to std logging. - * Standard code reformat. - * Removed some unnecessary SAC member variables that were only used in initialization. - * CVS log section. - * - * - */ - diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/CascadedStyle.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/CascadedStyle.java index 13e951645..365672070 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/CascadedStyle.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/newmatch/CascadedStyle.java @@ -59,8 +59,8 @@ public class CascadedStyle { /** * Map of PropertyDeclarations, keyed by {@link CSSName} */ - private Map cascadedProperties; - + private final Map cascadedProperties; + private String fingerprint; /** @@ -136,8 +136,9 @@ private CascadedStyle(CascadedStyle startingPoint, Iterator private CascadedStyle() { cascadedProperties = new TreeMap<>(); } + /** - * Creates a CascadedStyle, setting the display property to + * Creates an otherwise empty CascadedStyle, setting the display property * to the value of the display parameter. */ public static CascadedStyle createAnonymousStyle(IdentValue display) { @@ -190,8 +191,9 @@ private void addProperties(java.util.Iterator iter) { * @return True if the property is defined in this set. */ public boolean hasProperty(CSSName cssName) { - return cascadedProperties.get(cssName) != null; + return cascadedProperties.containsKey(cssName); } + /** * Returns a {@link com.openhtmltopdf.css.sheet.PropertyDeclaration} by CSS * property name, e.g. "font-family". Properties are already cascaded during @@ -243,75 +245,4 @@ public String getFingerprint() { } return this.fingerprint; } -}// end class - -/* - * $Id$ - * - * $Log$ - * Revision 1.19 2007/10/31 23:14:41 peterbrant - * Add rudimentary support for @font-face rules - * - * Revision 1.18 2007/04/12 12:29:11 peterbrant - * Properly handle floated tables with captions - * - * Revision 1.17 2007/02/20 17:23:15 peterbrant - * Optimize fingerprint calculation - * - * Revision 1.16 2007/02/20 01:17:09 peterbrant - * Start CSS parser cleanup - * - * Revision 1.15 2007/02/07 16:33:14 peterbrant - * Initial commit of rewritten table support and associated refactorings - * - * Revision 1.14 2006/06/15 20:02:39 tobega - * Using a TreeMap to get properties in sorted order should be able to reduce the size of the caches in CalculatedStyle when styles are the same apart from order of declaration of properties. - * - * Revision 1.13 2006/01/09 23:22:24 peterbrant - * Cache fingerprint after initial creation - * - * Revision 1.12 2005/10/20 20:48:02 pdoubleya - * Updates for refactoring to style classes. CalculatedStyle now has lookup methods to cover all general cases, so propertyByName() is private, which means the backing classes for styling were able to be replaced. - * - * Revision 1.11 2005/06/21 08:06:47 pdoubleya - * Changed to use Map of properties again. - * - * Revision 1.10 2005/05/16 13:48:58 tobega - * Fixe inline border mismatch and started on styling problem in switching between blocks and inlines - * - * Revision 1.9 2005/05/08 15:37:26 tobega - * Fixed up style caching so it really works (internalize CascadedStyles and let each CalculatedStyle keep track of its derived children) - * - * Revision 1.8 2005/05/08 13:02:36 tobega - * Fixed a bug whereby styles could get lost for inline elements, notably if root element was inline. Did a few other things which probably has no importance at this moment, e.g. refactored out some unused stuff. - * - * Revision 1.7 2005/04/20 14:13:07 tobega - * Issue number: - * Obtained from: - * Submitted by: - * Reviewed by: - * - * Revision 1.6 2005/01/29 20:22:25 pdoubleya - * Clean/reformat code. Removed commented blocks, checked copyright. - * - * Revision 1.5 2005/01/25 14:45:55 pdoubleya - * Added support for IdentValue mapping on property declarations. On both CascadedStyle and PropertyDeclaration you can now request the value as an IdentValue, for object-object comparisons. Updated 99% of references that used to get the string value of PD to return the IdentValue instead; remaining cases are for pseudo-elements where the PD content needs to be manipulated as a String. - * - * Revision 1.4 2005/01/24 19:01:06 pdoubleya - * Mass checkin. Changed to use references to CSSName, which now has a Singleton instance for each property, everywhere property names were being used before. Removed commented code. Cascaded and Calculated style now store properties in arrays rather than maps, for optimization. - * - * Revision 1.3 2004/11/15 13:40:14 pdoubleya - * Updated JavaDoc. - * - * Revision 1.2 2004/11/15 12:42:22 pdoubleya - * Across this checkin (all may not apply to this particular file) - * Changed default/package-access members to private. - * Changed to use XRRuntimeException where appropriate. - * Began move from System.err.println to std logging. - * Standard code reformat. - * Removed some unnecessary SAC member variables that were only used in initialization. - * CVS log section. - * - * - */ - +} diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java index 10ec71ee4..3a6ef1099 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java @@ -21,7 +21,6 @@ package com.openhtmltopdf.css.style; import java.awt.Cursor; -import java.lang.annotation.Documented; import java.util.ArrayList; import java.util.Collections; import java.util.List; @@ -29,6 +28,7 @@ import java.util.logging.Level; import java.util.stream.Collectors; +import com.openhtmltopdf.context.StyleReference; import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; import com.openhtmltopdf.css.newmatch.CascadedStyle; @@ -50,6 +50,9 @@ import com.openhtmltopdf.css.style.derived.NumberValue; import com.openhtmltopdf.css.style.derived.RectPropertySet; import com.openhtmltopdf.css.value.FontSpecification; +import com.openhtmltopdf.layout.BoxBuilder; +import com.openhtmltopdf.layout.LayoutContext; +import com.openhtmltopdf.layout.SharedContext; import com.openhtmltopdf.layout.counter.RootCounterContext; import com.openhtmltopdf.newtable.TableBox; import com.openhtmltopdf.render.Box; @@ -67,16 +70,23 @@ /** * A set of properties that apply to a single Element, derived from all matched * properties following the rules for CSS cascade, inheritance, importance, - * specificity and sequence. A derived style is just like a style but - * (presumably) has additional information that allows relative properties to be - * assigned values, e.g. font attributes. Property values are fully resolved - * when this style is created. A property retrieved by name should always have - * only one value in this class (e.g. one-one map). Any methods to retrieve + * specificity and sequence. A property retrieved by name should always have + * exactly one value in this class (e.g. one-one map). Some methods to retrieve * property values from an instance of this class require a valid {@link - * com.openhtmltopdf.layout.LayoutContext} be given to it, for some cases of property - * resolution. Generally, a programmer will not use this class directly, but - * will retrieve properties using a {@link com.openhtmltopdf.context.StyleReference} - * implementation. + * com.openhtmltopdf.layout.LayoutContext} be given to them. + *

      + * This is the go to class for working with a resolved style. Generally, you can get a + * instance for a box by calling: + * + *
        + *
      • {@link Box#getStyle()} after a box has been created by the {@link BoxBuilder}
        • + *
      • {@link SharedContext#getStyle(org.w3c.dom.Element)} for an element
        • + *
      • {@link StyleReference#getPseudoElementStyle(org.w3c.dom.Node, String)} for a pseudo + * element. StyleReference is available from {@link LayoutContext}
        • + *
      • {@link #deriveStyle(CascadedStyle)}
        • to create a child style (non-inherited + * property values will not be available from the child style + *
      • {@link EmptyStyle} to start with nothing
        • + *
      * * @author Torbjoern Gannholm * @author Patrick Wright @@ -101,19 +111,10 @@ public class CalculatedStyle { private boolean _paddingAllowed = true; private boolean _bordersAllowed = true; - private BackgroundSize _backgroundSize; - /** * Cache child styles of this style that have the same cascaded properties */ private final java.util.Map _childCache = new java.util.HashMap<>(); - /*private java.util.HashMap _childCache = new java.util.LinkedHashMap(5, 0.75f, true) { - private static final int MAX_ENTRIES = 10; - - protected boolean removeEldestEntry(Map.Entry eldest) { - return size() > MAX_ENTRIES; - } - };*/ /** * Our main array of property values defined in this style, keyed @@ -151,6 +152,11 @@ private CalculatedStyle(CalculatedStyle parent, CascadedStyle matched) { this(); _parent = parent; + init(matched); + } + + + private void init(CascadedStyle matched) { derive(matched); checkPaddingAllowed(); @@ -186,9 +192,11 @@ private void checkBordersAllowed() { } /** - * derives a child style from this style. - *
      - * depends on the ability to return the identical CascadedStyle each time a child style is needed + * Derives a child style from this style. Non-inherited properties + * such as borders will be replaced compared to this which is used + * as parent style. + *

      + * Depends on the ability to return the identical CascadedStyle each time a child style is needed * * @param matched the CascadedStyle to apply * @return The derived child style @@ -209,12 +217,37 @@ public CalculatedStyle deriveStyle(CascadedStyle matched) { return cs; } - public int countAssigned() { - int c = 0; - for (int i = 0; i < _derivedValuesById.length; i++) { - if (_derivedValuesById[i] != null) c++; - } - return c; + /** + * Override this style with specified styles. This will NOT + * create a child style, rather an exact copy with only the specified + * properties overridden. Compare to {@link #deriveStyle(CascadedStyle)}. + */ + public CalculatedStyle overrideStyle(CascadedStyle matched) { + CalculatedStyle ret = new CalculatedStyle(); + + ret._parent = this._parent; + System.arraycopy(this._derivedValuesById, 0, ret._derivedValuesById, 0, ret._derivedValuesById.length); + + init(matched); + + return ret; + } + + /** + * Override this style with specified styles. This will NOT + * create a child style, rather an exact copy with only the display + * property overridden. Compare to {@link #createAnonymousStyle(IdentValue)} + * which creates a child style. + */ + public CalculatedStyle overrideStyle(IdentValue display) { + CalculatedStyle ret = new CalculatedStyle(); + + ret._parent = this._parent; + System.arraycopy(this._derivedValuesById, 0, ret._derivedValuesById, 0, ret._derivedValuesById.length); + + init(CascadedStyle.createAnonymousStyle(display)); + + return ret; } /** @@ -257,12 +290,6 @@ public String[] asStringArray(CSSName cssName) { return valueByName(cssName).asStringArray(); } - public void setDefaultValue(CSSName cssName, FSDerivedValue fsDerivedValue) { - if (_derivedValuesById[cssName.FS_ID] == null) { - _derivedValuesById[cssName.FS_ID] = fsDerivedValue; - } - } - // TODO: doc public boolean hasAbsoluteUnit(CSSName cssName) { boolean isAbs = false; @@ -520,9 +547,11 @@ public boolean isLengthOrNumber(CSSName cssName) { /** * Returns a {@link FSDerivedValue} by name. Because we are a derived * style, the property will already be resolved at this point. + *

      + * This will look up the ancestor tree for inherited properties and + * use an initial value for unspecified properties which do not inherit. * * @param cssName The CSS property name, e.g. "font-family" - * @return See desc. */ public FSDerivedValue valueByName(CSSName cssName) { FSDerivedValue val = _derivedValuesById[cssName.FS_ID]; @@ -535,7 +564,6 @@ public FSDerivedValue valueByName(CSSName cssName) { // for the value if (! needInitialValue && CSSName.propertyInherits(cssName) && _parent != null - // && (val = _parent.valueByName(cssName)) != null) { // Do nothing, val is already set } else { @@ -554,35 +582,33 @@ public FSDerivedValue valueByName(CSSName cssName) { } _derivedValuesById[cssName.FS_ID] = val; } + return val; } /** - *

      - *

      - *

      - *

      - * Implements cascade/inherit/important logic. This should result in the - * element for this style having a value for *each and every* (visual) - * property in the CSS2 spec. The implementation is based on the notion that + * This method should result in the element for this style having a + * derived value for all specified (in stylesheets, style attribute, other non + * CSS attrs, etc) primitive CSS properties. Other properties are picked up + * from an ancestor (if they inherit) or their initial values (if + * they don't inherit). See {@link #valueByName(CSSName)}. + *

      + * The implementation is based on the notion that * the matched styles are given to us in a perfectly sorted order, such that * properties appearing later in the rule-set always override properties - * appearing earlier. It also assumes that all properties in the CSS2 spec - * are defined somewhere across all the matched styles; for example, that - * the full-property set is given in the user-agent CSS that is always - * loaded with styles. The current implementation makes no attempt to check - * either of these assumptions. When this method exits, the derived property + * appearing earlier. + *

      + * The current implementation makes no attempt to check + * this assumption. When this method exits, the derived property * list for this class will be populated with the properties defined for - * this element, properly cascaded.

      - * - * @param matched PARAM + * this element, properly cascaded. */ private void derive(CascadedStyle matched) { if (matched == null) { return; - }//nothing to derive + } - for (PropertyDeclaration pd : matched.getCascadedPropertyDeclarations()) { + for (PropertyDeclaration pd : matched.getCascadedPropertyDeclarations()) { FSDerivedValue val = deriveValue(pd.getCSSName(), pd.getValue()); _derivedValuesById[pd.getCSSName().FS_ID] = val; } @@ -1083,6 +1109,13 @@ public boolean isAvoidPageBreakInside() { return isIdent(CSSName.PAGE_BREAK_INSIDE, IdentValue.AVOID); } + /** + * This method derives a style for an anonymous child box with an overriden + * value for the display property. + *

      + * NOTE: All non-inherited properties of this will be lost as + * the returned style is for a child box. + */ public CalculatedStyle createAnonymousStyle(IdentValue display) { return deriveStyle(CascadedStyle.createAnonymousStyle(display)); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/DerivedValueFactory.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/DerivedValueFactory.java index 0be76289c..d0386b608 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/DerivedValueFactory.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/derived/DerivedValueFactory.java @@ -28,6 +28,10 @@ import com.openhtmltopdf.css.style.FSDerivedValue; public class DerivedValueFactory { + /** + * Derived value factory. Requires a reference to a style so that it + * can resolve explicit inherit values with values from an ancestor. + */ public static FSDerivedValue newDerivedValue( CalculatedStyle style, CSSName cssName, PropertyValue value) { if (value.getCssValueType() == CSSValue.CSS_INHERIT) { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index bf298b38e..aa65b26c1 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -28,6 +28,7 @@ import java.util.Iterator; import java.util.List; import java.util.Map; +import java.util.stream.Collectors; import org.w3c.dom.Document; import org.w3c.dom.Element; @@ -150,7 +151,7 @@ public static void createChildren(LayoutContext c, BlockBox parent) { // The following is very useful for debugging. // It shows the contents of the box tree before layout. -// if (parent.getElement().getNodeName().equals("html")) { +// if (parent == c.getRootLayer().getMaster()) { // System.out.println(com.openhtmltopdf.util.LambdaUtil.descendantDump(parent)); // } } @@ -982,19 +983,19 @@ private static void insertGeneratedContent( if (contentDecl != null || counterResetDecl != null || counterIncrDecl != null) { calculatedStyle = parentStyle.deriveStyle(peStyle); - if (calculatedStyle.isDisplayNone()) return; - if (calculatedStyle.isIdent(CSSName.CONTENT, IdentValue.NONE)) return; - if (calculatedStyle.isIdent(CSSName.CONTENT, IdentValue.NORMAL) && (peName.equals("before") || peName.equals("after"))) + + if (calculatedStyle.isDisplayNone() || + calculatedStyle.isIdent(CSSName.CONTENT, IdentValue.NONE) || + (calculatedStyle.isIdent(CSSName.CONTENT, IdentValue.NORMAL) && + (peName.equals("before") || peName.equals("after")))) { return; + } - if (calculatedStyle.isTable() || calculatedStyle.isTableRow() || calculatedStyle.isTableSection()) { - CascadedStyle newPeStyle = - CascadedStyle.createLayoutStyle(peStyle, new PropertyDeclaration[] { - CascadedStyle.createLayoutPropertyDeclaration( - CSSName.DISPLAY, - IdentValue.BLOCK), - }); - calculatedStyle = parentStyle.deriveStyle(newPeStyle); + if (calculatedStyle.isTable() || + calculatedStyle.isTableRow() || + calculatedStyle.isTableSection()) { + + calculatedStyle = parentStyle.createAnonymousStyle(IdentValue.BLOCK); } c.resolveCounters(calculatedStyle); @@ -1107,7 +1108,11 @@ private static List wrapGeneratedContent(Element element, String peNa InlineBox iB = (InlineBox) i.next(); iB.setStyle(anon); iB.applyTextTransform(); - iB.setElement(null); + + if (iB.getElement() == null || + !"fs-footnote-marker".equals(iB.getElement().getNodeName())) { + iB.setElement(null); + } } BlockBox result = createBlockBox(style, info, true); @@ -1257,7 +1262,8 @@ private static void createElementChild( Node working, List children, ChildBoxInfo info, - CreateChildrenContext context) { + CreateChildrenContext context, + boolean allowFootnotes) { Styleable child = null; SharedContext sharedContext = c.getSharedContext(); @@ -1289,7 +1295,7 @@ private static void createElementChild( return; } - if (style.isFootnote()) { + if (style.isFootnote() && allowFootnotes) { c.setFootnoteIndex(c.getFootnoteIndex() + 1); // This is the official marker content that can generate zero or more boxes @@ -1304,91 +1310,119 @@ private static void createElementChild( iB.setStartsHere(true); iB.setEndsHere(true); iB.setFootnote(footnoteBody); + children.add(iB); + return; + } - } else if (style.isInline()) { + if (style.isInline()) { + createInlineChildren(c, parent, children, info, context, element); + } else { + child = createChildBlockBox(c, info, element, style); + } - if (context.needStartText) { - context.needStartText = false; - InlineBox iB = createInlineBox("", parent, context.parentStyle, null); - iB.setStartsHere(true); - iB.setEndsHere(false); - children.add(iB); - context.previousIB = iB; - } + if (child != null) { + children.add(child); + } + } - createChildren(c, null, element, children, info, true); + private static void createInlineChildren( + LayoutContext c, + Element parent, + List children, + ChildBoxInfo info, + CreateChildrenContext context, + Element element) { - if (context.inline) { - if (context.previousIB != null) { - context.previousIB.setEndsHere(false); - } - context.needEndText = true; - } - } else { - if (style.hasColumns() && c.isPrint()) { - child = new FlowingColumnContainerBox(); - } else { - child = createBlockBox(style, info, false); - } + if (context.needStartText) { + context.needStartText = false; + InlineBox iB = createInlineBox("", parent, context.parentStyle, null); + iB.setStartsHere(true); + iB.setEndsHere(false); + children.add(iB); + context.previousIB = iB; + } - child.setStyle(style); - child.setElement(element); + createChildren(c, null, element, children, info, true); - if (style.hasColumns() && c.isPrint()) { - createColumnContainer(c, child, element, style); + if (context.inline) { + if (context.previousIB != null) { + context.previousIB.setEndsHere(false); } + context.needEndText = true; + } + } - if (style.isListItem()) { - BlockBox block = (BlockBox) child; - block.setListCounter(c.getCounterContext(style).getCurrentCounterValue("list-item")); - } + private static Styleable createChildBlockBox( + LayoutContext c, ChildBoxInfo info, Element element, CalculatedStyle style) { - if (style.isTable() || style.isInlineTable()) { - TableBox table = (TableBox) child; - table.ensureChildren(c); + Styleable child; - child = reorderTableContent(c, table); - } + if (style.hasColumns() && c.isPrint()) { + child = new FlowingColumnContainerBox(); + } else { + child = createBlockBox(style, info, false); + } - if (!info.isContainsBlockLevelContent() - && !style.isLayedOutInInlineContext()) { - info.setContainsBlockLevelContent(true); - } + child.setStyle(style); + child.setElement(element); + + if (style.hasColumns() && c.isPrint()) { + createColumnContainer(c, child, element, style); + } + if (style.isListItem()) { BlockBox block = (BlockBox) child; + block.setListCounter(c.getCounterContext(style).getCurrentCounterValue("list-item")); + } - if (block.getStyle().mayHaveFirstLine()) { - block.setFirstLineStyle(c.getCss().getPseudoElementStyle(element, - "first-line")); - } - if (block.getStyle().mayHaveFirstLetter()) { - block.setFirstLetterStyle(c.getCss().getPseudoElementStyle(element, - "first-letter")); - } + if (style.isTable() || style.isInlineTable()) { + TableBox table = (TableBox) child; + table.ensureChildren(c); - // I think we need to do this to evaluate counters correctly - block.ensureChildren(c); + child = reorderTableContent(c, table); } - if (child != null) { - children.add(child); + if (!info.isContainsBlockLevelContent() + && !style.isLayedOutInInlineContext()) { + info.setContainsBlockLevelContent(true); + } + + BlockBox block = (BlockBox) child; + + if (block.getStyle().mayHaveFirstLine()) { + block.setFirstLineStyle(c.getCss().getPseudoElementStyle(element, + "first-line")); + } + if (block.getStyle().mayHaveFirstLetter()) { + block.setFirstLetterStyle(c.getCss().getPseudoElementStyle(element, + "first-letter")); } + + // I think we need to do this to evaluate counters correctly + block.ensureChildren(c); + return child; } /** * Creates the footnote body to put at the bottom of the page inside a * page's footnote area. */ - private static BlockBox createFootnoteBody(LayoutContext c, Element element, CalculatedStyle style) { + private static BlockBox createFootnoteBody( + LayoutContext c, Element element, CalculatedStyle style) { + List footnoteChildren = new ArrayList<>(); ChildBoxInfo footnoteChildInfo = new ChildBoxInfo(); // Create the out-of-flow footnote-body box as a block box. BlockBox footnoteBody = new BlockBox(); - CalculatedStyle footnoteBodyStyle = style.createAnonymousStyle(IdentValue.BLOCK); + CalculatedStyle footnoteBodyStyle = new EmptyStyle().createAnonymousStyle(IdentValue.BLOCK); + + // Create a dummy element for the footnote-body. + Element fnBodyElement = element.getOwnerDocument().createElement("fs-footnote-body"); + c.getRootLayer().getMaster().getElement().appendChild(fnBodyElement); - footnoteBody.setElement(element); + footnoteBody.setElement(fnBodyElement); footnoteBody.setStyle(footnoteBodyStyle); // This will be set to the same as the footnote area when we add it to the page. @@ -1403,13 +1437,16 @@ private static BlockBox createFootnoteBody(LayoutContext c, Element element, Cal c.pushLayer(layer); - // The footnote marker followed by footnote element children. - insertGeneratedContent(c, element, footnoteBodyStyle, "footnote-marker", footnoteChildren, footnoteChildInfo); - createChildren(c, footnoteBody, element, footnoteChildren, footnoteChildInfo, footnoteBodyStyle.isInline()); + CreateChildrenContext context = new CreateChildrenContext(false, false, style.getParent(), false); + createElementChild(c, (Element) element.getParentNode(), footnoteBody, element, footnoteChildren, footnoteChildInfo, context, false); resolveChildren(c, footnoteBody, footnoteChildren, footnoteChildInfo); c.popLayer(); +// System.out.println(); +// System.out.println(com.openhtmltopdf.util.LambdaUtil.descendantDump(footnoteBody)); +// System.out.println(); + return footnoteBody; } @@ -1450,6 +1487,10 @@ private static void createChildren( insertGeneratedContent(c, parent, parentStyle, "before", children, info); + if (parentStyle.isFootnote()) { + insertGeneratedContent(c, parent, parentStyle, "footnote-marker", children, info); + } + Node working = parent.getFirstChild(); CreateChildrenContext context = null; @@ -1461,7 +1502,7 @@ private static void createChildren( if (nodeType == Node.ELEMENT_NODE) { createElementChild( - c, parent, blockParent, working, children, info, context); + c, parent, blockParent, working, children, info, context, true); } else if (nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE) { context.needStartText = false; context.needEndText = false; diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java index 5da3ab2f8..66bd10393 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java @@ -96,7 +96,7 @@ public class SharedContext { private float mmPerDot; private boolean print; - private Map styleMap; + private final Map styleMap = new HashMap<>(1024, 0.75f); private ReplacedElementFactory replacedElementFactory; private Rectangle tempCanvas; @@ -465,29 +465,25 @@ public void setDotsPerPixel(int dotsPerPixel) { this.dotsPerPixel = dotsPerPixel; } + /** + * Gets the resolved style for an element. All primitive properties will + * have values. + *

      + * This method uses a cache. + *

      + * If the parent element's style is not cached this method will recursively + * work up the ancestor list until it styles the document with the initial values + * of CSS properties. + */ public CalculatedStyle getStyle(Element e) { - return getStyle(e, false); - } + CalculatedStyle result = styleMap.get(e); - public CalculatedStyle getStyle(Element e, boolean restyle) { - if (styleMap == null) { - styleMap = new HashMap<>(1024, 0.75f); - } - - CalculatedStyle result = null; - if (! restyle) { - result = styleMap.get(e); - } if (result == null) { Node parent = e.getParentNode(); - CalculatedStyle parentCalculatedStyle; - if (parent instanceof Document) { - parentCalculatedStyle = new EmptyStyle(); - } else { - parentCalculatedStyle = getStyle((Element)parent, false); - } - - result = parentCalculatedStyle.deriveStyle(getCss().getCascadedStyle(e, restyle)); + CalculatedStyle parentCalculatedStyle = parent instanceof Document ? + new EmptyStyle() : getStyle((Element) parent); + + result = parentCalculatedStyle.deriveStyle(getCss().getCascadedStyle(e, false)); styleMap.put(e, result); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java index 99488720a..90c0233e3 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java @@ -1053,58 +1053,6 @@ protected void moveIfGreater(Dimension result, Dimension test) { } } - public void restyle(LayoutContext c) { - Element e = getElement(); - CalculatedStyle style = null; - - String pe = getPseudoElementOrClass(); - if (pe != null) { - if (e != null) { - style = c.getSharedContext().getStyle(e, true); - style = style.deriveStyle(c.getCss().getPseudoElementStyle(e, pe)); - } else { - BlockBox container = (BlockBox)getParent().getParent(); - e = container.getElement(); - style = c.getSharedContext().getStyle(e, true); - style = style.deriveStyle(c.getCss().getPseudoElementStyle(e, pe)); - style = style.createAnonymousStyle(IdentValue.INLINE); - } - } else { - if (e != null) { - style = c.getSharedContext().getStyle(e, true); - if (isAnonymous()) { - style = style.createAnonymousStyle(getStyle().getIdent(CSSName.DISPLAY)); - } - } else { - Box parent = getParent(); - if (parent != null) { - e = parent.getElement(); - if (e != null) { - style = c.getSharedContext().getStyle(e, true); - style = style.createAnonymousStyle(IdentValue.INLINE); - } - } - } - } - - if (style != null) { - setStyle(style); - } - - restyleChildren(c); - } - - protected void restyleChildren(LayoutContext c) { - for (int i = 0; i < getChildCount(); i++) { - Box b = getChild(i); - b.restyle(c); - } - } - - public Box getRestyleTarget() { - return this; - } - /** * The zero based index of this child amongst its fellow children of its parent. */ diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java index 0e7acf339..48aad8614 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java @@ -512,7 +512,7 @@ public List getElementWithContent() { List result = new ArrayList<>(); - BlockBox container = (BlockBox)getLineBox().getParent(); + BlockBox container = getLineBox().getParent(); while (true) { List elementBoxes = container.getElementBoxes(getElement()); for (int i = 0; i < elementBoxes.size(); i++) { @@ -876,31 +876,7 @@ public String dump(LayoutContext c, String indent, int which) { return result.toString(); } - - @Override - public void restyle(LayoutContext c) { - super.restyle(c); - calculateTextDecoration(c); - } - - @Override - protected void restyleChildren(LayoutContext c) { - for (int i = 0; i < getInlineChildCount(); i++) { - Object obj = getInlineChild(i); - if (obj instanceof Box) { - ((Box)obj).restyle(c); - } - } - } - - @Override - public Box getRestyleTarget() { - // Inline boxes may be broken across lines so back out - // to the nearest block box - Box result = findAncestor(bx -> !(bx instanceof InlineLayoutBox)); - return result.getParent(); - } - + @Override public void collectText(RenderingContext c, StringBuilder buffer) { for (Object obj : getInlineChildren()) { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java index b97992697..31b4b549d 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java @@ -27,13 +27,11 @@ import java.util.ArrayList; import java.util.Collections; import java.util.List; -import org.w3c.dom.Element; import com.openhtmltopdf.bidi.BidiSplitter; import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; import com.openhtmltopdf.css.parser.FSRGBColor; -import com.openhtmltopdf.css.style.CalculatedStyle; import com.openhtmltopdf.css.style.CssContext; import com.openhtmltopdf.extend.StructureType; import com.openhtmltopdf.layout.BoxCollector; @@ -611,24 +609,7 @@ public boolean isContainsOnlyBlockLevelContent() { return true; } - - @Override - public Box getRestyleTarget() { - return getParent(); - } - - @Override - public void restyle(LayoutContext c) { - Box parent = getParent(); - Element e = parent.getElement(); - if (e != null) { - CalculatedStyle style = c.getSharedContext().getStyle(e, true); - setStyle(style.createAnonymousStyle(IdentValue.BLOCK)); - } - - restyleChildren(c); - } - + public boolean isContainsVisibleContent() { for (int i = 0; i < getChildCount(); i++) { Box b = getChild(i); diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html index 29a99a9b9..448e79cbe 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html @@ -26,6 +26,8 @@ color: blue; content: counter(footnote) ". "; float: left; + width: 1.5em; + border: 1px solid orange; } .footnote { clear: both; @@ -52,7 +54,7 @@
      -

      +

      Footnote with large text!

      diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index bf5b70a86..764d96a65 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1441,8 +1441,13 @@ public void testIssue364FootnotesTooLarge() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-too-large")); } + /** + * Tests that we support display: block elements in the footnote area + * and that blocks with page-break-inside: avoid do not intersect + * with the footnote area. + */ @Test - @Ignore // Failing badly. + @Ignore // Working well. public void testIssue364FootnotesBlocks() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-blocks")); } From 312e7a1a757948da6b974d915766e3cc0272d2b5 Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 20 Jun 2021 17:14:33 +1000 Subject: [PATCH 24/54] #364 Move footnote tests to their own class and folder. --- .../issue-364-footnotes-basic.html | 0 .../issue-364-footnotes-blocks.html | 0 .../issue-364-footnotes-multi-page.html | 0 .../issue-364-footnotes-too-large.html | 0 .../FootnoteVisualRegressionTest.java | 76 +++++++++++++++++++ .../VisualRegressionTest.java | 38 ---------- 6 files changed, 76 insertions(+), 38 deletions(-) rename openhtmltopdf-examples/src/main/resources/visualtest/html/{ => footnote}/issue-364-footnotes-basic.html (100%) rename openhtmltopdf-examples/src/main/resources/visualtest/html/{ => footnote}/issue-364-footnotes-blocks.html (100%) rename openhtmltopdf-examples/src/main/resources/visualtest/html/{ => footnote}/issue-364-footnotes-multi-page.html (100%) rename openhtmltopdf-examples/src/main/resources/visualtest/html/{ => footnote}/issue-364-footnotes-too-large.html (100%) create mode 100644 openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-basic.html similarity index 100% rename from openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-basic.html rename to openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-basic.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-blocks.html similarity index 100% rename from openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-blocks.html rename to openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-blocks.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-multi-page.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-multi-page.html similarity index 100% rename from openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-multi-page.html rename to openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-multi-page.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-too-large.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-too-large.html similarity index 100% rename from openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-footnotes-too-large.html rename to openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-too-large.html diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java new file mode 100644 index 000000000..49e560c35 --- /dev/null +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -0,0 +1,76 @@ +package com.openhtmltopdf.visualregressiontests; + +import static org.junit.Assert.assertTrue; + +import java.io.File; +import java.io.IOException; + +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Ignore; +import org.junit.Test; +import org.junit.runner.RunWith; + +import com.openhtmltopdf.testlistener.PrintingRunner; +import com.openhtmltopdf.visualtest.TestSupport; +import com.openhtmltopdf.visualtest.VisualTester; + +@Ignore +@RunWith(PrintingRunner.class) +public class FootnoteVisualRegressionTest { + private VisualTester vt; + + @BeforeClass + public static void configureTests() throws IOException { + TestSupport.quietLogs(); + TestSupport.makeFontFiles(); + } + + @Before + public void configureTester() { + File outputDirectory = new File("target/test/visual-tests/test-output/"); + + outputDirectory.mkdirs(); + + vt = new VisualTester( + "/visualtest/html/footnote/", /* Resource path. */ + "/visualtest/expected/footnote/", /* Expected resource path */ + outputDirectory + ); + } + + /** + * Tests that we support CSS footnotes. + */ + @Test + public void testIssue364FootnotesBasicExample() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-basic")); + } + + /** + * Tests that a line of text can contain two multi-page footnotes. + */ + @Test + public void testIssue364FootnotesMultiPage() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-multi-page")); + } + + /** + * Test what happens when a line of in-flow text and a line of footnotes + * do not fit on a single page. + */ + @Test + public void testIssue364FootnotesTooLarge() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-too-large")); + } + + /** + * Tests that we support display: block elements in the footnote area + * and that blocks with page-break-inside: avoid do not intersect + * with the footnote area. + */ + @Test + public void testIssue364FootnotesBlocks() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-blocks")); + } +} diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index 764d96a65..a8acd70c4 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1413,44 +1413,6 @@ public void testIssue649MultipleBgImagesPageBox() throws IOException { assertTrue(vt.runTest("issue-649-multiple-bg-images-page-box")); } - /** - * Tests that we support CSS footnotes. - */ - @Test - @Ignore // Working well, final touches. - public void testIssue364FootnotesBasicExample() throws IOException { - assertTrue(vt.runTest("issue-364-footnotes-basic")); - } - - /** - * Tests that a line of text can contain two multi-page footnotes. - */ - @Test - @Ignore // Final touches. - public void testIssue364FootnotesMultiPage() throws IOException { - assertTrue(vt.runTest("issue-364-footnotes-multi-page")); - } - - /** - * Test what happens when a line of in-flow text and a line of footnotes - * do not fit on a single page. - */ - @Test - @Ignore // Working well but waiting until footnote support is complete. - public void testIssue364FootnotesTooLarge() throws IOException { - assertTrue(vt.runTest("issue-364-footnotes-too-large")); - } - - /** - * Tests that we support display: block elements in the footnote area - * and that blocks with page-break-inside: avoid do not intersect - * with the footnote area. - */ - @Test - @Ignore // Working well. - public void testIssue364FootnotesBlocks() throws IOException { - assertTrue(vt.runTest("issue-364-footnotes-blocks")); - } // TODO: // + Elements that appear just on generated overflow pages. From d1a814ee3bfe8ffa4836e4cbe5310125bef54dc5 Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 20 Jun 2021 17:32:48 +1000 Subject: [PATCH 25/54] #364 Failing test for paginated table with footnotes. Table footer is overlapping footnote area. --- .../issue-364-footnotes-paginated-table.html | 77 +++++++++++++++++++ .../FootnoteVisualRegressionTest.java | 9 +++ 2 files changed, 86 insertions(+) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html new file mode 100644 index 000000000..3d426be00 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Title 1Title 2
      HelloWorld!
      HelloWorld! Footnote one
      Hello Footnote twoWorld!
      HelloWorld! Footnote three
      HelloWorld!
      Hello Footnote fourWorld!
      HelloWorld!
      HelloWorld!Footnote five
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      HelloWorld!
      Footer 1Footer 2
      + + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index 49e560c35..e207c452a 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -73,4 +73,13 @@ public void testIssue364FootnotesTooLarge() throws IOException { public void testIssue364FootnotesBlocks() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-blocks")); } + + /** + * Tests paginated table head/footer is placed in the right place in the + * presence of footnotes. + */ + @Test + public void testIssue364FootnotesPaginatedTable() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-paginated-table")); + } } From 73937041dc0b63eec2a2f64175f079ef015b3250 Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 27 Jun 2021 18:38:31 +1000 Subject: [PATCH 26/54] #364 Implement footnotes called from paginated tables. --- .../com/openhtmltopdf/layout/BoxBuilder.java | 26 +++++++++++++++++++ .../openhtmltopdf/layout/FootnoteManager.java | 11 +++++++- .../java/com/openhtmltopdf/layout/Layer.java | 7 ++++- .../openhtmltopdf/newtable/TableCellBox.java | 20 +++++++++----- .../openhtmltopdf/newtable/TableRowBox.java | 16 +++++++----- .../java/com/openhtmltopdf/render/Box.java | 6 ++++- .../com/openhtmltopdf/render/LineBox.java | 9 ++++++- .../issue-364-footnotes-paginated-table.html | 3 ++- 8 files changed, 79 insertions(+), 19 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index aa65b26c1..bd40ec3d1 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -127,6 +127,8 @@ public static void createChildren(LayoutContext c, BlockBox parent) { // This avoids many warnings and improves performance. parent.setChildrenContentType(BlockBox.ContentType.EMPTY); return; + } else if (isInsertedBoxIgnored(parent.getElement())) { + return; } List children = new ArrayList<>(); @@ -156,6 +158,26 @@ public static void createChildren(LayoutContext c, BlockBox parent) { // } } + private static boolean isInsertedBoxIgnored(Element element) { + if (element == null) { + return false; + } + + String tag = element.getTagName(); + + if (!tag.startsWith("fs-")) { + return false; + } + + switch (tag) { + case "fs-footnote": + case "fs-footnote-body": + return true; + default: + return false; + } + } + public static TableBox createMarginTable( LayoutContext c, PageInfo pageInfo, @@ -1482,6 +1504,10 @@ private static void createChildren( LayoutContext c, BlockBox blockParent, Element parent, List children, ChildBoxInfo info, boolean inline) { + if (isInsertedBoxIgnored(parent)) { + return; + } + SharedContext sharedContext = c.getSharedContext(); CalculatedStyle parentStyle = sharedContext.getStyle(parent); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/FootnoteManager.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/FootnoteManager.java index 9c4c6f0aa..2caddb88a 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/FootnoteManager.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/FootnoteManager.java @@ -158,7 +158,9 @@ private void positionFootnoteArea( // The number of pages covered by this footnote area may have increased // so reserve additional pages as needed. int oldPagesCount = area.pages.size(); - reserveSubsequentPagesForFootnoteArea(c, area, desiredHeight, minFootnoteTop, oldPagesCount); + int newDesiredHeight = area.footnoteArea.getBorderBoxHeight(c); + + reserveSubsequentPagesForFootnoteArea(c, area, newDesiredHeight, minFootnoteTop, oldPagesCount); } else { area.footnoteArea.calcChildLocations(); } @@ -224,7 +226,10 @@ public void addFootnoteBody(LayoutContext c, BlockBox footnoteBody, LineBox line // FIXME: Not very efficient to layout all footnotes again after one // is added. + c.setIsPrintOverride(false); footnote.footnoteArea.layout(c); + c.setIsPrintOverride(null); + positionFootnoteArea(c, footnote, page, line.getHeight(), true); c.setIsInFloatBottom(false); @@ -249,7 +254,11 @@ public void removeFootnoteBodies( PageBox page = c.getRootLayer().getFirstPage(c, line); area.footnoteArea.reset(c); + + c.setIsPrintOverride(false); area.footnoteArea.layout(c); + c.setIsPrintOverride(null); + positionFootnoteArea(c, area, page, line.getHeight(), true); c.setIsInFloatBottom(false); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java index fa6e2d34f..8b4107939 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java @@ -1335,7 +1335,12 @@ public boolean crossesPageBreak(LayoutContext c, int top, int bottom) { return false; } PageBox page = getPage(c, top); - return bottom >= page.getBottom(c) - c.getExtraSpaceBottom(); + if (c.isInFloatBottom()) { + // For now we don't support paginated tables in float:bottom content. + return bottom >= page.getBottom(); + } else { + return bottom >= page.getBottom(c) - c.getExtraSpaceBottom(); + } } public Layer findRoot() { diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableCellBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableCellBox.java index 8e87461c4..90814db7c 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableCellBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableCellBox.java @@ -231,20 +231,26 @@ public void operate(Box floater) { calcChildLocations(); } - + public boolean isPageBreaksChange(LayoutContext c, int posDeltaY) { if (! c.isPageBreaksAllowed()) { return false; } - + PageBox page = c.getRootLayer().getFirstPage(c, this); - + + if (page == null) { + return false; + } + int bottomEdge = getAbsY() + getChildrenHeight(); - - return page != null && (bottomEdge >= page.getBottom() - c.getExtraSpaceBottom() || - bottomEdge + posDeltaY >= page.getBottom() - c.getExtraSpaceBottom()); + + int pageUsableBottom = page.getBottom(c) - c.getExtraSpaceBottom(); + + return (bottomEdge >= pageUsableBottom || + bottomEdge + posDeltaY >= pageUsableBottom); } - + public IdentValue getVerticalAlign() { IdentValue val = getStyle().getIdent(CSSName.VERTICAL_ALIGN); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableRowBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableRowBox.java index 950dac789..27b38a545 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableRowBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/newtable/TableRowBox.java @@ -109,24 +109,26 @@ public void layout(LayoutContext c, int contentStart) { c.setExtraSpaceBottom(prevExtraBottom); } } - + private boolean isShouldMoveToNextPage(LayoutContext c) { PageBox page = c.getRootLayer().getFirstPage(c, this); - - if (getAbsY() + getHeight() < page.getBottom()) { + int pageBottomUsable = page.getBottom(c); + + if (getAbsY() + getHeight() < pageBottomUsable) { return false; } - + for (TableCellBox cell : getTableCells()) { int baseline = cell.calcBlockBaseline(c); - if (baseline != BlockBox.NO_BASELINE && baseline < page.getBottom()) { + if (baseline != BlockBox.NO_BASELINE && baseline < pageBottomUsable) { return false; } } - + return true; } - + + @Override public void analyzePageBreaks(LayoutContext c, ContentLimitContainer container) { if (getTable().getStyle().isPaginateTable()) { _contentLimitContainer = new ContentLimitContainer(c, getAbsY()); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java index 90c0233e3..dd9d5db06 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/Box.java @@ -887,7 +887,11 @@ public boolean crossesPageBreak(LayoutContext c) { if (pageBox == null) { return false; } else { - return getAbsY() + getHeight() >= pageBox.getBottom(c) - c.getExtraSpaceBottom(); + if (c.isInFloatBottom()) { + return getAbsY() + getHeight() >= pageBox.getBottom(); + } else { + return getAbsY() + getHeight() >= pageBox.getBottom(c) - c.getExtraSpaceBottom(); + } } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java index 31b4b549d..bd9b21708 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java @@ -685,7 +685,14 @@ public void checkPagePosition(LayoutContext c, boolean alwaysBreak) { int greatestAbsY = getMaxPaintingBottom(); int leastAbsY = getMinPaintingTop(); - boolean overflowsPage = greatestAbsY >= pageBox.getBottom(c) - c.getExtraSpaceBottom(); + boolean overflowsPage; + if (c.isInFloatBottom()) { + // For now we don't support paginated tables in float:bottom content. + overflowsPage = greatestAbsY >= pageBox.getBottom(); + } else { + overflowsPage = greatestAbsY >= pageBox.getBottom(c) - c.getExtraSpaceBottom(); + } + boolean tooBig = (greatestAbsY - leastAbsY) > pageBox.getContentHeight(c); boolean needsPageBreak = alwaysBreak || (overflowsPage && !tooBig); diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html index 3d426be00..bfd65a087 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-paginated-table.html @@ -57,7 +57,7 @@ HelloWorld!Footnote five HelloWorld! HelloWorld! - HelloWorld! + Hello Footnote sixWorld! HelloWorld! HelloWorld! HelloWorld! @@ -69,6 +69,7 @@ Footer 1Footer 2 + Footer 3Footer 4 From 003b2428a8bf0a367146d5803bbd24adaea6bafe Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 27 Jun 2021 18:54:44 +1000 Subject: [PATCH 27/54] #364 Fix footnote link test again. --- .../nonvisualregressiontests/NonVisualRegressionTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index 558396373..dee39a666 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -463,7 +463,7 @@ public void testIssue364FootnoteCallLink() throws IOException { assertEquals(15.0f, link0.getRectangle().getHeight(), 0.5f); assertEquals(103.5f, link1.getRectangle().getLowerLeftX(), 0.5f); - assertEquals(173.9f, link1.getRectangle().getLowerLeftY(), 0.5f); + assertEquals(158.9f, link1.getRectangle().getLowerLeftY(), 0.5f); assertEquals(15.7f, link1.getRectangle().getWidth(), 0.5f); assertEquals(15.0f, link1.getRectangle().getHeight(), 0.5f); From d894be81404471612e37dce8282ec49e12ea5f9e Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 20 Jul 2021 15:14:20 +1000 Subject: [PATCH 28/54] Fixes #551 - Fix layout explosion with deeply nested avoid page-break constraint. --- .../com/openhtmltopdf/layout/BlockBoxing.java | 64 ++++++++++--- .../openhtmltopdf/layout/LayoutContext.java | 16 ++++ ...issue-551-page-break-inside-avoid-deep.pdf | Bin 0 -> 2529 bytes .../issue-551-page-break-avoid-stuck.html | 2 +- ...ssue-551-page-break-inside-avoid-deep.html | 90 ++++++++++++++++++ .../JsoupNonVisualRegressionTest.java | 7 +- .../VisualRegressionTest.java | 9 ++ 7 files changed, 172 insertions(+), 16 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/issue-551-page-break-inside-avoid-deep.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-inside-avoid-deep.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java index dabc532ee..512383e48 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BlockBoxing.java @@ -26,6 +26,7 @@ import com.openhtmltopdf.css.constants.CSSName; import com.openhtmltopdf.css.constants.IdentValue; +import com.openhtmltopdf.layout.LayoutContext.BlockBoxingState; import com.openhtmltopdf.render.BlockBox; import com.openhtmltopdf.render.Box; import com.openhtmltopdf.render.LineBox; @@ -40,6 +41,10 @@ * properties are also handled here. If a rule is violated, the affected run * of boxes will be layed out again. If the rule still cannot be satisfied, * the rule will be dropped. + *

      + * IMPORTANT: This is quite hard to get right without causing an explosion of layouts + * caused by re-attempts to satisfy page-break-inside: avoid in deeply nested content. + * Please be careful when editing these functions. */ public class BlockBoxing { private static final int NO_PAGE_TRIM = -1; @@ -58,6 +63,7 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta int childOffset = block.getHeight() + contentStart; AbstractRelayoutDataList relayoutDataList = null; + BlockBoxingState enterState = c.getBlockBoxingState(); if (c.isPrint()) { relayoutDataList = new LiteRelayoutDataList(size); @@ -66,12 +72,12 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta int pageCount = NO_PAGE_TRIM; BlockBox previousChildBox = null; + boolean oneChildFailed = false; for (int offset = 0; offset < size; offset++) { BlockBox child = (BlockBox) localChildren.get(offset); - LayoutState savedChildLayoutState = null; - boolean mayCheckKeepTogether = false; + boolean rootPageBreakInsideAvoid = false; if (c.isPrint()) { savedChildLayoutState = c.copyStateForRelayout(); @@ -83,40 +89,61 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta child.setNeedPageClear(false); - if ((child.getStyle().isAvoidPageBreakInside() || child.getStyle().isKeepWithInline()) - && c.isMayCheckKeepTogether()) { - mayCheckKeepTogether = true; - c.setMayCheckKeepTogether(false); + if ((child.getStyle().isAvoidPageBreakInside() || + child.getStyle().isKeepWithInline()) && + c.getBlockBoxingState() == BlockBoxingState.NOT_SET) { + rootPageBreakInsideAvoid = true; } } + if (rootPageBreakInsideAvoid) { + c.setBlockBoxingState(BlockBoxingState.ALLOW); + } else { + c.setBlockBoxingState(enterState); + } + + // Our first try at layout with no page clear beforehand. layoutBlockChild( c, block, child, false, childOffset, NO_PAGE_TRIM, savedChildLayoutState); if (c.isPrint()) { boolean needPageClear = child.isNeedPageClear(); - if (needPageClear || mayCheckKeepTogether) { - c.setMayCheckKeepTogether(mayCheckKeepTogether); - - boolean tryToAvoidPageBreak = child.getStyle().isAvoidPageBreakInside() && child.crossesPageBreak(c); + if (needPageClear || c.getBlockBoxingState() == BlockBoxingState.ALLOW) { + boolean pageBreak = child.crossesPageBreak(c); + boolean pageBreakAfterRetry = pageBreak; + boolean tryToAvoidPageBreak = pageBreak && child.getStyle().isAvoidPageBreakInside(); boolean keepWithInline = child.isNeedsKeepWithInline(c); if (tryToAvoidPageBreak || needPageClear || keepWithInline) { c.restoreStateForRelayout(savedChildLayoutState); - child.reset(c); + + c.setBlockBoxingState(BlockBoxingState.DENY); + // Our second attempt with page clear beforehand. layoutBlockChild( c, block, child, true, childOffset, pageCount, savedChildLayoutState); + c.setBlockBoxingState(enterState); - if (tryToAvoidPageBreak && child.crossesPageBreak(c) && ! keepWithInline) { + pageBreakAfterRetry = child.crossesPageBreak(c); + + if (tryToAvoidPageBreak && pageBreakAfterRetry && ! keepWithInline) { c.restoreStateForRelayout(savedChildLayoutState); child.reset(c); + + c.setBlockBoxingState(BlockBoxingState.ALLOW); + // Our second attempt failed, so reset with no page break beforehand. layoutBlockChild( c, block, child, false, childOffset, pageCount, savedChildLayoutState); } + + if (pageBreakAfterRetry) { + oneChildFailed = true; + } + } } + c.getRootLayer().ensureHasPage(c, child); } @@ -157,6 +184,18 @@ public static void layoutContent(LayoutContext c, BlockBox block, int contentSta } previousChildBox = child; + + if (rootPageBreakInsideAvoid) { + c.setBlockBoxingState(enterState); + } + } + + if (oneChildFailed) { + // IMPORTANT: If one child failed to satisfy the page-break-inside: avoid + // constraint we signal to ancestor boxes that they should not try to satisfy + // the constraint. Otherwise, we get an explosion of layout attempts, that will + // practically never end for deeply nested blocks. See danfickle#551. + c.setBlockBoxingState(BlockBoxingState.DENY); } } @@ -413,6 +452,7 @@ private abstract static class AbstractRelayoutDataList { private static class LiteRelayoutDataList extends AbstractRelayoutDataList { final int[] childOffsets; final LayoutState[] layoutStates; + TreeSet runStarts; TreeSet runEnds; diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java index f714b66e6..8f82ae2e0 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java @@ -56,6 +56,14 @@ * {@link SharedContext}. */ public class LayoutContext implements CssContext { + public enum BlockBoxingState { + NOT_SET, + ALLOW, + DENY; + } + + private BlockBoxingState _blockBoxingState = BlockBoxingState.NOT_SET; + private SharedContext _sharedContext; private Layer _rootLayer; @@ -509,6 +517,14 @@ public void setMayCheckKeepTogether(boolean mayKeepTogether) { _mayCheckKeepTogether = mayKeepTogether; } + public void setBlockBoxingState(BlockBoxingState state) { + _blockBoxingState = state; + } + + public BlockBoxingState getBlockBoxingState() { + return _blockBoxingState; + } + public boolean isLineBreakedBecauseOfNoWrap() { return _lineBreakedBecauseOfNoWrap; } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/expected/issue-551-page-break-inside-avoid-deep.pdf b/openhtmltopdf-examples/src/main/resources/visualtest/expected/issue-551-page-break-inside-avoid-deep.pdf new file mode 100644 index 0000000000000000000000000000000000000000..c0203fa3168621cd4a78840fe1fa8c6ad77c38ba GIT binary patch literal 2529 zcmcguPjAyO6u(>Ackrd!Ce*|)iR~Iqljzb(1182maHw_&tNUkalaZ!k@MXF188~s^ z*-2U_8QP_zYF*cUe}C`yUfR2g&->s-r1$&RpPvLMquG}`a&kiakKgY#_0N(bS!Ofh zf71DSk)_lJPZIwsndvnRQ2d&lo)Vo-j9TcZpXE9!P$5nVO^@Q20Skc1fB|PJ3|{~{ zWbE)5E#=u{bE|WDl-=ueUaXcyc0ZYVx7q60F>PEmBeNk8|IK2ursK#&Lb+XqU8P+I zX1yW)S++?F${mA7qic}(mwK{DhS>uhGmla8k-S>a&Q+3YG*l*zR?`B1uBkF^h<~lu z*(Se5WB^qg(3sHn<_=7qn*Q3QFd*#DpDAq9p9S23)4;tyf3}bfJZ(`Of2Oee^JmG@ z@MnqR_%ju*{k_%cte8^>EuYo}GJSPGkSd|%^cxB2Yr^OqK@MD!@eL|Y$X7hU%N4-| z-%ImdDJ=2I+1lGV`AkyVjg02AT9?s2fEQHi?!Ho*lK14mG-DZ4-IkV&Rq(rJwIph% zq=d=&zodkN0P$c{gkFt^vo*I%GAC1mf+r%$3?Kdj|##su?pVH{T*p z7E7Jme^A$1R$zPDN9RR4&1m%)y@=`fWF$iwMgS^)6^YSs7{yUMgi$aOYBUr|ozka8 d@DIs{#Sd+2jyzZwNnThMfKr_FdZTye - +
      diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-inside-avoid-deep.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-inside-avoid-deep.html new file mode 100644 index 000000000..12b80d462 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-inside-avoid-deep.html @@ -0,0 +1,90 @@ + + + + + +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      + +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java index df8218e00..efa38f9b6 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java @@ -1,5 +1,7 @@ package com.openhtmltopdf.nonvisualregressiontests; +import static org.junit.Assert.assertEquals; + import java.io.ByteArrayOutputStream; import java.io.File; import java.io.IOException; @@ -88,14 +90,13 @@ public void testIssue401PdfANpe() throws IOException { } /** - * Tests an infinite loop when page-break-inside: avoid + * Tests a now-fixed near-infinite loop when page-break-inside: avoid * is used on heavily nested content. */ @Test - @Ignore // Not finishing! public void testIssue551PageBreakAvoidStuck() throws IOException { try (PDDocument doc = run("issue-551-page-break-avoid-stuck", builder -> {})) { - + assertEquals(doc.getNumberOfPages(), 3); } } } diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index 43bcf0b5d..782e9b90c 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1433,6 +1433,15 @@ public void testIssue732NoBlockFormattingContext() throws IOException { assertTrue(vt.runTest("issue-732-no-bfc")); } + /** + * Tests a now-fixed near-infinite loop when page-break-inside: avoid + * is used on heavily nested content. + */ + @Test + public void testIssue551PageBreakInsideAvoidDeep() throws IOException { + assertTrue(vt.runTest("issue-551-page-break-inside-avoid-deep")); + } + // TODO: // + Elements that appear just on generated overflow pages. // + content property (page counters, etc) From 26865702a67fb8a7df0db1c8769c12517a6340a1 Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 20 Jul 2021 15:42:10 +1000 Subject: [PATCH 29/54] Try to solve disagreement about number of pages in PDF. Between Github action server and my local machine. --- .../html/issue-551-page-break-avoid-stuck.html | 2 +- .../JsoupNonVisualRegressionTest.java | 10 +++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-avoid-stuck.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-avoid-stuck.html index 86e0ad5a7..5ddd00d58 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-avoid-stuck.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-551-page-break-avoid-stuck.html @@ -13,7 +13,7 @@ } - + " }, + { "
      ", "
      " }, + }; + + StringBuilder sb = new StringBuilder(); + + for (int i = 0; i < tags.length; i++) { + sb.append(deeper.apply(tags[i][0])); + sb.append("Normal
      Footnote
      "); + sb.append(deeper.apply(tags[i][1])); + } + + runFuzzTest(sb.toString(), false); + } + /** * Runs a fuzz test, optionally with PDFBOX included font with non-zero-width * soft hyphen. @@ -1082,7 +1143,7 @@ private static void runFuzzTest(String html, boolean useFont) throws IOException builder.run(); // Files.write(Paths.get("./target/html.txt"), html.getBytes(StandardCharsets.UTF_8)); - // Files.write(Paths.get("./target/pdf.pdf"), os.toByteArray()); + // java.nio.file.Files.write(java.nio.file.Paths.get("./target/pdf.pdf"), os.toByteArray()); System.out.println("The result is " + os.size() + " bytes long."); } From 3c5fe74aad9441eb11debbf4d54ab95dbb2e5b86 Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 6 Sep 2021 22:47:33 +1000 Subject: [PATCH 53/54] #364 Java2D manual test for footnotes. Multi-page output is correct. Single page output produces footnotes in between content which is nonsensical but we are primarily a paged renderer. --- .../testcases/j2d/Java2DVisualTest.java | 12 ++++++----- .../j2d/expected-single-page/footnotes.png | Bin 0 -> 4058 bytes .../visualtest/j2d/expected/footnotes/0.png | Bin 0 -> 3338 bytes .../visualtest/j2d/expected/footnotes/1.png | Bin 0 -> 2369 bytes .../visualtest/j2d/html/footnotes.html | 19 ++++++++++++++++++ 5 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/j2d/expected-single-page/footnotes.png create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/j2d/expected/footnotes/0.png create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/j2d/expected/footnotes/1.png create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/j2d/html/footnotes.html diff --git a/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/testcases/j2d/Java2DVisualTest.java b/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/testcases/j2d/Java2DVisualTest.java index f8650deb8..87b1883f9 100644 --- a/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/testcases/j2d/Java2DVisualTest.java +++ b/openhtmltopdf-examples/src/main/java/com/openhtmltopdf/testcases/j2d/Java2DVisualTest.java @@ -14,7 +14,7 @@ public class Java2DVisualTest { private final Java2DVisualTester vtester; private final List failed = new ArrayList<>(); - + private Java2DVisualTest() throws IOException { File outputDirectory = new File("target/test/visual-tests/test-output/j2d"); TestSupport.makeFontFiles(); @@ -25,7 +25,7 @@ private Java2DVisualTest() throws IOException { outputDirectory ); } - + private void run(String resource, Java2DBuilderConfig config) throws IOException { if (!vtester.runTest(resource, config)) { failed.add(resource); @@ -34,11 +34,11 @@ private void run(String resource, Java2DBuilderConfig config) throws IOException failed.add(resource + " (single-page mode)"); } } - + private void run(String resource) throws IOException { run(resource, (builder) -> {}); } - + private void runAllTests() throws IOException { run("simple-blocks"); run("simple-text"); @@ -48,11 +48,12 @@ private void runAllTests() throws IOException { run("positioned-elements"); run("images", builder -> builder.useSVGDrawer(new BatikSVGDrawer())); run("sized-repeat-images"); + run("footnotes"); // If you add a test here, please remember to also // add it to runOneTest (commented out). } - + private void runOneTest() throws IOException { // run("simple-blocks"); // run("simple-text"); @@ -62,6 +63,7 @@ private void runOneTest() throws IOException { // run("positioned-elements"); // run("images", builder -> builder.useSVGDrawer(new BatikSVGDrawer())); // run("sized-repeat-images"); + // run("footnotes"); // If you add a test here, please remember to also add // it to runAllTests. diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/j2d/expected-single-page/footnotes.png b/openhtmltopdf-examples/src/main/resources/visualtest/j2d/expected-single-page/footnotes.png new file mode 100644 index 0000000000000000000000000000000000000000..20a9735c7ba56c1ed5c6e39b494386c66bdc28ec GIT binary patch literal 4058 zcmb_fXEdB`w-$-sOOOyEIwMMy7~>T+MDG)A7$MOGqlS5t=tD%5=v}lSW-xj;gi#`T zuY+g_(FJGZJ!^gITj$R?-#R~@`&sLH_TJCF*S+_BT{}`=_c0CSZAu~{A{tE%RYSu2 z3*lKNCnl_V27MqRBDx$+RV8D;sqKs)4dY3!@HIMadR6HA_q+`3=-Pn3unOgPV)!I)qpmMUK74jG&KF6J*H&hv) zRYq7?SZ>F3X??u!h*1dGFKV-ysE3tqho`ABb*o+`=78G=2M4p&936$6VmajA>|qhC z($jOzL4oI|2g{?nCjV`fo0F3>r>d<@ZC#8;OWrJ*?2Uu`6@}+;M!HU8789LZTsY45 zG86)Rj&^3f)&^ptqdNhP#ZCUdR#T;&Mf<;YDK`!nS@8WN9at`$OTh)4S53GF6QTYsMF;$?ZrCr72MJ+Hchg*{u7Z)ih zDM3L&%+9@?<`p)tKY#vF58HI;OMd-xAVa?7a1W0o-~Co9E-XyRecCfP*iGW)<>l<` z%nnP?lrmVOXJpLvrv-1`O;>~m8yXtg*xc<6r{lu7MLl6d_Uo_4!GBGJAC`dS{ z+znAvQ!63!4y70HCu|mp1Z<9SV^fJyN%yTvf{hRe1jFjeN_6!Np78K+vi9y+E}qU7 zS+^Osz$4j6e&E{AjZqQu*Sf}Z=jZ2Nv9q&xNVHU9y2J5#sm#Xlv5Q%#6&v zi_@M_$9v$~bHv^!oiu=aVL^c{l^X+qMuJ6mA`Q!%PSm)+yNe2`uC8WlrKF@377>vc zg|5xbSw~4rLrsj0iz*5VNETQ7)1*bOv9Z%~Jp9}C`m`AmJTy63ES4mC72B6n(0vk( zMSH2MlVWD-VYqK!0}LKoyC+kM%Cp6&Bb$un`1nYw+uGW8cXyNNt*opV4)^!<37O;e z_P$4irjRt)3M<|EH9$BT1K7_6r8_7Wms~GeHc*8IB{{i1&Q;rxP>e+;K2Fww=a+HS z;AA}mJRTp)*9cUJe#X3Mhd9{7YXN*&#H^!ZY8g5v-j)m(>TO2Y+cBMcY3S&vv9Yp- zpS4X)Oi+xEV-O@dO-)Ux-|bccVXamTKE-K7Q3nQCVrgk<@LY)*mq_B)mP_@(XbPpP zV=kQb`t|GbK3lDLvkYEd-t`t9n+9-pef`uP>0THO`-k{=p|Qei=2bN{H5klN0KAsp z?)%P8m*nrs%I8KGitW@BV`HD@N<3JSXCM7rzvB#AgJ61kv8#o!5U9?F4<8uwhF*xX z85$X3ANMr45>8X@Yu>k80fB*|hpVd&!b>yIgM)**`g#JA1%&ki#TMQ+mmz7dq0wk$ z&Dz>p>2}hM8%s#2tqa=$#bq}$uA?Kbv{cLW)$S6>?@!=iCFIo96dw1nl(%nv{l!7? z7eQ2))@45qr^1w&N!U@qL5aQk+3DtI`0*lH5K6{v=0%2N!MB}}6L2S5_Jl1VDJd*G zJTM?27t`FF2@N9V1o>6KFM};LEbErLV-?{SuaMy7f=laKk2au*QrS0i3kwEQ6O*TF z$L|D8{r&wPJt7L|0!xEH)N=Y4_>T}I_9`qBu(#Cg^FU9}?$J^BJH1R$4mgV_G2HQ- zqNN%P{NBQrG&3`ko10s4KB#zUY{tq%+5V&Xj24fg*s`O$mS%#9e)8&XskOnZnh1OM zz1@X{g>*TuB*4?$4@KgZwq#rCC=Ok~`To3n^9iZFcDCZhF;5q%qGC&OGMl!wppAN( zM@*>7{{DU|dr`KblspjlCoOQnZMzkmc+Q6+jQhOqKOrD}_QJ!gzjn>GpQ>`JqL~7<4l26*4odl~`mtYH+(wV~t)*@tk#;M%xhQYPpb_ zdi$V}`ND**CVRBnd3;1wCKC)!5<-orSpD&g7GkWd#4kqd?Ch}1y4kShfoTPjzUo|( zBo~e_87I@D(7Stk%Ewq%2w1EMC61oyb>t-WGF4W7BW!`-+tT~Xl#Xa;x`wW%Xrr7- z_7*da0sBq!vbrw}5_FJADUrbq5ERts4wDEeH7)yg3#Bgc1P~Y>i<;{OYHurgt@h2# zST@fteANb?v(j`spyBIzzA)Hq3mnoENZ_geKLY!=Uie?o=H!>wzl%y3^|FE|_&bHL z^`2_K57W8^JHpYJ3VpVirEh%On8&e{Z@wOo}BcEC>$168IN(w-NTu~ zovc02FyNNpnWi3(T63AIvVj80vew%%Mx~LNvXu35g zx;k((F3vNl%H!83aAg+=^ZFfa9f8-N0~{!yvZC^_hrPV1)U;8JAe2i=vVz6&8KO^n zX#BDNr%*5z3poUWa?41TPzm$hNp=>4BypG5-xGckwl1Iuxj{l9D?2nMb1E4B!t=Od zhAc2sjt7mdRZUZeids2w@@NgtD_PFPNs>-HwPP@nNwU*qzVh+NsHS_DWF-Ft*g_;KN>%A~5t7-~7Om+n zcK$LLB`n-$tA(JJbsxjrkdj4QCtGQZ+!is77#N`FL>Fj2i9%A+vh419Dtp5cZT0A` zTmZhIK&WkbrX+AsQf-)g?WNdr>83d4Rdo#BSI-akYl;^O-Qg% zFRpMQ!R3e3{9h+$9*e|RW~piTYEA9m@H08M^`Y1AW9IY^+g5i#f=7*>p+LE0aCJ5G z#M9q(b&z#vXle369fOFd_B#d!=old7(t9u8?^jpjrJo6_SnsPx`%G+tXKf1t+HwJc zvNBQo-V*MaPdc~#{rC(FyTSusd!(O+ig z=LHD8%rDy{B%TcpXb|?a(?%6F@YL_%$va9;&eiC}i{RqWh6cd8vEu*)n9}b9lYS_e zg#n{G(-T7%DXZ5xm~Zy%m067REMg70)v2f)9X+YW4uB>=sH20-^k||J8#Avv(QY0Z zjdA~I(sCh;gJ0@oa99(1>XzH&o*S8^mbCD?@%M;=lt~veGeW`8Qz5sud=-VYwzA;) zwN8#29OlS5>pC_{a{A8@oQEGcB&_!iQ2wA~#PAM23(hH;~STkTT@u&d(Hy*t+W_XJACA+ z@X04r&S+&d^~m_v=;K&Jfo>*ekodAq{g7qzx-rZ<0)AP&{MxXgeq)32=ttT-6H4%S z9`4;!-1$ESfK*fFf3)~=kllkEaQyO@I3Cisi}zZFZF zyAQ**3knK4Iy&m=>Zn-nTUNao%25foE=?d!X_HO<__4-i5>3z|XJ=>69UKm0URi6P z(yak73KeDLS3yDJWfrn_UDP4I>XH$tF{Ov_i{JVA`K_&w66j)Agi6EW;^Ih|VzuWV zH&j|y;4P~&gaelxfGxEIL+<|nt_{7A}y|FlIvM6btPV;*2;@hH8SE4sr zG6K>RK*9|IfjHA7BM2$vAQ~D1TZG<%r8_l-XJ$ZBQu*qV{d1Os;chJxI9U7 zdhz0sKf;9c^uB z(>4NdoKICdI|2EJl>ppK5k?GMSnOi3xQvWX`$6?KRLRKQ-5t>4F&@e7FMPfv}LOSwA~UhPU*nS2h*A-6JL`-+u85Qyyg$-3a_ z&t-@@%VeNl5&e4<4kZrYb2Zy|KELFX)zn#nLeI z!*yYOMUG#;e%;*Mbe(TaQ3whO^8T2mb9dvXjF#6ky`aMKatA1adRL~kHf(XE>Cu7r zG+NfvrvX-GdiI5H--6ZE1K1l&x_FP)A&WP)wXXdm)F?T)+nw~Jgal*BZzvRMEG{B460D=MW`Gq# z^y%4U>qCD5E54Y7uKwuZV4rFGiheFGE@sFtwGt(Nd3WUqX)|j>X4yMCn%-tdP(inE z_wh*!z@JUfaZ+NUqNK2R@y`9oi%-v9+$nIcxw&s}Vghx=_H@w3=BDB{dou{NR990o zus+>|ImJ8mb79zk?}14l9|D2srnj~p;D2?@D=RK8PFUf5QKntkYeloTb9XlYgG{C? zYN{)@{31aYx(4JSo==XQPC`;FNn*f)coiDr`MxuZVvno@`Kv%Ey@x!jXwv@AObPo8*icXo8tMy#A5xN0x_ z_(6n~iIftF#-0j>cVgzY)@DQ0_hrZ>A2!7L@=UIL|L7kOpd;Ct!#TixW#JcK^Z-#O zIVHu)#?!Na(R1grZnqCipqiITr4B?EuddIt91T1>9#{K+L7J>CFPk#ZXD@@kBorXd z^N=eli82Jy7vzPx0WuHt_wqNZnCTA%Y_E;t`r;> zyCx3Zw{PD7tyHVo&XP>6h6RpN>7m}^%@~#DN7CO9L$ZycM~p!Rb<(+JZf?LzHD}Vh zl`&4O92maJ(vZ{^5)h!R3p!+HaEC1n6(8nSVSptB9}@`3$kMX&p{h1EHh#JO72?cZ z`UbGJuI_CBD~?spi@{(tcg^43BOBY;VAl67cciPmMGu;islwg)6bgk*7WuV38$vE< zXpm?9j>DmYXAO}L-{VBhyLDF`Bd>+g`?dj9m*;)THnd9T* z&0tL3tMYOe&F&qVjK01;B*M&$M`8(0);BO{sIPzc@ZqN%Lw|XxpHL%b=XfrDetyQJ zjEqc)o1pQL997BharZ`lM%$9vY&Mh0gnWGp4jcp1w?vv%H8gS!!pa0_iCC=DD0WrM zpZIfhbu~EH@hiVykwMskj~X*g$@Y-EJ_^JrftHfY3Lyj8`U)38R*zCl+}+*7!)qEF zjr>YWN>mtOW9@ilt7KqPQggOJ$V}htm+}C*tP1-VCsP=C0)9^z0|N#RaNy; z`0|8JWV7kky9YdeZ&s+bbI!su&HU;p0ztM+0Ojd>gl@JnDyjb_z{A- zTm=J)NU*{}FCQx@nQ#bx9sFYkYU}*UxrHOnI=WBK+QiSyP*osEMD6j=dC_B5*uknv z)nZ5I6O!tc9|DL47H6NHHu;Me+h*$*+h>g=_Pr29i;f}|T z-^8u+U~~eqJkx4!nt0*yA)w6-$BoVQxs|CixKTP?-yzyQxM?PFedap%JEPT^`2wRH z4F*PxfR1YLeAttH&pwv`A6hevG`EOdZIM*2C05kCO-v+^K(|&3Gc?UYr+*MR2xpTA zO4~nDKa^c959Igp0a&GUgottY9K&FkG*`atT%WJ>>kuc0zH$RJ)T0>aLJo$o4)Hl6 z$+)0h`YL@|SfM#tzEV|*ZVig84Gw9i-RGjjx_oR&%!3)>IXo;79j$pQA51Wij@ihKk>Z- zfWq4}(<25fKq`QxrSUGKV*ECyfAD1Eppby5cUMRE^_P?&EA}$3tt+hQ*^na)gjA=97WC_$4AGKQ|^78sXu zlwznW4Cwt)^nHBi#!D@4^Q*Z9JH}A(jka*(L@nPm-~oK@hWPXNU_|ynolByu6779s zMhs9^fRmdd>>baWLD2Mq(}svQ>~F$*%Ns@Dj|GL6Fhw4%sCNgLB=Nx&@U4r8+kH{{~Ett{t!L2+t_HgljUfPquS$ zc2a&TW$USV#b<6r-L|3}TyzFt3$7f@%Y(F5oZjS0P>@Kkj;JDS&4V*{XEkOf){*^v zZF6x#xpHIfCGaLg zw|{&b)sB@|wh7o=)^MNHDx&ceGOvCsJEqPnXdL3BvSxXmbDs(R{Uu$w2n)*&Z7+lI zeaMh7TmTF8f+E0|jM-!_lTDykbCqtu=m23=f|=R%s+5Zve&^5`*0xozAtL>mnSJd$ z&9ZzXUD%D_w;H@qb@lPwXkd6=UtS)Q+5D}Q&}FW@|M$+5QxT8%p7#GvU;p#3fGxbs ZW7<#)dt}u`=lpTFY%J`}%S^95{0|}9YHpt;b?>KXH%IcQ7tlRhb5A% z;Ck7`qwR#43;wE&zb-*etlL1&T3_B5Pjo*f0a8cHr4Z>{xYzaeO9N3}sG-nV^Iy?v z`fkin<1O2+DRz1@tv`;lxHh5J`JMBvEC>(&Y}6m1Eir1`@TLqPb6^($<3IcuA!scm zkzT)jTToMz<+c~4d@3+7P$9Ocq9S=m9alhIY!C_h<>loqu3WhWh1zDHmsM8AO}vwG z5%749P$<;PYkp~>xgbBENF*8<8a^Xq`d_M@I<>O0l5HGzNlVMi!()2M3pT>zRWcaY zkx1O~WNTt#VtYEUth7`~$1O)||n3%v| zNi-TQDl#&%vLZgJuC6XPIG98t!Csb>V0~}7x@J$QlF8(UZE2~gQ&Ur^+1XlRmIDI= zcWx)b<#I3K*en(+Ki{may1F_#u&^;EI$GB;c6!=lzow>U5r@ey{PF_0g`J2Z1#Hz~k#u&=$%5SS-6Vz|!*R2T4iEfqgt4Z;{CLNb;hO7uDC-YtIV= z$$RNLPodGEmCm!A^76+B3k!OD{4Xbus;Z{zg266r5C{a;+1kno)X~&TCT?%zKQ^qc zt|BX19q$N6$HtC(0t;Lbh|{GMo1C_mmPDy;F4y|a#zt@>2!t9W|82^+y_5)n`TCao z4X0Ua=;^_nJv}`i5ktU(Dzea3`@73aOV3YoqL`U&*E}@RIA2R$s^S(7#YZ5_{QMYE zR4R4ZC?hF}DcHaYQBTQuJl_9X62<0*SZqv89N}?ulb*`4$so^=V|yuznBd^*7cWf6 zBN?KO4y&(u;`2x?QdO0quI~Gm?6kCpi^CV}8Mmuamov|LCcevT96GQj97%UyA08eK z_e@jv_4n^tFMhKvealGu&2zaQ-{L>kF#o-6TQM!Y&ohte7PjR>cx)dN_=SAW$1vF1 zYKHe@-_#h1UBhj@S)H$?keVfE__*LMe!d719*!lehOt<)JT?fqIDbwRto!0-FuIu+ zd05Qm4DWp+JHVnoDVYW7FLQyoS22MK$9RjApD~0hS5!*QHEzzF6umn#m+1+2&E~7! zAFeBvlcQs@e1*A-3Uc|mc;}ppG;D}9AFT>;baJqM7W4EvpRaNHYHB*I$$b8T9O~j% zx`eo$rDa>610gb!$Fnu=BXzJ}&-Q{+j94rUEh}X(`8Rb{TslsYTGE3n^u*9gibta# zM(x<9Tt|+}1<~o}7`HLdVC0N-#ummQ4;!NeK&i5YRjJ%}DG*J))9g21d2s zJoD)ZAut$+tlegNvmdnP?u0X66>8!_S7iA!)4~LVZ4x4EtBAw-5YRQ-ma9^`dbO9J zIwX$)LMFAQK2uy>;n3JQp_92eFJVwdU?~e--^AdU2EXw?A(5Or{*CpQUHVCH!?R@T|z;jC~cj&`uWWb>e@)Z6Jd?3=vJ(F)6UTQXhXuQ zHMpYA%y;R$&+Q~ zZ#ifKZM$Bk&`RiAkM12l`axfgOc5AW`3SB}_zaAVO&ew@UsJb3 z(Vvjpi{Mbu3Q9_9R#)A#CbFZ5p)qimc`|L5>p_4?Nek?LK_~*f>*HKdBVlDt`teVE zi<_Jg?+K*QTdYd*+h?!ecTHtz?4Q#b9_z1 z8bx!ok9o))&$cs%!sVk`9J++Wigmz*nXkw6YI?%Lx%=MELa8HC&B#((jgh$ z8&nEBkj0|-6>PR0+-;tPsQL5EPZ=t1^XER*Q1IJ>;lLD7%G}yWpR_T;Se|ia{i9FI yBpkH|wda_^E`Z(bKg2)e{}241lli>*JqKr^x?AP}!kw=Xz|!32@=LQ@5&s5Qs$LHO literal 0 HcmV?d00001 diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/j2d/html/footnotes.html b/openhtmltopdf-examples/src/main/resources/visualtest/j2d/html/footnotes.html new file mode 100644 index 000000000..fbeef961d --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/j2d/html/footnotes.html @@ -0,0 +1,19 @@ + + + + + +This is normal flow. +
      + This is a footnote! +
      +More normal. +
      + This is a footnote! +
      + + From 594b840b41e59ee82c4d21115c3a972c31641d7c Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 6 Sep 2021 23:00:33 +1000 Subject: [PATCH 54/54] #364 Due to a stack overflow on GitHub actions we will try a smaller nesting value. --- .../nonvisualregressiontests/NonVisualRegressionTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index 6117c658a..f3c21b1fc 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -1096,7 +1096,7 @@ public void testIssue364MuchText() throws IOException { @Test public void testIssue364FootnotesDeepNesting() throws IOException { Function deeper = (tag) -> - IntStream.range(0, 200) + IntStream.range(0, 50) .mapToObj(u -> tag) .collect(Collectors.joining());
      diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java index efa38f9b6..ab98b5ce0 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java @@ -6,6 +6,8 @@ import java.io.File; import java.io.IOException; import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; import org.apache.commons.io.FileUtils; import org.apache.pdfbox.pdmodel.PDDocument; @@ -96,7 +98,13 @@ public void testIssue401PdfANpe() throws IOException { @Test public void testIssue551PageBreakAvoidStuck() throws IOException { try (PDDocument doc = run("issue-551-page-break-avoid-stuck", builder -> {})) { - assertEquals(doc.getNumberOfPages(), 3); + if (doc.getNumberOfPages() != 3) { + File pdf = new File("target/problem.pdf"); + doc.save(pdf); + String pdfStr = new String(Files.readAllBytes(pdf.toPath()), StandardCharsets.UTF_8); + System.out.println(pdfStr); + } + assertEquals(3, doc.getNumberOfPages()); } } } From f92575b05bf46cce0e2ae56b1b04249cd25c7acd Mon Sep 17 00:00:00 2001 From: danfickle Date: Tue, 20 Jul 2021 16:07:18 +1000 Subject: [PATCH 30/54] Take 3 in getting agreement on page count. Hopefully, caused by difference in line breaker. --- .../JsoupNonVisualRegressionTest.java | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java index ab98b5ce0..40294bfb1 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/JsoupNonVisualRegressionTest.java @@ -6,9 +6,6 @@ import java.io.File; import java.io.IOException; import java.io.InputStream; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; - import org.apache.commons.io.FileUtils; import org.apache.pdfbox.pdmodel.PDDocument; import org.jsoup.Jsoup; @@ -97,13 +94,7 @@ public void testIssue401PdfANpe() throws IOException { */ @Test public void testIssue551PageBreakAvoidStuck() throws IOException { - try (PDDocument doc = run("issue-551-page-break-avoid-stuck", builder -> {})) { - if (doc.getNumberOfPages() != 3) { - File pdf = new File("target/problem.pdf"); - doc.save(pdf); - String pdfStr = new String(Files.readAllBytes(pdf.toPath()), StandardCharsets.UTF_8); - System.out.println(pdfStr); - } + try (PDDocument doc = run("issue-551-page-break-avoid-stuck", TestSupport.WITH_FONT)) { assertEquals(3, doc.getNumberOfPages()); } } From d33008f3c2c87747488e0733f30a58c305745744 Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 1 Aug 2021 14:23:36 +1000 Subject: [PATCH 31/54] #364 Failing test for position: fixed content. It is sitting above the footnotes. --- ...ssue-364-footnotes-positioned-content.html | 52 +++++++++++++++++++ .../FootnoteVisualRegressionTest.java | 10 ++++ 2 files changed, 62 insertions(+) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html new file mode 100644 index 000000000..aba45675a --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html @@ -0,0 +1,52 @@ + + + + + +

      + This text needs some footnotes. This is a footnote. + Also a footnote for this sentence. Another footnote! +

      + +

      + Footnote numbers. Just to be silly this is a really long footnote that will need wrapping and such. +

      + +
      +
      + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index e207c452a..9c2ae1dd7 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -82,4 +82,14 @@ public void testIssue364FootnotesBlocks() throws IOException { public void testIssue364FootnotesPaginatedTable() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-paginated-table")); } + + /** + * Tests that positon: absolute and fixed content with bottom: 0 sits + * above footnotes. + */ + @Test + public void testIssue364FootnotesPositionedContent() throws IOException { + assertTrue(vt.runTest("issue-364-footnotes-positioned-content")); + } + } From c13438373d091dffae3b5cadec49a7135c3b545c Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 1 Aug 2021 14:59:25 +1000 Subject: [PATCH 32/54] #364 When positioning fixed elements exclude footnote area. --- .../java/com/openhtmltopdf/layout/Layer.java | 2 +- .../render/RenderingContext.java | 37 ++++++++++++++++--- ...ssue-364-footnotes-positioned-content.html | 8 ++-- 3 files changed, 37 insertions(+), 10 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java index 8b4107939..5b27419d8 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/Layer.java @@ -817,7 +817,7 @@ private void paintLayerBackgroundAndBorder(RenderingContext c) { } public void positionFixedLayer(RenderingContext c) { - Rectangle rect = c.getFixedRectangle(); + Rectangle rect = c.getFixedRectangle(true); Box fixed = getMaster(); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java index 6922af355..422a5061b 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/RenderingContext.java @@ -144,7 +144,13 @@ public FSCanvas getCanvas() { return sharedContext.getCanvas(); } - public Rectangle getFixedRectangle() { + /** + * Get the document (for non-paged docs) or page rect where + * fixed position boxes should be layed out. Generally we want to set + * excludeFloatBottomArea true so fixed content doesn't sit + * above footnotes. + */ + public Rectangle getFixedRectangle(boolean excludeFloatBottomArea) { if (!outputDevice.isPDF() && !isPaged()) { return new Rectangle( -this.page.getMarginBorderPadding(this, CalculatedStyle.LEFT), @@ -162,21 +168,40 @@ public Rectangle getFixedRectangle() { if (! isPrint()) { result = sharedContext.getFixedRectangle(); } else { - result = new Rectangle(0, -this.page.getTop(), + if (excludeFloatBottomArea && + this.page.getFootnoteAreaHeight() > 0 && + !this.page.isFootnoteReserved(this)) { + + // Generally, with bottom: 0 for fixed content, we do not + // want it sitting above the footnotes. The exception is + // multi-page footnotes where the entire page is reserved + // for footnotes and so we don't have any choice. + result = new Rectangle( + 0, + -this.page.getTop(), + this.page.getContentWidth(this), + this.page.getBottom(this) - this.page.getTop()); + } else { + result = new Rectangle(0, -this.page.getTop(), this.page.getContentWidth(this), this.page.getContentHeight(this)-1); + } } + result.translate(-1, -1); return result; } - + + /** + * Get the viewport rect, for painting the body or html tag background. + */ public Rectangle getViewportRectangle() { - Rectangle result = new Rectangle(getFixedRectangle()); + Rectangle result = new Rectangle(getFixedRectangle(false)); result.y *= -1; - + return result; } - + public boolean debugDrawBoxes() { return sharedContext.debugDrawBoxes(); } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html index aba45675a..659be8f7c 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnotes-positioned-content.html @@ -2,7 +2,7 @@ + + +

      + This text needs some footnotes. +

      +
      + This is a footnote. +
      + Also a footnote for this sentence. + + Another footnote! +
      +       +

      + +

      + Footnote numbers. +

      + Just to be silly this is a really long footnote that will need wrapping and such. + This is a multiple page footnote so here we go on and on to get to the next page. +
      +
      + +
      Footnote 4
      +
      Footnote 5
      +

      + + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index 9c2ae1dd7..42866de8c 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -84,7 +84,7 @@ public void testIssue364FootnotesPaginatedTable() throws IOException { } /** - * Tests that positon: absolute and fixed content with bottom: 0 sits + * Tests that position: absolute and fixed content with bottom: 0 sits * above footnotes. */ @Test @@ -92,4 +92,19 @@ public void testIssue364FootnotesPositionedContent() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-positioned-content")); } + /** + * Tests that position: absolute and fixed inside a footnote (or + * as a footnote element) does something sensible. + *
        + *
      • Fixed inside fn will escape footnote area and be positioned on page as normal fixed.
        • + *
      • Absolute inside fn will be contained by footnote area.
        • + *
      • Fixed as fn element will be positioned as normal fixed but will not have footnote mark.
        • + *
      • Absolute as fn element will be contained by html layer and have footnote mark.
        • + *
      + */ + @Test + public void testIssue364PositionedInsideFootnotes() throws IOException { + assertTrue(vt.runTest("issue-364-positioned-inside-footnotes")); + } + } From 53e7c8ba5b2a1c73c1f2e650f2be3826f3c6bad4 Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 9 Aug 2021 16:24:25 +1000 Subject: [PATCH 34/54] #364 Tests floats in footnotes, floated footnote calls and floats interacting with footnotes. Minor fix to prevent anchor element being stripped from footnote calls which are floated. --- .../com/openhtmltopdf/layout/BoxBuilder.java | 3 +- .../html/footnote/issue-364-floats.html | 70 +++++++++++++++++++ .../FootnoteVisualRegressionTest.java | 16 +++++ 3 files changed, 88 insertions(+), 1 deletion(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-floats.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index bd40ec3d1..bec58a4c0 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -1132,7 +1132,8 @@ private static List wrapGeneratedContent(Element element, String peNa iB.applyTextTransform(); if (iB.getElement() == null || - !"fs-footnote-marker".equals(iB.getElement().getNodeName())) { + (!"fs-footnote-marker".equals(iB.getElement().getNodeName()) && + !iB.getElement().getAttribute("href").startsWith("#fs-footnote-"))) { iB.setElement(null); } } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-floats.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-floats.html new file mode 100644 index 000000000..830c82085 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-floats.html @@ -0,0 +1,70 @@ + + + + + +

      + This text needs some footnotes. +

      +
      Floated 1
      +
      Floated 2
      + This is a footnote. +
      + Also a footnote for this sentence. + +
      Floated 3
      + Another footnote! +       +

      + +

      + Footnote numbers. +

      Floated 4
      +
      +
      Floated 5
      + Just to be silly this is a really long footnote that will need wrapping and such. +
      Floated 6
      + This is a multiple page footnote so here we go on and on to get to the next page. +
      +

      + + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index 42866de8c..1a25d5784 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -107,4 +107,20 @@ public void testIssue364PositionedInsideFootnotes() throws IOException { assertTrue(vt.runTest("issue-364-positioned-inside-footnotes")); } + /** + * Tests floats in footnotes, floated footnote calls and floats + * interacting with footnotes. + *
        + *
      • Footnotes calls may be floated (typically right).
        • + *
      • Footnotes act as float containers.
        • + *
      • Floats work in footnotes.
        • + *
      • Left floated content will appear left of the footnote marker.
        • + *
      • Footnote area will clear floated content above.
        • + *
      + */ + @Test + public void testIssue364Floats() throws IOException { + assertTrue(vt.runTest("issue-364-floats")); + } + } From 25a3b34504852f875f2d3207d7913a45fbf49876 Mon Sep 17 00:00:00 2001 From: danfickle Date: Fri, 20 Aug 2021 00:41:14 +1000 Subject: [PATCH 35/54] #364 - Images with footnotes. With more work on correct boxing, so that images may now be used as footnote calls and footnote markers. --- .../css/style/CalculatedStyle.java | 2 +- .../com/openhtmltopdf/layout/BoxBuilder.java | 125 ++++++++++++------ .../html/footnote/issue-364-image-calls.html | 50 +++++++ .../footnote/issue-364-image-markers.html | 50 +++++++ .../html/footnote/issue-364-images.html | 72 ++++++++++ .../NonVisualRegressionTest.java | 5 +- .../FootnoteVisualRegressionTest.java | 23 ++++ 7 files changed, 281 insertions(+), 46 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-calls.html create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-images.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java index 3a6ef1099..8a4d659cf 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/css/style/CalculatedStyle.java @@ -245,7 +245,7 @@ public CalculatedStyle overrideStyle(IdentValue display) { ret._parent = this._parent; System.arraycopy(this._derivedValuesById, 0, ret._derivedValuesById, 0, ret._derivedValuesById.length); - init(CascadedStyle.createAnonymousStyle(display)); + ret.init(CascadedStyle.createAnonymousStyle(display)); return ret; } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index bec58a4c0..f6fed54cd 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -829,16 +829,9 @@ private static String getAttributeValue(FSFunction attrFunc, Element e) { } private static List createGeneratedContentList( - LayoutContext c, Element element, PropertyValue propValue, - String peName, CalculatedStyle style, int mode, ChildBoxInfo info) { - List values = propValue.getValues(); - - if (values == null) { - // content: normal or content: none - return Collections.emptyList(); - } - - List result = new ArrayList<>(values.size()); + LayoutContext c, Element element, List values, + String peName, CalculatedStyle style, int mode, ChildBoxInfo info, + List result) { for (PropertyValue value : values) { ContentFunction contentFunction = null; @@ -850,15 +843,18 @@ private static List createGeneratedContentList( if (type == CSSPrimitiveValue.CSS_STRING) { content = value.getStringValue(); } else if (type == CSSPrimitiveValue.CSS_URI) { - Element creator = element != null ? element : c.getRootLayer().getMaster().getElement(); + Element creator = element != null ? element : c.getRootLayer().getMaster().getElement(); + Document doc = creator.getOwnerDocument(); Element img = doc.createElement("img"); + img.setAttribute("src", value.getStringValue()); creator.appendChild(img); + CalculatedStyle anon = new EmptyStyle().createAnonymousStyle(IdentValue.INLINE_BLOCK); + BlockBox iB = new BlockBox(); iB.setElement(img); - CalculatedStyle anon = new EmptyStyle().createAnonymousStyle(IdentValue.INLINE_BLOCK); iB.setStyle(anon); info.setContainsBlockLevelContent(true); @@ -1041,45 +1037,75 @@ private static List createGeneratedContent( ChildBoxInfo childInfo = new ChildBoxInfo(); - List inlineBoxes = createGeneratedContentList( - c, element, property, peName, style, CONTENT_LIST_DOCUMENT, childInfo); + List values = property.getValues(); + + if (values == null) { + // content: normal or content: none + return Collections.emptyList(); + } + + List result = new ArrayList<>(values.size()); + Element appendTo = element; + CalculatedStyle inlineStyle = style.createAnonymousStyle(IdentValue.INLINE); + + if ("footnote-call".equals(peName)) { + // Wrap the ::footnote-call content with an inline anchor box. + InlineBox aStart = new InlineBox(""); + + aStart.setStartsHere(true); + aStart.setEndsHere(false); + + Element anchor = createFootnoteCallAnchor(c, element); + + aStart.setElement(anchor); + aStart.setStyle(inlineStyle); - if ("footnote-marker".equals(peName)) { + appendTo = anchor; + + result.add(aStart); + } else if ("footnote-marker".equals(peName)) { // We need a box at the start of marker to target the ::footnote-call // link to. + Element marker = createFootnoteTarget(c, element); + InlineBox targetStart = new InlineBox(""); targetStart.setStartsHere(true); - targetStart.setEndsHere(true); - targetStart.setElement(createFootnoteTarget(c, element)); - targetStart.setStyle(style.createAnonymousStyle(IdentValue.INLINE)); + targetStart.setEndsHere(false); + targetStart.setElement(marker); + targetStart.setStyle(inlineStyle); targetStart.setPseudoElementOrClass(peName); - inlineBoxes.add(0, targetStart); + result.add(targetStart); - } else if ("footnote-call".equals(peName)) { + appendTo = marker; + } + + createGeneratedContentList( + c, appendTo, values, peName, style, CONTENT_LIST_DOCUMENT, childInfo, result); + + if ("footnote-call".equals(peName)) { // Wrap the ::footnote-call content with an inline anchor box. - InlineBox aStart = new InlineBox(""); InlineBox aEnd = new InlineBox(""); - aStart.setStartsHere(true); - aStart.setEndsHere(false); - + aEnd.setElement(appendTo); aEnd.setStartsHere(false); aEnd.setEndsHere(true); + aEnd.setStyle(inlineStyle); - Element anchor = createFootnoteCallAnchor(c, element); - aStart.setElement(anchor); - aEnd.setElement(anchor); + result.add(aEnd); + } else if ("footnote-marker".equals(peName)) { + InlineBox targetEnd = new InlineBox(""); - aStart.setStyle(style.createAnonymousStyle(IdentValue.INLINE)); - aEnd.setStyle(style.createAnonymousStyle(IdentValue.INLINE)); + targetEnd.setStartsHere(false); + targetEnd.setEndsHere(true); + targetEnd.setElement(appendTo); + targetEnd.setStyle(inlineStyle); - inlineBoxes.add(0, aStart); - inlineBoxes.add(aEnd); + result.add(targetEnd); } - return wrapGeneratedContent(element, peName, style, info, childInfo, inlineBoxes); + return wrapGeneratedContent(element, peName, style, info, childInfo, result); } private static List wrapGeneratedContent(Element element, String peName, CalculatedStyle style, @@ -1087,10 +1113,10 @@ private static List wrapGeneratedContent(Element element, String peNa if (childInfo.isContainsBlockLevelContent()) { List inlines = new ArrayList<>(); - CalculatedStyle anonStyle = style.isInlineBlock() || style.isInline() ? - style : style.createAnonymousStyle(IdentValue.INLINE_BLOCK); + CalculatedStyle anonStyle = style.isInlineBlock() ? + style : style.overrideStyle(IdentValue.INLINE_BLOCK); - BlockBox result = createBlockBox(style, info, true); + BlockBox result = createBlockBox(anonStyle, info, true); result.setStyle(anonStyle); result.setElement(element); result.setChildrenContentType(BlockBox.ContentType.INLINE); @@ -1107,7 +1133,9 @@ private static List wrapGeneratedContent(Element element, String peNa iB.setStyle(anon); iB.applyTextTransform(); - iB.setElement(null); + if (!isMustKeepElement(iB)) { + iB.setElement(null); + } inlines.add(iB); } @@ -1116,6 +1144,7 @@ private static List wrapGeneratedContent(Element element, String peNa if (!inlines.isEmpty()) { result.setInlineContent(inlines); } + return Collections.singletonList(result); } else if (style.isInline()) { for (Iterator i = inlineBoxes.iterator(); i.hasNext();) { @@ -1131,9 +1160,7 @@ private static List wrapGeneratedContent(Element element, String peNa iB.setStyle(anon); iB.applyTextTransform(); - if (iB.getElement() == null || - (!"fs-footnote-marker".equals(iB.getElement().getNodeName()) && - !iB.getElement().getAttribute("href").startsWith("#fs-footnote-"))) { + if (!isMustKeepElement(iB)) { iB.setElement(null); } } @@ -1153,12 +1180,24 @@ private static List wrapGeneratedContent(Element element, String peNa } } + private static boolean isMustKeepElement(InlineBox iB) { + return iB.getElement() != null && + ("fs-footnote-marker".equals(iB.getElement().getNodeName()) || + iB.getElement().getAttribute("href").startsWith("#fs-footnote-")); + } + private static List createGeneratedMarginBoxContent( LayoutContext c, Element element, PropertyValue property, CalculatedStyle style, ChildBoxInfo info) { - - List result = createGeneratedContentList( - c, element, property, null, style, CONTENT_LIST_MARGIN_BOX, info); + List values = property.getValues(); + + if (values == null) { + return Collections.emptyList(); + } + + List result = new ArrayList<>(values.size()); + createGeneratedContentList( + c, element, values, null, style, CONTENT_LIST_MARGIN_BOX, info, result); CalculatedStyle anon = style.createAnonymousStyle(IdentValue.INLINE); for (Styleable s : result) { @@ -1321,7 +1360,7 @@ private static void createElementChild( if (style.isFootnote() && allowFootnotes) { c.setFootnoteIndex(c.getFootnoteIndex() + 1); - // This is the official marker content that can generate zero or more boxes + // This is the official footnote call content that can generate zero or more boxes // depending on user for ::footnote-call pseudo element. insertGeneratedContent(c, element, style, "footnote-call", children, info); diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-calls.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-calls.html new file mode 100644 index 000000000..01cf1d89b --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-calls.html @@ -0,0 +1,50 @@ + + + + + +

      + This text needs some footnotes. +

      + This is a footnote. +
      +

      + + diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html new file mode 100644 index 000000000..fea98b2a9 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html @@ -0,0 +1,50 @@ + + + + + +

      + This text needs some footnotes. +

      + This is a footnote. +
      +

      + + diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-images.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-images.html new file mode 100644 index 000000000..578c3f414 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-images.html @@ -0,0 +1,72 @@ + + + + + +

      + This text needs some footnotes. +

      + This is a footnote. +
      + Also a footnote for this sentence. + Flying saucer + + Flying saucer + Another footnote! + +

      + +

      + Footnote numbers. +

      + Just to be silly this is a really long footnote that will need wrapping and such. + This is a multiple page footnote so here we go on and on to get to the next page. +
      +
      Flying saucer
      +

      + + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index dee39a666..4d15e796c 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -451,8 +451,9 @@ public void testIssue364FootnoteCallLink() throws IOException { List annots0 = doc.getPage(0).getAnnotations(); List annots1 = doc.getPage(1).getAnnotations(); - assertEquals(1, annots0.size()); - assertEquals(1, annots1.size()); + // FIXME: There should only be one annot on each page. + assertEquals(2, annots0.size()); + assertEquals(2, annots1.size()); PDAnnotationLink link0 = (PDAnnotationLink) annots0.get(0); PDAnnotationLink link1 = (PDAnnotationLink) annots1.get(0); diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index 1a25d5784..475f1a363 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -123,4 +123,27 @@ public void testIssue364Floats() throws IOException { assertTrue(vt.runTest("issue-364-floats")); } + /** + * Tests images in footnotes, as footnotes and intersecting with footnotes. + */ + @Test + public void testIssue364Images() throws IOException { + assertTrue(vt.runTest("issue-364-images")); + } + + /** + * Tests using an image as the footnote call. + */ + @Test + public void testIssue364ImageCalls() throws IOException { + assertTrue(vt.runTest("issue-364-image-calls")); + } + + /** + * Tests using an image as the footnote marker. + */ + @Test + public void testIssue364ImageMarkers() throws IOException { + assertTrue(vt.runTest("issue-364-image-markers")); + } } From b6e6d2f2b6f7e6ad64092e36806ce7475e9446ed Mon Sep 17 00:00:00 2001 From: danfickle Date: Sun, 22 Aug 2021 18:17:21 +1000 Subject: [PATCH 36/54] #364 Yet more work on correct boxing. Since we wrap generated content correctly now, one can use a border on the generated content box (such as before or after) and get Chrome matching results, rather than a border on each item in the content property list. With test proof: + Test for pseudo elements with different display values. + Test for using an image as footnote-call. + Test for using an image as footnote-marker. --- .../context/ContentFunctionFactory.java | 61 +++++- .../com/openhtmltopdf/layout/BoxBuilder.java | 200 +++++++----------- .../footnote/issue-364-image-calls.pdf | Bin 0 -> 3051 bytes .../footnote/issue-364-image-markers.pdf | Bin 0 -> 3102 bytes .../visualtest/expected/pseudo-elements.pdf | Bin 0 -> 6686 bytes .../html/footnote/issue-364-image-calls.html | 2 +- .../footnote/issue-364-image-markers.html | 2 +- .../visualtest/html/pseudo-elements.html | 64 ++++++ .../NonVisualRegressionTest.java | 5 +- .../FootnoteVisualRegressionTest.java | 10 +- .../VisualRegressionTest.java | 8 + 11 files changed, 221 insertions(+), 131 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-image-calls.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-image-markers.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/pseudo-elements.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/pseudo-elements.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/ContentFunctionFactory.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/ContentFunctionFactory.java index 4418673a6..3b462e2f7 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/ContentFunctionFactory.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/ContentFunctionFactory.java @@ -20,9 +20,10 @@ package com.openhtmltopdf.context; import java.util.ArrayList; -import java.util.Iterator; import java.util.List; +import org.w3c.dom.Element; + import com.openhtmltopdf.css.constants.IdentValue; import com.openhtmltopdf.css.extend.ContentFunction; import com.openhtmltopdf.css.parser.CSSPrimitiveValue; @@ -188,7 +189,15 @@ public boolean isStatic() { @Override public String calculate(RenderingContext c, FSFunction function, InlineText text) { - String uri = text.getParent().getElement().getAttribute("href"); + // Due to how BoxBuilder::wrapGeneratedContent works, it is likely the immediate + // parent of text is an anonymous InlineLayoutBox so we have to go up another + // level to the wrapper box which contains the element. + Element hrefElement = text.getParent().getElement() == null ? + text.getParent().getParent().getElement() : + text.getParent().getElement(); + + String uri = hrefElement.getAttribute("href"); + if (uri != null && uri.startsWith("#")) { String anchor = uri.substring(1); Box target = c.getBoxById(anchor); @@ -242,7 +251,15 @@ public boolean isStatic() { @Override public String calculate(RenderingContext c, FSFunction function, InlineText text) { - String uri = text.getParent().getElement().getAttribute("href"); + // Due to how BoxBuilder::wrapGeneratedContent works, it is likely the immediate + // parent of text is an anonymous InlineLayoutBox so we have to go up another + // level to the wrapper box which contains the element. + Element hrefElement = text.getParent().getElement() == null ? + text.getParent().getParent().getElement() : + text.getParent().getElement(); + + String uri = hrefElement.getAttribute("href"); + if (uri != null && uri.startsWith("#")) { String anchor = uri.substring(1); Box target = c.getBoxById(anchor); @@ -302,16 +319,46 @@ public String calculate(RenderingContext c, FSFunction function, InlineText text // Because the leader should fill up the line, we need the correct // width and must first compute the target-counter function. boolean dynamic = false; - Iterator childIterator = lineBox.getChildIterator(); - while (childIterator.hasNext()) { - Box child = childIterator.next(); + boolean dynamic2 = false; + Box wrapperBox = iB.getParent(); + List children = null; + + // The type of wrapperBox will depend on the CSS display property + // of the pseudo element where the content property using this function exists. + // See BoxBuilder#wrapGeneratedContent. + if (wrapperBox instanceof InlineLayoutBox) { + children = ((InlineLayoutBox) wrapperBox).getInlineChildren(); + } else { + children = wrapperBox.getChildren(); + } + + for (Object child : children) { if (child == iB) { + // Don't call InlineLayoutBox::lookForDynamicFunctions on this box + // as we will arrive back here and end up as a stack overflow. + // Instead set the dynamic flag so we resolve subsequent dynamic functions. dynamic = true; - } else if (dynamic && child instanceof InlineLayoutBox) { + } else if (child instanceof InlineLayoutBox) { + // This forces the computation of dynamic functions. ((InlineLayoutBox)child).lookForDynamicFunctions(c); } } + + // We also have to evaluate subsequent dynamic functions at the line level + // in the case that we are in the ::before and subsequent functions are in ::after. + if (dynamic) { + for (Box child : lineBox.getChildren()) { + if (wrapperBox == child) { + dynamic2 = true; + } else if (dynamic2 && child instanceof InlineLayoutBox) { + ((InlineLayoutBox)child).lookForDynamicFunctions(c); + } + } + } + if (dynamic) { + // Re-calculate the width of the line after subsequent dynamic functions + // have been calculated. int totalLineWidth = InlineBoxing.positionHorizontally(c, lineBox, 0); lineBox.setContentWidth(totalLineWidth); } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index f6fed54cd..891f385d4 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -28,7 +28,6 @@ import java.util.Iterator; import java.util.List; import java.util.Map; -import java.util.stream.Collectors; import org.w3c.dom.Document; import org.w3c.dom.Element; @@ -849,15 +848,16 @@ private static List createGeneratedContentList( Element img = doc.createElement("img"); img.setAttribute("src", value.getStringValue()); + // So we don't recurse into the element and create a duplicate box. + img.setAttribute("fs-ignore", "true"); creator.appendChild(img); - CalculatedStyle anon = new EmptyStyle().createAnonymousStyle(IdentValue.INLINE_BLOCK); + CalculatedStyle anon = style.createAnonymousStyle(IdentValue.INLINE_BLOCK); BlockBox iB = new BlockBox(); iB.setElement(img); iB.setStyle(anon); - - info.setContainsBlockLevelContent(true); + iB.setPseudoElementOrClass(peName); result.add(iB); } else if (value.getPropertyValueType() == PropertyValue.VALUE_TYPE_FUNCTION) { @@ -1027,148 +1027,116 @@ private static void insertGeneratedContent( } } + /** + * Creates generated content boxes for pseudo elements such as ::before. + * + * @param element The containing element where the pseudo element appears. + * For span::before the element would be a span. + * + * @param peName Examples include before, after, + * footnote-call and footnote-marker. + * + * @param style The child style for this pseudo element. For span::before + * this would include all the styles set explicitly on ::before as well as + * those that inherit from span following the cascade rules. + * + * @param property The values of the content CSS property. + * @param info In/out param. Whether the resultant box(es) contain block level content. + * @return The generated box(es). Typically one {@link BlockBox} or multiple inline boxes. + */ private static List createGeneratedContent( LayoutContext c, Element element, String peName, CalculatedStyle style, PropertyValue property, ChildBoxInfo info) { - if (style.isDisplayNone() || style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN) - || style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN_GROUP)) { + + if (style.isDisplayNone() + || style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN) + || style.isIdent(CSSName.DISPLAY, IdentValue.TABLE_COLUMN_GROUP) + || property.getValues() == null) { return Collections.emptyList(); } ChildBoxInfo childInfo = new ChildBoxInfo(); List values = property.getValues(); - - if (values == null) { - // content: normal or content: none - return Collections.emptyList(); - } - List result = new ArrayList<>(values.size()); - Element appendTo = element; - CalculatedStyle inlineStyle = style.createAnonymousStyle(IdentValue.INLINE); - - if ("footnote-call".equals(peName)) { - // Wrap the ::footnote-call content with an inline anchor box. - InlineBox aStart = new InlineBox(""); - - aStart.setStartsHere(true); - aStart.setEndsHere(false); - Element anchor = createFootnoteCallAnchor(c, element); + createGeneratedContentList( + c, element, values, peName, style, CONTENT_LIST_DOCUMENT, childInfo, result); - aStart.setElement(anchor); - aStart.setStyle(inlineStyle); + return wrapGeneratedContent(c, element, peName, style, info, childInfo, result); + } - appendTo = anchor; + private static List wrapGeneratedContent( + LayoutContext c, + Element element, String peName, CalculatedStyle style, + ChildBoxInfo info, ChildBoxInfo childInfo, List inlineBoxes) { - result.add(aStart); + Element wrapperElement = element; + if ("footnote-call".equals(peName)) { + wrapperElement = createFootnoteCallAnchor(c, element); } else if ("footnote-marker".equals(peName)) { - // We need a box at the start of marker to target the ::footnote-call - // link to. - Element marker = createFootnoteTarget(c, element); - - InlineBox targetStart = new InlineBox(""); - - targetStart.setStartsHere(true); - targetStart.setEndsHere(false); - targetStart.setElement(marker); - targetStart.setStyle(inlineStyle); - targetStart.setPseudoElementOrClass(peName); - - result.add(targetStart); - - appendTo = marker; + wrapperElement = createFootnoteTarget(c, element); } - createGeneratedContentList( - c, appendTo, values, peName, style, CONTENT_LIST_DOCUMENT, childInfo, result); - - if ("footnote-call".equals(peName)) { - // Wrap the ::footnote-call content with an inline anchor box. - InlineBox aEnd = new InlineBox(""); - - aEnd.setElement(appendTo); - aEnd.setStartsHere(false); - aEnd.setEndsHere(true); - aEnd.setStyle(inlineStyle); - - result.add(aEnd); - } else if ("footnote-marker".equals(peName)) { - InlineBox targetEnd = new InlineBox(""); + if (style.isInline()) { + // Because a content property like: content: counter(page) ". "; + // will generate multiple inline boxes we have to wrap them in a inline-box + // and use a child style for the generated boxes. Otherwise, if we use the + // pseudo style directly and it has a border, etc we will incorrectly get a border + // around every content box. - targetEnd.setStartsHere(false); - targetEnd.setEndsHere(true); - targetEnd.setElement(appendTo); - targetEnd.setStyle(inlineStyle); + List pseudoInlines = new ArrayList<>(inlineBoxes.size() + 2); - result.add(targetEnd); - } + InlineBox pseudoStart = new InlineBox(""); + pseudoStart.setStartsHere(true); + pseudoStart.setEndsHere(false); + pseudoStart.setStyle(style); + pseudoStart.setElement(wrapperElement); + pseudoStart.setPseudoElementOrClass(peName); - return wrapGeneratedContent(element, peName, style, info, childInfo, result); - } + pseudoInlines.add(pseudoStart); - private static List wrapGeneratedContent(Element element, String peName, CalculatedStyle style, - ChildBoxInfo info, ChildBoxInfo childInfo, List inlineBoxes) { - if (childInfo.isContainsBlockLevelContent()) { - List inlines = new ArrayList<>(); + CalculatedStyle inlineContent = style.createAnonymousStyle(IdentValue.INLINE); - CalculatedStyle anonStyle = style.isInlineBlock() ? - style : style.overrideStyle(IdentValue.INLINE_BLOCK); + for (Styleable styleable : inlineBoxes) { + if (styleable instanceof InlineBox) { + InlineBox iB = (InlineBox) styleable; - BlockBox result = createBlockBox(anonStyle, info, true); - result.setStyle(anonStyle); - result.setElement(element); - result.setChildrenContentType(BlockBox.ContentType.INLINE); - result.setPseudoElementOrClass(peName); + iB.setElement(null); + iB.setStyle(inlineContent); + iB.applyTextTransform(); + } - CalculatedStyle anon = style.createAnonymousStyle(IdentValue.INLINE); - for (Iterator i = inlineBoxes.iterator(); i.hasNext();) { - Styleable b = i.next(); - - if (b instanceof BlockBox) { - inlines.add(b); - } else { - InlineBox iB = (InlineBox) b; - - iB.setStyle(anon); - iB.applyTextTransform(); - if (!isMustKeepElement(iB)) { - iB.setElement(null); - } - - inlines.add(iB); - } + pseudoInlines.add(styleable); } - if (!inlines.isEmpty()) { - result.setInlineContent(inlines); - } + InlineBox pseudoEnd = new InlineBox(""); + pseudoEnd.setStartsHere(false); + pseudoEnd.setEndsHere(true); + pseudoEnd.setStyle(style); + pseudoEnd.setElement(wrapperElement); + pseudoEnd.setPseudoElementOrClass(peName); - return Collections.singletonList(result); - } else if (style.isInline()) { - for (Iterator i = inlineBoxes.iterator(); i.hasNext();) { - InlineBox iB = (InlineBox) i.next(); - iB.setStyle(style); - iB.applyTextTransform(); - } - return inlineBoxes; + pseudoInlines.add(pseudoEnd); + + return pseudoInlines; } else { CalculatedStyle anon = style.createAnonymousStyle(IdentValue.INLINE); - for (Iterator i = inlineBoxes.iterator(); i.hasNext();) { - InlineBox iB = (InlineBox) i.next(); - iB.setStyle(anon); - iB.applyTextTransform(); - if (!isMustKeepElement(iB)) { + for (Styleable styleable : inlineBoxes) { + if (styleable instanceof InlineBox) { + InlineBox iB = (InlineBox) styleable; + iB.setElement(null); + iB.setStyle(anon); + iB.applyTextTransform(); } } BlockBox result = createBlockBox(style, info, true); result.setStyle(style); result.setInlineContent(inlineBoxes); - result.setElement(element); + result.setElement(wrapperElement); result.setChildrenContentType(BlockBox.ContentType.INLINE); result.setPseudoElementOrClass(peName); @@ -1180,12 +1148,6 @@ private static List wrapGeneratedContent(Element element, String peNa } } - private static boolean isMustKeepElement(InlineBox iB) { - return iB.getElement() != null && - ("fs-footnote-marker".equals(iB.getElement().getNodeName()) || - iB.getElement().getAttribute("href").startsWith("#fs-footnote-")); - } - private static List createGeneratedMarginBoxContent( LayoutContext c, Element element, PropertyValue property, CalculatedStyle style, ChildBoxInfo info) { @@ -1337,9 +1299,11 @@ private static void createElementChild( } String tag = element.getNodeName(); - if ("fs-footnote-marker".equals(tag) || - ("a".equals(tag) && element.getAttribute("href").startsWith("#fs-footnote"))) { - // Don't output elements that have been artificially created to support footnotes. + if (("fs-footnote-marker".equals(tag)) || + ("a".equals(tag) && element.getAttribute("href").startsWith("#fs-footnote")) || + ("img".equals(tag) && element.getAttribute("fs-ignore").equals("true"))) { + // Don't output elements that have been artificially created to support + // footnotes and content property images. return; } diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-image-calls.pdf b/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-image-calls.pdf new file mode 100644 index 0000000000000000000000000000000000000000..b4b7ea5e462e61c5fa819d45f522c60c7aa4f0c1 GIT binary patch literal 3051 zcmd5;U2GIp6vm=Wya5f8sw74)(MlU+=HB_)AA|I7yQK=DY&RBdP=?*R-6^|s%gn5_ zB&0=&jXx1mL&5|4LgSl}2V;D~7{Y@wMiPDT1tfv+V4@}>5(L(B@6PPbZcFgN2d6)C z@0oMXckVskJ?D0gq|%$HVxZ3Jmv3D}6cfz%PNL15k(!;EVptupe5=GKkoq!nJ)1jN zrAi#BBi01-ums`l;`o?G48@nF zhDhDc^0w8_r|~#Z2o`^uX2O4+z!*G@SS|xswIzaI$A_thO#y_|4D)!!&A}eTYJxt; z;qZApUJInLC&D1a-^QE?zlbSK#zcgk4|`NzjQ~)OoA?0I@QaAxNkj?Wj>dO`WghKE zdJJnZ1D6p^B;}|iM|w<}QCt!l%`>52LPa!&9B?Rp+zDjpidpwWgR$^M6hPNvx}uq2 zWfVmqJt}B!Xm4@GlNcd{83|+~9TcCq!i-RDTU`Lt* zTNbr-fg+0jEK<`HQ?VskSfJb^iUUNGDpX`7TSi^kqU~XyP5ank45;SuGQ-_CJBbFf z_i!U}5`(=IZVH_Hz!2ssb>sag4(K8|;!O#a`yLwQ%19k9Q=H;xr^umV5}-|xNtq(k zPzVGmcp)4?xlg)YFP(u(vLuZH8tonkKVTDUWox}+cK#knBWA7x(`B*d) z!Q`YAL)~i>M^P<9(^|igbrh+imA$^~Kih0)A5#0^c+{L`gvasvVS#c3pAxcw83~2P zO(@-IY#_CN6zXh<81yF*SO_Ohe{25|5r*G`TCHg$Y=yykBEb!pp$!6_UGkxUsp%5* zx)jUtJP7-3-y31>054B*M|6?|QpfDPDF5JbE3+qx(5PTIz)Rd6ow9P!ZBy(GJI69Z z{Q$Dv^7cW2sx5mM+K)TM1pxNl3X8Un>63p~;hC*I`P_w>&c(~`FWz1=eD&1&%Gje% z-TCXci?gSHJax1C`^S%*(NEvD_OvhbUf4$%QJBMD|bm7`NhyUn#`0Q-Q+tr(U z7UnOlUHRC^*T>JzUzmU9*44rde(v|4k1ox2ocO%0d-@?`{o=3li%)Dl)PA;ld{y=6 zTi^J{9_-yX=iGR@`}XTcFU^`~t7}(Pt8*PIemc17t92*lKDgEK$l<}yv=Q}}E5{c2 zdt+~&JW^2OE6-o)7x~^DVV~qj=xGc?F2KQPRAK3@ zLl8W|0D(^-*_Ov7_0_ChX5OX@FIy1LpaWd6oe2z?clsR94h2z+=%p#VAn5-Q=ODCy z$+;odnrR``?9V;z_pkW!lQjpH$-=bD3ec9QfuP+75006pZsG#mXo81Ae-jUO>M|OG zQ`RCQaX6VRGEIZJ(jwDMxXm@oXpAf)i@~P0=*8np^%7(WhNfvyl$vcd9WFFWWcm_+ znh}-xu4R{)EAP@7=>E7?jnrYMz;Sr2fvB4kDU&2fnk4!L3H+L=RB|w-^(6;r67Gcw hV++2w3RJyO`ydnfkQYnK^<{>%7>%RO&cPjN^bdcT6b%3X literal 0 HcmV?d00001 diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-image-markers.pdf b/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-image-markers.pdf new file mode 100644 index 0000000000000000000000000000000000000000..b8963061b412398b71ff5f8ce9922075f9efaf1d GIT binary patch literal 3102 zcmd5;Uu+ab7{{VboPY*NRT85^v_gaI?(FW|T@BLqde>5fP}++{n<~rQTyM+WPTAd) zmV~q@vGGrY)R6FizR>t)oUs+hm7SjyfO2)SawgTWLOpM>R#m;$PP(d>R^zA=04bG6+>)BE)rkc=a$9Ku8^89pf z(Bn89ejZKM6KU>=a0u~tFlXE^VWOKUk)h|q9#vK&05p;mA4EFdjx;=hh=zBf(J}BW zpaaNAU_D{t3L>daIV#JMk&tc#m&J_5Z(@EKmCy)sAfWhj$B}6$v=NB}V-ZVJ09{WQ zicZ1HG{tx0wS;rAZ zDKLPp?%B0(g5`ZI8j#4RQ<_05n}RA7Hgv7`D5L-lQb+89=ok=j8?(nt(A!|x%gfvy zp0x7Npfl`sJI{vt(*Uy5^7ezK)mJ?L9m}2M0s#ANl|?(w)TzH}@XXYneD30O`@)s? z7VfMWxORGdb>z{f?*94frI|B7oW9lZ-Q!2k8fWfUdt2wbZ|rXUwb#6Z0ap$#TmuKj?+S*mM+HBj39}lhia^1<<_iwj7 zawPkyKB)eD_4qu0cjS#zM~iB5<%O%=yyfuq(`O&}{@ZSTcW!!JspY~uUGsW(f6L+f zu0NYWD~3M*=!JW*O%frjQoxzKxSYVAVYQ#z)&VZq&Nzn3J3WqPhlVId z^qv*oDUAP!bCBA<8(}oO+FQ?~f15t*HAUBo-GQrA75#uV; z5_&_t24djB3@Zlc0MR!=i`6AVtlOhvixNqQNwg~i$|OZ*XEP!@p5fW)jKH%+OyyKS z2AP?_0ZZ5@gZ`r52>ygYZWSnOt)!TrjT0fJf{CGT;9tBhtq3=V<>CK82nQC3qDh6A zTC7A+Ik!gy$x#qN338g}L;-z?3^Jry93;U8L3qP5ry_%L!ib-S$2P5PwGfWoZsf9n zoklJRDyR@;UcdpwR$44%xWvIBuga+kIuv1q6xs-d0aQdQ99TGIm^ekUg#=5sad1eS zFbIp&$hP{iJtK~ z1aYMxmndy`B&!?`rDD_y3XF|GZJ-!4EYt>vQbeSnP3Kd6pz??pHkc6#hbL&*8Qp>$ zKvfuJWDm!CaG#*QlVwg4>|KLwF_lLc49Ydb;H6@R%$2VfaLlaSAoC^GV8C!*96pIShE223w{W!KgtYE z1m+B5{nHtrpGk`l0fM6E044QyF%ooC8%$JV+Xc}GI5dsZA`z+#Qq4ibt7u%K0f|%2 zLlGNEgQkJ0!HR?vVW8DvL;#0oE=}l7m^DvGgQpG{I+dtktC@{TG6n<1kqWR3N>Pu< zR2ivWM42`Qrq$opS6q^$Khh@G(C;?e9F;>L7Hl_5FnR@usG!MUfK6cBQDrHaNl5ic~)=E7GW?EW1N!T(>`;1UKBvB46-$(xWt{X-gPp z4R+jts@5B|_A8QlWLM^&O-D^i{)nHp6cUy#i;{=)7)dZBt;oPP&fg%AK^g~;G=|F6h1(^(5AFV)E? z@kA!&&{R6%NIABR6obPA2bvl{F*biJGumiQ=U)d?$%}YEqEwa_7y0Pbd?o{0&=V7c z8GUej&@2lkltu6m;W);BW92vmQtg8yg zd(qRDJxYXU%eo5LH=oK-^Vmp7*3DZ`Gwbw*6hW-}UlM!Dp;>prscmN2I8AV%sn--^ z^T#ryjb@tl6o*id+8@SVkt3tH14%becQofV;SZ8>8>}Eai}rci%L7V@N8}`P26ey( z^K?gjunF&g5BPS$?dH7X)}%b#n7(4+x`gjvYzZbTTfM@Km4fDvQ92gos8*3Ys+;vn zX#)i$+?3#z0Id@nk5(;(nPP0_pssgVl7gpoOE5OCs92j@HaIoOQh+VGZ{?zgA{3eq z&MR`fqj@LiA9P;Xapl@9Ek@E`%5+65IAgy=mT~Awhb*EBV130Zz<|}&q~hx7T1}Eg zJ3cgBy_gLPENh2_PEx4As^o;Z=0gbbwYlPwMTu+-P5F$gyrDXYcZh{i*cQSQWjKvg1nO~xBED&6J`MdiRSKWDZbRTa0Kso!w!_}_!VR`fXHN7915}GhK^w!ryF2;_pTpW&M>}CG_ zdqwZ@yMFIwF1oh6aen3Mkvp@GZ#Z&rNbx@}9^G?Hud7?XF0Z`0>2!~-RXrZsmJxns zTSjT?>mTOyT|Rg2(Wx`sYmP${F8XAbJW` zMt25oel>K}@_Suw^;^ASez@O%kA4{+b@JrNJ-6pwkCyd|Z~aes`QuGZTLMi-cl~@@ z|HnG5`*@tU|Lp;tr{wH>|G7UulQqqKykg(AmCX^Df4FzJwf2+Zl_NI4)bL7=Yj27ZHcZS*ytC=@p_yy;`iHM=ah<9f zb+Jo}+UNOWLGh&%vGaR=Ij!pDUQ4EyW^M_b8b35^Ni+BB1%Kat?!Xc4r%z^`-hQFW zp#4W%+^=t#_;zTdR_Gozj5SjAAT{rX3w<#OUL_`{N~t& z(&f9j6*pR1pYNf&`@X+=%%j~0ow>Wn~UA=>B=%T`xpkTbrvk&FFdQ{KS0^|4TXT`siAkZb3CpYTDR*qn@!9 zF=7f(uYrVyyUFDbN43O=GCdlIF)m*W$~hdXW1)CsIk7~TFl=3gi?{<5krT?)S6m{GV$TC#ZN(gTMVK7Qry$;rKYztQbp zt8zVaT61t?&dGQDlbh#!FzgpIj}E?b^^s@h)p#Zi-n>R>xV5QZ-|j=BCM8-vy^z6f zc;cb$Q@&pIou;jyt!n-vG*x|eawz+W{oc$IXXfpg^^dPkU3&Z0H^PBMXCqm;Z`@vZ zMeDw3LDs!A>1m8>c)u(#JpExkvMkALZCA>Jg%$pmjZvQ9fy|;G8;@6Df~D|85$0tI zPmmbWIPa#XmR}drA*i1MFtsbwK|Jl zuE6*%%x5b{3$O+7xn-Y}qo`7Tj@K*kxn4n)q#U^B$#U)(_WnoU9Y=ZiXBsP*? -

      +

      This text needs some footnotes.

      This is a footnote. diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html index fea98b2a9..70208dddc 100644 --- a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-image-markers.html @@ -40,7 +40,7 @@ -

      +

      This text needs some footnotes.

      This is a footnote. diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/pseudo-elements.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/pseudo-elements.html new file mode 100644 index 000000000..86caaf2e8 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/pseudo-elements.html @@ -0,0 +1,64 @@ + + + + + +
      Hello
      + World! + +
      One
      +
      Two
      + Three + +
      Four
      + Five + +
      Six
      + Seven + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index 4d15e796c..dee39a666 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -451,9 +451,8 @@ public void testIssue364FootnoteCallLink() throws IOException { List annots0 = doc.getPage(0).getAnnotations(); List annots1 = doc.getPage(1).getAnnotations(); - // FIXME: There should only be one annot on each page. - assertEquals(2, annots0.size()); - assertEquals(2, annots1.size()); + assertEquals(1, annots0.size()); + assertEquals(1, annots1.size()); PDAnnotationLink link0 = (PDAnnotationLink) annots0.get(0); PDAnnotationLink link1 = (PDAnnotationLink) annots1.get(0); diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index 475f1a363..ad621e895 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -15,7 +15,6 @@ import com.openhtmltopdf.visualtest.TestSupport; import com.openhtmltopdf.visualtest.VisualTester; -@Ignore @RunWith(PrintingRunner.class) public class FootnoteVisualRegressionTest { private VisualTester vt; @@ -43,6 +42,7 @@ public void configureTester() { * Tests that we support CSS footnotes. */ @Test + @Ignore public void testIssue364FootnotesBasicExample() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-basic")); } @@ -51,6 +51,7 @@ public void testIssue364FootnotesBasicExample() throws IOException { * Tests that a line of text can contain two multi-page footnotes. */ @Test + @Ignore public void testIssue364FootnotesMultiPage() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-multi-page")); } @@ -60,6 +61,7 @@ public void testIssue364FootnotesMultiPage() throws IOException { * do not fit on a single page. */ @Test + @Ignore public void testIssue364FootnotesTooLarge() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-too-large")); } @@ -70,6 +72,7 @@ public void testIssue364FootnotesTooLarge() throws IOException { * with the footnote area. */ @Test + @Ignore public void testIssue364FootnotesBlocks() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-blocks")); } @@ -79,6 +82,7 @@ public void testIssue364FootnotesBlocks() throws IOException { * presence of footnotes. */ @Test + @Ignore public void testIssue364FootnotesPaginatedTable() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-paginated-table")); } @@ -88,6 +92,7 @@ public void testIssue364FootnotesPaginatedTable() throws IOException { * above footnotes. */ @Test + @Ignore public void testIssue364FootnotesPositionedContent() throws IOException { assertTrue(vt.runTest("issue-364-footnotes-positioned-content")); } @@ -103,6 +108,7 @@ public void testIssue364FootnotesPositionedContent() throws IOException { * */ @Test + @Ignore public void testIssue364PositionedInsideFootnotes() throws IOException { assertTrue(vt.runTest("issue-364-positioned-inside-footnotes")); } @@ -119,6 +125,7 @@ public void testIssue364PositionedInsideFootnotes() throws IOException { * */ @Test + @Ignore public void testIssue364Floats() throws IOException { assertTrue(vt.runTest("issue-364-floats")); } @@ -127,6 +134,7 @@ public void testIssue364Floats() throws IOException { * Tests images in footnotes, as footnotes and intersecting with footnotes. */ @Test + @Ignore public void testIssue364Images() throws IOException { assertTrue(vt.runTest("issue-364-images")); } diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java index 782e9b90c..18aec8735 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java @@ -1433,6 +1433,14 @@ public void testIssue732NoBlockFormattingContext() throws IOException { assertTrue(vt.runTest("issue-732-no-bfc")); } + /** + * Tests that pseudo elements such as ::before are boxed correctly. + */ + @Test + public void testPseudoElements() throws IOException { + assertTrue(vt.runTest("pseudo-elements")); + } + /** * Tests a now-fixed near-infinite loop when page-break-inside: avoid * is used on heavily nested content. From c581ae0f174d57a58898e2608817ec67aadbe750 Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 23 Aug 2021 00:26:07 +1000 Subject: [PATCH 37/54] #364 Non-paginated tables with footnotes test with proof. Tests non-paginated table content works inside footnote body as well as footnotes being called from inside an in-flow table. Also tests use of before and after pseudo elements in the footnote element. --- .../issue-364-non-paginated-table.pdf | Bin 0 -> 4561 bytes .../issue-364-non-paginated-table.html | 61 ++++++++++++++++++ .../FootnoteVisualRegressionTest.java | 11 ++++ 3 files changed, 72 insertions(+) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-non-paginated-table.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-non-paginated-table.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-non-paginated-table.pdf b/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-non-paginated-table.pdf new file mode 100644 index 0000000000000000000000000000000000000000..f2e84e10a4f705be066d78589c3aeb0d2afaa50c GIT binary patch literal 4561 zcmcgwO>g5i5WN%F|G-PISrnl}Qq)Hg1W5c*Y`fb{W20#s*Mro{PK=gTBZsl!=7ob!09msG&?3vzNobUH>eX_0N_jTEAL*PPW_LQB6^nV1-Hj(~lr273OQWlLWF`dS{E&>7^vc6X zs4`FAJOg}Q6Q`5irv>$_rEqR@DdK$A<0L-I9_f|KT#7$JsOkwToyWO`rOHjix@iF) zmo!92#JSMR>^>hsR-$s?G)*)3^A(4+Fp^E0Fw9pBfFo+P2>3QIn3C7@h(Omp8UTp1 z-n41AJf__h2dP@MS z&*bVF49DaTB7Mrkh%N{|@n>${NgvHT{0KAZpUPP?a!FEH5Wn&%IU5qE&nZ`QI58#W zQcgWVxgRkF0dP88ki+3DSyK33W(!RV{a7&ifevp;Z`i&74?M<|>%zjdb=Fqsoj>WH zE6)5D^Q%dEUHRR=10`4hsff%DPSbH2{UXa(Tc}oQPl3mTqFhQA`0xgk@Fmri$?otm zecWTx0D+be_tCP5^Wu7)fL5nb#9Y9&JB{s-A)8D)PPi# z1aM_t&aK=rXGO&fLmp9{C!6z%+voZUMX36>MRA9cmNHUDaZ@q7;HY6ZoB{G{@z^at zpUfGY?}$N>~iqy+P2|K(KH{ycdeAWw}>bIgc23 z@ffqL*5bO4?g|oEiRvhx&-Iv2@@zqq^k_2A9@c2KlR!`jx^5D)U&RB?Kq)pB6qB;Q zyzFkXEU)e64ElnNeDBs~v2MIjn>QpB%tJD|sze$a0#pH8n#%^wDr&nYTotu=YiWL2 zQ4jQ2o$h8tSyr{8>?PA#@f<5#n}19;jYzv}+Wl;at7&b!oUi~h3%zZtAu6RpA8710`tP2MsV#K7uiaF9b&5-+tu#~CIIy*#?e z7BQr^myWV=l1`~}nWU%bGN}fvj6LRh0zJG42&mKQMSZ2Dq7%3}tX^2W_@e20463g& z<_6G_ZOs!N + + + + +This is some text. +
      + + + + + + + + +
      Footnote table
      One
      Two
      Three
      Four
      Five
      Six
      +
      +And some more text. + + + + + + + + + + +
      One
      Two
      + Three + Footnote called from in-flow table +
      Four
      Five
      Six
      Seven
      Eight
      Nine
      + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index ad621e895..9f65bf633 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -154,4 +154,15 @@ public void testIssue364ImageCalls() throws IOException { public void testIssue364ImageMarkers() throws IOException { assertTrue(vt.runTest("issue-364-image-markers")); } + + /** + * Tests non-paginated table content works inside footnote body + * as well as footnotes being called from inside an in-flow table. + * Also tests use of ::before and ::after in the footnote element. + */ + @Test + public void testIssue364NonPaginatedTable() throws IOException { + assertTrue(vt.runTest("issue-364-non-paginated-table")); + } + } From f10ab03171145cbfde4b50f3c9046d507e3d50b6 Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 23 Aug 2021 01:24:40 +1000 Subject: [PATCH 38/54] #364 Two link tests with footnotes (one failing). Footnotes seem to cause problems with the destination of in-flow targets. --- .../issue-364-link-to-footnote-content.html | 39 +++++++++++++ .../issue-364-link-to-in-flow-content.html | 39 +++++++++++++ .../NonVisualRegressionTest.java | 55 +++++++++++++++++++ 3 files changed, 133 insertions(+) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-footnote-content.html create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-in-flow-content.html diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-footnote-content.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-footnote-content.html new file mode 100644 index 000000000..aa241ca18 --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-footnote-content.html @@ -0,0 +1,39 @@ + + + + + +This is some text on page 1. +This is       link to footnote content. +
      Page 2
      +And some more text. +
      +Line 1
      +Line 2
      +Line 3
      +Link target in footnote +
      +Finally, this ends. + + diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-in-flow-content.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-in-flow-content.html new file mode 100644 index 000000000..92866283e --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/issue-364-link-to-in-flow-content.html @@ -0,0 +1,39 @@ + + + + + +Link in in-flow. +This is the second bit of text. +And some more text. +
      +Line 1
      +Line 2
      +Line 3
      +Link in footnote +
      +Finally, this ends the in-flow text. +Or does it? (link target) + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index dee39a666..37ae42dca 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -17,6 +17,8 @@ import java.util.List; import java.util.Locale; import java.util.Random; +import java.util.function.BiConsumer; +import java.util.function.Consumer; import java.util.stream.Collectors; import java.util.stream.IntStream; @@ -46,6 +48,7 @@ import org.hamcrest.CustomTypeSafeMatcher; import org.junit.Assert; import org.junit.BeforeClass; +import org.junit.Ignore; import org.junit.Test; import org.junit.runner.RunWith; @@ -479,6 +482,58 @@ public void testIssue364FootnoteCallLink() throws IOException { } } + private PDPageXYZDestination getLinkDestination(PDAnnotation link) throws IOException { + PDAnnotationLink link0 = (PDAnnotationLink) link; + PDActionGoTo goto0 = (PDActionGoTo) link0.getAction(); + return (PDPageXYZDestination) goto0.getDestination(); + } + + /** + * Tests using a link from in-flow content to an element inside a footnote. + */ + @Test + public void testIssue364LinkToFootnoteContent() throws IOException { + try (PDDocument doc = run("issue-364-link-to-footnote-content")) { + List annots0 = doc.getPage(0).getAnnotations(); + + assertEquals(2, annots0.size()); + + Consumer destCheck = (dest) -> { + assertEquals(52, dest.getTop()); + assertEquals(1, doc.getPages().indexOf(dest.getPage())); + }; + + // Link goes over two lines, therefore two rectangular link annotations. + destCheck.accept(getLinkDestination(annots0.get(0))); + destCheck.accept(getLinkDestination(annots0.get(1))); + + remove("issue-364-link-to-footnote-content", doc); + } + } + + /** + * Tests using a link from footnote content to in-flow content. + */ + @Test + @Ignore // Footnotes seem to be causing problems with in-flow links. + public void testIssue364LinkToInFlowContent() throws IOException { + try (PDDocument doc = run("issue-364-link-to-in-flow-content")) { + List annots0 = doc.getPage(0).getAnnotations(); + + assertEquals(3, annots0.size()); + + BiConsumer pageCheck = (dest, pageNum) -> { + assertEquals(pageNum.intValue(), doc.getPages().indexOf(dest.getPage())); + }; + + pageCheck.accept(getLinkDestination(annots0.get(0)), 1); + pageCheck.accept(getLinkDestination(annots0.get(1)), 0); + pageCheck.accept(getLinkDestination(annots0.get(2)), 1); + + // remove("issue-364-link-to-in-flow-content", doc); + } + } + /** * Tests that link annotation area is correctly translated-y. */ From 22222f0c57cd3054580ac38e204c6ee6e80d3914 Mon Sep 17 00:00:00 2001 From: danfickle Date: Mon, 23 Aug 2021 14:51:16 +1000 Subject: [PATCH 39/54] #364 Fix linking to the wrong location when an InlineContentBox is moved. Problem was that when a pending box was added, then removed from a line, it link target was not being removed. Also some documentation and cleanup. --- .../openhtmltopdf/layout/InlineBoxing.java | 45 ++++++++++++++++++- .../openhtmltopdf/layout/SharedContext.java | 4 -- .../openhtmltopdf/render/InlineLayoutBox.java | 13 ++++-- .../com/openhtmltopdf/render/LineBox.java | 11 ++++- .../com/openhtmltopdf/util/LambdaUtil.java | 2 +- .../NonVisualRegressionTest.java | 22 +++++---- 6 files changed, 72 insertions(+), 25 deletions(-) diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java index 70777abe1..a8cf8b9e6 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/InlineBoxing.java @@ -48,7 +48,6 @@ import com.openhtmltopdf.render.InlineText; import com.openhtmltopdf.render.LineBox; import com.openhtmltopdf.render.MarkerData; -import com.openhtmltopdf.render.PageBox; import com.openhtmltopdf.render.StrutMetrics; import com.openhtmltopdf.render.TextDecoration; import com.openhtmltopdf.util.XRLog; @@ -1028,7 +1027,7 @@ private static void saveLine(LineBox current, LayoutContext c, boolean hasFirstLinePCs, List pendingInlineLayers, MarkerData markerData, int contentStart, boolean alwaysBreak) { current.setContentStart(contentStart); - current.prunePendingInlineBoxes(); + current.prunePendingInlineBoxes(c); int totalLineWidth; @@ -1228,6 +1227,32 @@ private static LineBox newLine(LayoutContext c, int y, Box box) { return result; } + /** + * We have to convert this HTML (angle brackets replaced with square brackets): + * 
      [one][two]Two lines[/two][/one]
      + * to (with parent child relationship specified by indentation): + * 
      +     *   [line-box] (LineBox)
+     *     [one]    (InlineLayoutBox)
+     *       [two]  (InlineLayoutBox)
+     *         Two  (InlineText)
+     *       [/two]
+     *     [/one]
+     *   [/line-box]
+     *   [line-box]  (LineBox)
+     *     [one]     (InlineLayoutBox)
+     *       [two]   (InlineLayoutBox)
+     *         lines (InlineText)
+     *       [/two]
+     *     [/one]
+     *   [/line-box]
+     *
      + * In this case the openParents param would be a flat list of [one][two] + * as InlineBox objects at the start of the second line. + * + * @return the deepest box (so that the rest of the line's content + * can be added to it) or null if openParents is empty. + */ private static InlineLayoutBox addOpenInlineBoxes( LayoutContext c, LineBox line, List openParents, int cbWidth, Map iBMap) { @@ -1239,6 +1264,22 @@ private static InlineLayoutBox addOpenInlineBoxes( currentIB = new InlineLayoutBox( c, iB.getElement(), iB.getStyle(), cbWidth); + if (iB.getElement() != null) { + String id = iB.getElement().getAttribute("id"); + + // If the id hasn't been added to the global tracker (for link targeting) + // we add it here. This can happen if a box was added and then removed + // from the previous line via #prunePending because no content could fit + // on the previous line. + if (!id.isEmpty() && + c.getSharedContext().getBoxById(id) == null) { + c.addBoxId(id, currentIB); + } + } + + // iBMap contains a map from the original InlineBox (which can + // contain multiple lines of text and so is divided into InlineLayoutBox objects + // during layout) to the last created InlineLayoutBox for its content. InlineLayoutBox prev = iBMap.get(iB); if (prev != null) { currentIB.setPending(prev.isPending()); diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java index 66bd10393..d18ad4fc3 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/SharedContext.java @@ -30,9 +30,7 @@ import com.openhtmltopdf.render.FSFontMetrics; import com.openhtmltopdf.render.RenderingContext; import com.openhtmltopdf.swing.AWTFontResolver; -import com.openhtmltopdf.util.LogMessageId; import com.openhtmltopdf.util.ThreadCtx; -import com.openhtmltopdf.util.XRLog; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; @@ -42,7 +40,6 @@ import java.util.HashMap; import java.util.Locale; import java.util.Map; -import java.util.logging.Level; /** * The SharedContext stores pseudo global variables. @@ -451,7 +448,6 @@ public void setFontResolver(FontResolver resolver) { /** * Get the internal dots measurement per CSS pixel. - * @return */ public int getDotsPerPixel() { return dotsPerPixel; diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java index 48aad8614..e6e8c9c2d 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/InlineLayoutBox.java @@ -161,18 +161,23 @@ public int getInlineWidth(CssContext cssCtx) { return _inlineWidth; } - public void prunePending() { + public void prunePending(LayoutContext c) { if (getInlineChildCount() > 0) { for (int i = getInlineChildCount() - 1; i >= 0; i--) { Object child = getInlineChild(i); if (! (child instanceof InlineLayoutBox)) { break; } - + InlineLayoutBox iB = (InlineLayoutBox)child; - iB.prunePending(); - + iB.prunePending(c); + if (iB.isPending()) { + if (iB.getElement() != null && + iB.getElement().hasAttribute("id")) { + c.removeBoxId(iB.getElement().getAttribute("id")); + } + removeChild(i); } else { break; diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java index bd9b21708..931f684f1 100755 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/render/LineBox.java @@ -160,16 +160,23 @@ public boolean isFirstLine() { return super.isFirstChild(); } - public void prunePendingInlineBoxes() { + public void prunePendingInlineBoxes(LayoutContext c) { if (getChildCount() > 0) { for (int i = getChildCount() - 1; i >= 0; i--) { Box b = getChild(i); if (! (b instanceof InlineLayoutBox)) { break; } + InlineLayoutBox iB = (InlineLayoutBox)b; - iB.prunePending(); + iB.prunePending(c); + if (iB.isPending()) { + if (iB.getElement() != null && + iB.getElement().hasAttribute("id")) { + c.removeBoxId(iB.getElement().getAttribute("id")); + } + removeChild(i); } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java index 05ea26305..46d381ecf 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LambdaUtil.java @@ -166,7 +166,7 @@ public static String descendantDump(Box root) { for (DescendantContent content : renderObjects) { sb.append(space, 0, Math.min(100, content.indent * 4)); - sb.append(content.object.toString()); + sb.append(content.object.toString() + " => " + Integer.toHexString(System.identityHashCode(content.object))); sb.append('\n'); } diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java index 37ae42dca..826db0712 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/nonvisualregressiontests/NonVisualRegressionTest.java @@ -17,7 +17,6 @@ import java.util.List; import java.util.Locale; import java.util.Random; -import java.util.function.BiConsumer; import java.util.function.Consumer; import java.util.stream.Collectors; import java.util.stream.IntStream; @@ -48,7 +47,6 @@ import org.hamcrest.CustomTypeSafeMatcher; import org.junit.Assert; import org.junit.BeforeClass; -import org.junit.Ignore; import org.junit.Test; import org.junit.runner.RunWith; @@ -487,7 +485,12 @@ private PDPageXYZDestination getLinkDestination(PDAnnotation link) throws IOExce PDActionGoTo goto0 = (PDActionGoTo) link0.getAction(); return (PDPageXYZDestination) goto0.getDestination(); } - + + private void destCheck(PDDocument doc, PDPageXYZDestination dest, int pageNum, int top) { + assertEquals(pageNum, doc.getPages().indexOf(dest.getPage())); + assertEquals(top, dest.getTop()); + } + /** * Tests using a link from in-flow content to an element inside a footnote. */ @@ -515,22 +518,17 @@ public void testIssue364LinkToFootnoteContent() throws IOException { * Tests using a link from footnote content to in-flow content. */ @Test - @Ignore // Footnotes seem to be causing problems with in-flow links. public void testIssue364LinkToInFlowContent() throws IOException { try (PDDocument doc = run("issue-364-link-to-in-flow-content")) { List annots0 = doc.getPage(0).getAnnotations(); assertEquals(3, annots0.size()); - BiConsumer pageCheck = (dest, pageNum) -> { - assertEquals(pageNum.intValue(), doc.getPages().indexOf(dest.getPage())); - }; - - pageCheck.accept(getLinkDestination(annots0.get(0)), 1); - pageCheck.accept(getLinkDestination(annots0.get(1)), 0); - pageCheck.accept(getLinkDestination(annots0.get(2)), 1); + destCheck(doc, getLinkDestination(annots0.get(0)), 1, 172); + destCheck(doc, getLinkDestination(annots0.get(1)), 0, 103); + destCheck(doc, getLinkDestination(annots0.get(2)), 1, 172); - // remove("issue-364-link-to-in-flow-content", doc); + remove("issue-364-link-to-in-flow-content", doc); } } From f32972183c6bd2b259adea2ace91da877d17753f Mon Sep 17 00:00:00 2001 From: danfickle Date: Wed, 25 Aug 2021 16:52:21 +1000 Subject: [PATCH 40/54] #364 Treat footnotes inside footnotes gracefully. By processing them as non-footnote content. --- .../com/openhtmltopdf/layout/BoxBuilder.java | 23 ++++++-- .../openhtmltopdf/layout/LayoutContext.java | 16 ++++++ .../com/openhtmltopdf/util/LogMessageId.java | 2 + .../issue-364-footnote-inside-footnote.pdf | Bin 0 -> 4257 bytes .../issue-364-footnote-inside-footnote.html | 53 ++++++++++++++++++ .../FootnoteVisualRegressionTest.java | 9 +++ 6 files changed, 97 insertions(+), 6 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-footnote-inside-footnote.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnote-inside-footnote.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index 891f385d4..2a0ba1d39 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -28,6 +28,7 @@ import java.util.Iterator; import java.util.List; import java.util.Map; +import java.util.logging.Level; import org.w3c.dom.Document; import org.w3c.dom.Element; @@ -67,6 +68,8 @@ import com.openhtmltopdf.render.FlowingColumnContainerBox; import com.openhtmltopdf.render.InlineBox; import com.openhtmltopdf.util.OpenUtil; +import com.openhtmltopdf.util.XRLog; +import com.openhtmltopdf.util.LogMessageId; /** * This class is responsible for creating the box tree from the DOM. This is @@ -1286,8 +1289,7 @@ private static void createElementChild( Node working, List children, ChildBoxInfo info, - CreateChildrenContext context, - boolean allowFootnotes) { + CreateChildrenContext context) { Styleable child = null; SharedContext sharedContext = c.getSharedContext(); @@ -1321,7 +1323,7 @@ private static void createElementChild( return; } - if (style.isFootnote() && allowFootnotes) { + if (style.isFootnote() && !c.isInFloatBottom()) { c.setFootnoteIndex(c.getFootnoteIndex() + 1); // This is the official footnote call content that can generate zero or more boxes @@ -1462,11 +1464,14 @@ private static BlockBox createFootnoteBody( footnoteBody.setContainingLayer(layer); c.pushLayer(layer); + c.setIsInFloatBottom(true); CreateChildrenContext context = new CreateChildrenContext(false, false, style.getParent(), false); - createElementChild(c, (Element) element.getParentNode(), footnoteBody, element, footnoteChildren, footnoteChildInfo, context, false); + createElementChild(c, (Element) element.getParentNode(), footnoteBody, element, footnoteChildren, footnoteChildInfo, context); resolveChildren(c, footnoteBody, footnoteChildren, footnoteChildInfo); + c.setFootnoteAllowed(true); + c.setIsInFloatBottom(false); c.popLayer(); // System.out.println(); @@ -1518,7 +1523,13 @@ private static void createChildren( insertGeneratedContent(c, parent, parentStyle, "before", children, info); if (parentStyle.isFootnote()) { - insertGeneratedContent(c, parent, parentStyle, "footnote-marker", children, info); + if (c.isFootnoteAllowed()) { + insertGeneratedContent(c, parent, parentStyle, "footnote-marker", children, info); + // Ban further footnote content until we bubble back up to createFootnoteBody. + c.setFootnoteAllowed(false); + } else { + XRLog.log(Level.WARNING, LogMessageId.LogMessageId0Param.GENERAL_NO_FOOTNOTES_INSIDE_FOOTNOTES); + } } Node working = parent.getFirstChild(); @@ -1532,7 +1543,7 @@ private static void createChildren( if (nodeType == Node.ELEMENT_NODE) { createElementChild( - c, parent, blockParent, working, children, info, context, true); + c, parent, blockParent, working, children, info, context); } else if (nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE) { context.needStartText = false; context.needEndText = false; diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java index 8f82ae2e0..8ba9b3190 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/LayoutContext.java @@ -106,6 +106,7 @@ public enum BlockBoxingState { private int _footnoteIndex; private FootnoteManager _footnoteManager; + private boolean _isFootnoteAllowed = true; @Override public TextRenderer getTextRenderer() { @@ -541,6 +542,21 @@ public void setBreakAtLineContext(BreakAtLineContext breakAtLineContext) { _breakAtLineContext = breakAtLineContext; } + /** + * Whether further footnote content is allowed. Used to prohibit + * footnotes inside footnotes. + */ + public boolean isFootnoteAllowed() { + return _isFootnoteAllowed; + } + + /** + * See {@link #isFootnoteAllowed()}. + */ + public void setFootnoteAllowed(boolean allowed) { + this._isFootnoteAllowed = allowed; + } + /** * See {@link #isInFloatBottom()} */ diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java index facbe410d..9d9b28483 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java @@ -36,6 +36,7 @@ enum LogMessageId0Param implements LogMessageId { MATCH_TRYING_TO_SET_MORE_THAN_ONE_PSEUDO_ELEMENT(XRLog.MATCH, "Trying to set more than one pseudo-element"), + GENERAL_NO_FOOTNOTES_INSIDE_FOOTNOTES(XRLog.GENERAL, "Footnotes inside footnotes are not supported"), GENERAL_IMPORT_FONT_FACE_RULES_HAS_NOT_BEEN_CALLED(XRLog.GENERAL, "importFontFaceRules has not been called for this pdf transcoder"), GENERAL_PDF_ACCESSIBILITY_NO_ALT_ATTRIBUTE_PROVIDED_FOR_IMAGE(XRLog.GENERAL, "No alt attribute provided for image/replaced in PDF/UA document."), GENERAL_PDF_SPECIFIED_FONTS_DONT_CONTAIN_A_SPACE_CHARACTER(XRLog.GENERAL, "Specified fonts don't contain a space character!"), @@ -56,6 +57,7 @@ enum LogMessageId0Param implements LogMessageId { EXCEPTION_COULD_NOT_READ_PDF_AS_SRC_FOR_IMG(XRLog.EXCEPTION, "Could not read pdf passed as src for img element!"), EXCEPTION_COULD_NOT_PARSE_DEFAULT_STYLESHEET(XRLog.EXCEPTION, "Could not parse default stylesheet"), EXCEPTION_SELECTOR_BAD_SIBLING_AXIS(XRLog.EXCEPTION, "Bad sibling axis"); + private final String where; private final String messageFormat; diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-footnote-inside-footnote.pdf b/openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-footnote-inside-footnote.pdf new file mode 100644 index 0000000000000000000000000000000000000000..81a85f366a75bac5db6fbe7daff7c5939ceb7e46 GIT binary patch literal 4257 zcmcgwOK;mo5WX*v|1cLL4hoa|;4?4`NR||&O;Fbs>b8atj7V8@CDNs+I_;nBrN5!4 z9y+rWr6nm#DiB1m1!=SM{^pyZPp$@|GhsRG~uU! zmw-RZe33w!olWQYGrWQEBO8uiR^dv^M_)p%Vp8G6+Ak)Qu%y7gK#xr6;qOVdkt9&M zT!d7|mqG}YB|8Hb!m&b1ds9yA4OK{KIbET9)89RwQnIN~7`0B+A}_W% z?quzl*hwP>qBIbweADbe+C6D;G~blkA2s2lBLX#0BADiRiH)CZvamDZ=xXR&E@qtk zd`__s4AC@Org38J%|2=fxE0jds~sq3l*9~~^pLdYSiCY{yL`}~<6APIE+eOVSqu?I zI!lVTwXGl6E1CjTFW2*c_^|Hz5q1Oi7@n9DgDA4TQ4Ji;Ak4m5eJb?;`jBS7BCmkh zuy56)mHhk&m>hIh;72tO_5MSG}sRSE&NV zk@f|f-!LtSbIf=(SJ$T3G^n`vsx)|zNvNBA*C4}QRct^qsQ`+f4njt_fkB4viYSXG zvveMB`y@TUP2`7zeOe>EgVvp()5EV$u|}P&2IO`C3v*FfSHbn%uUZ8J#!F1@SA(ck zgduiaKHW6;v9#DI-Q_zO&F7ZimH9uzpn;S)pR5+RUu^((WTYyz zl%}U+xqlVZ*Id)f-`ChfBvKO| ztWm@Dnq+a4g{tMuz`wZ<;x2>*Z_$*wt*u>}&^C|64EDQxoHKh+Z{7A!KmP*RYCZ=c zef`1Q`!xI3(cJ>q8g7hjSnQYqJ8bF60b5(H?3mJQyU&y+g8IU)xTX1+vGan-94{y4 z7-vmj?8=KSO6_cAituBMMmiKY;-Y1uk!6q5MY24*&KD6DYM4#(IL#iwzD=_p?iKZc zk^9d@GR4hUdW>&g;JL1HVTud+`b7Yx7i60=T$Vd$+{Z!Nx+hilO!=6^);%Xc#I?>m zf==^HcnaB|edb{*TW5ZNoZmVNdFLKJ=5^wbGVI<9X=F6@;kAx`ihGEl<~_y3PX3he zJ8>w8A#)TH2jr615`)ry6 z-lNC9_t^U9qrUGAN25z$4cuX`F9(6@^_>17R6+0Za^zgV;VZ~dH|d`V;ZHvYMn$O+ OsoX%Zlat~1BlaKE@#bUz literal 0 HcmV?d00001 diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnote-inside-footnote.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnote-inside-footnote.html new file mode 100644 index 000000000..4f153e46a --- /dev/null +++ b/openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-footnote-inside-footnote.html @@ -0,0 +1,53 @@ + + + + + + This is some in-flow content. + +
      + This is a footnote with a footnote inside. +
      + This is the inner footnote. +
      + And another: +
      + Another fn inside fn. +
      + Grandchild footnote in footnote. +
      +
      +
      + + Even more in-flow content. + +
      + Second footnote. +
      + + End of document. + + + diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java index 9f65bf633..31cbbd4ce 100644 --- a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java +++ b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/FootnoteVisualRegressionTest.java @@ -165,4 +165,13 @@ public void testIssue364NonPaginatedTable() throws IOException { assertTrue(vt.runTest("issue-364-non-paginated-table")); } + /** + * Tests that footnotes inside footnotes are treated as non-footnote content + * and do not cause infinite loop, stack overflow, OOM, etc. + */ + @Test + public void testIssue364FootnoteInsideFootnote() throws IOException { + assertTrue(vt.runTest("issue-364-footnote-inside-footnote")); + } + } From 228744ad7c1e597e77bed1ee1f8ef76c4c3a0387 Mon Sep 17 00:00:00 2001 From: danfickle Date: Wed, 25 Aug 2021 18:43:55 +1000 Subject: [PATCH 41/54] #364 Warn if an invalid element is being used as a footnote. Footnotes should be display: block, position: static, float: none and non-replaced. Treat invalid elements as normal content. With test proof. --- .../com/openhtmltopdf/layout/BoxBuilder.java | 88 ++++++++++++------ .../com/openhtmltopdf/util/LogMessageId.java | 1 + .../footnote/issue-364-invalid-style.pdf | Bin 0 -> 14925 bytes .../footnote/issue-364-invalid-style.html | 63 +++++++++++++ .../FootnoteVisualRegressionTest.java | 9 ++ 5 files changed, 132 insertions(+), 29 deletions(-) create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/expected/footnote/issue-364-invalid-style.pdf create mode 100644 openhtmltopdf-examples/src/main/resources/visualtest/html/footnote/issue-364-invalid-style.html diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java index 2a0ba1d39..408a9ed57 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/layout/BoxBuilder.java @@ -1179,10 +1179,7 @@ private static List createGeneratedMarginBoxContent( private static BlockBox createBlockBox( CalculatedStyle style, ChildBoxInfo info, boolean generated) { - if (style.isFootnote()) { - BlockBox result = new BlockBox(); - return result; - } else if (style.isFloated() && !(style.isAbsolute() || style.isFixed())) { + if (style.isFloated() && !(style.isAbsolute() || style.isFixed())) { BlockBox result; if (style.isTable() || style.isInlineTable()) { result = new TableBox(); @@ -1282,6 +1279,43 @@ private static class CreateChildrenContext { final CalculatedStyle parentStyle; } + private static boolean isValidFootnote( + LayoutContext c, Element element, CalculatedStyle style) { + return c.isPrint() && + (style.isInline() || style.isSpecifiedAsBlock()) && + !style.isPostionedOrFloated() && + !c.getSharedContext().getReplacedElementFactory().isReplacedElement(element); + } + + private static void logInvalidFootnoteStyle( + LayoutContext c, Element element, CalculatedStyle style) { + String cause = ""; + + if (!style.isInline() && !style.isSpecifiedAsBlock()) { + cause = "The footnote element should be display: block (such as
      )"; + } else if (style.isFloated()) { + cause = "The footnote element must not be floated"; + } else if (c.getSharedContext().getReplacedElementFactory().isReplacedElement(element)) { + cause = "The footnote element must not be replaced (such as )"; + } else if (style.isPositioned()) { + cause = "The footnote element must have position: static (not absolute, relative or fixed)"; + } + + XRLog.log(Level.WARNING, LogMessageId.LogMessageId1Param.GENERAL_FOOTNOTE_INVALID, cause); + } + + /** + * Don't output elements that have been artificially created to support + * footnotes and content property images. + */ + private static boolean isGeneratedElement(Element element) { + String tag = element.getNodeName(); + + return ("fs-footnote-marker".equals(tag)) || + ("a".equals(tag) && element.getAttribute("href").startsWith("#fs-footnote")) || + ("img".equals(tag) && element.getAttribute("fs-ignore").equals("true")); + } + private static void createElementChild( LayoutContext c, Element parent, @@ -1296,16 +1330,7 @@ private static void createElementChild( Element element = (Element) working; CalculatedStyle style = sharedContext.getStyle(element); - if (style.isDisplayNone()) { - return; - } - - String tag = element.getNodeName(); - if (("fs-footnote-marker".equals(tag)) || - ("a".equals(tag) && element.getAttribute("href").startsWith("#fs-footnote")) || - ("img".equals(tag) && element.getAttribute("fs-ignore").equals("true"))) { - // Don't output elements that have been artificially created to support - // footnotes and content property images. + if (style.isDisplayNone() || isGeneratedElement(element)) { return; } @@ -1324,23 +1349,28 @@ private static void createElementChild( } if (style.isFootnote() && !c.isInFloatBottom()) { - c.setFootnoteIndex(c.getFootnoteIndex() + 1); + if (isValidFootnote(c, element, style)) { + c.setFootnoteIndex(c.getFootnoteIndex() + 1); - // This is the official footnote call content that can generate zero or more boxes - // depending on user for ::footnote-call pseudo element. - insertGeneratedContent(c, element, style, "footnote-call", children, info); + // This is the official footnote call content that can generate zero or more boxes + // depending on user for ::footnote-call pseudo element. + insertGeneratedContent(c, element, style, "footnote-call", children, info); - BlockBox footnoteBody = createFootnoteBody(c, element, style); + BlockBox footnoteBody = createFootnoteBody(c, element, style); - // This is purely a marker box for the footnote so we - // can figure out in layout when to add the footnote body. - InlineBox iB = createInlineBox("", parent, context.parentStyle, null); - iB.setStartsHere(true); - iB.setEndsHere(true); - iB.setFootnote(footnoteBody); + // This is purely a marker box for the footnote so we + // can figure out in layout when to add the footnote body. + InlineBox iB = createInlineBox("", parent, context.parentStyle, null); + iB.setStartsHere(true); + iB.setEndsHere(true); + iB.setFootnote(footnoteBody); - children.add(iB); - return; + children.add(iB); + + return; + } else { + logInvalidFootnoteStyle(c, element, style); + } } if (style.isInline()) { @@ -1523,11 +1553,11 @@ private static void createChildren( insertGeneratedContent(c, parent, parentStyle, "before", children, info); if (parentStyle.isFootnote()) { - if (c.isFootnoteAllowed()) { + if (c.isFootnoteAllowed() && isValidFootnote(c, parent, parentStyle)) { insertGeneratedContent(c, parent, parentStyle, "footnote-marker", children, info); // Ban further footnote content until we bubble back up to createFootnoteBody. c.setFootnoteAllowed(false); - } else { + } else if (!c.isFootnoteAllowed()) { XRLog.log(Level.WARNING, LogMessageId.LogMessageId0Param.GENERAL_NO_FOOTNOTES_INSIDE_FOOTNOTES); } } diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java index 9d9b28483..802193eb9 100644 --- a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java +++ b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/util/LogMessageId.java @@ -147,6 +147,7 @@ enum LogMessageId1Param implements LogMessageId { GENERAL_PDF_FOUND_FORM_CONTROL_WITH_NO_ENCLOSING_FORM(XRLog.GENERAL, "Found form control ({}) with no enclosing form. Ignoring."), GENERAL_PDF_A_ELEMENT_DOES_NOT_HAVE_OPTION_CHILDREN(XRLog.GENERAL, "A <{}> element does not have
      		", "