Add structParents directly before adding entry to parentTree so StructParents write only for pages when it's necessary; update cmps

DEVSIX-1253

Author: LodrKumquat

forms/src/test/resources/com/itextpdf/forms/FormFieldsTaggingTest/cmp_taggedPdfWithForms01.pdf

@@ -73,7 +73,6 @@ public class PdfPage extends PdfObjectWrapper<PdfDictionary> {
     private static final long serialVersionUID = -952395541908379500L;
 	private PdfResources resources = null;
     private int mcid = -1;
-    private int structParents = -1;
     PdfPages parentPages;
     private List<PdfName> excludedKeys = new ArrayList<>(Arrays.asList(
             PdfName.Parent,
@@ -106,8 +105,6 @@ protected PdfPage(PdfDocument pdfDocument, PageSize pageSize) {
         getPdfObject().put(PdfName.MediaBox, new PdfArray(pageSize));
         getPdfObject().put(PdfName.TrimBox, new PdfArray(pageSize));
         if (pdfDocument.isTagged()) {
-            structParents = (int) pdfDocument.getNextStructParentIndex();
-            getPdfObject().put(PdfName.StructParents, new PdfNumber(structParents));
             setTabOrder(PdfName.S);
         }
     }
@@ -392,8 +389,8 @@ public PdfPage copyTo(PdfDocument toDocument, IPdfPageExtraCopier copier) {
             }
         }
         if (toDocument.isTagged()) {
-            page.structParents = (int) toDocument.getNextStructParentIndex();
-            page.getPdfObject().put(PdfName.StructParents, new PdfNumber(page.structParents));
+            int structParents = (int) toDocument.getNextStructParentIndex();
+            page.getPdfObject().put(PdfName.StructParents, new PdfNumber(structParents));
         }
 
         if (copier != null) {
@@ -720,17 +717,10 @@ public int getNextMcid() {
      * Gets {@link Integer} key of the page’s entry in the structural parent tree.
      *
      * @return {@link Integer} key of the page’s entry in the structural parent tree.
+     * If page has no entry in the structural parent tree, returned value is -1.
      */
     public Integer getStructParentIndex() {
-        if (structParents == -1) {
-            PdfNumber n = getPdfObject().getAsNumber(PdfName.StructParents);
-            if (n != null) {
-                structParents = n.intValue();
-            } else {
-                structParents = (int) getDocument().getNextStructParentIndex();
-            }
-        }
-        return structParents;
+        return getPdfObject().getAsNumber(PdfName.StructParents) != null ? getPdfObject().getAsNumber(PdfName.StructParents).intValue() : -1;
     }
 
     /**

forms/src/test/resources/com/itextpdf/forms/FormFieldsTaggingTest/cmp_taggedPdfWithForms02.pdf

@@ -122,7 +122,7 @@ public PdfObjRef findObjRefByStructParentIndex(PdfDictionary pageDict, int struc
     }
 
     public int getNextMcidForPage(PdfPage page) {
-        TreeMap<Integer, PdfMcr> pageMcrs = pageToPageMcrs.get(page.getPdfObject().getIndirectReference());
+        TreeMap<Integer, PdfMcr> pageMcrs = (TreeMap) getPageMarkedContentReferences(page);
         if (pageMcrs == null || pageMcrs.size() == 0) {
             return 0;
         } else {
@@ -146,7 +146,7 @@ public void createParentTreeEntryForPage(PdfPage page) {
             return;
         }
         pageToPageMcrs.remove(page.getPdfObject().getIndirectReference());
-        updateStructParentTreeEntries(page.getStructParentIndex(), mcrs);
+        updateStructParentTreeEntries(page, mcrs);
         structTreeRoot.setModified();
     }
 
@@ -269,7 +269,7 @@ private void registerAllMcrs() {
         }
     }
 
-    private void updateStructParentTreeEntries(Integer pageStructParentIndex, Map<Integer, PdfMcr> mcrs) {
+    private void updateStructParentTreeEntries(PdfPage page, Map<Integer, PdfMcr> mcrs) {
         // element indexes in parentsOfPageMcrs shall be the same as mcid of one of their kids.
         // See "Finding Structure Elements from Content Items" in pdf spec.
         PdfArray parentsOfPageMcrs = new PdfArray();
@@ -289,10 +289,11 @@ private void updateStructParentTreeEntries(Integer pageStructParentIndex, Map<In
             }
         }
 
-
         if (parentsOfPageMcrs.size() > 0) {
             parentsOfPageMcrs.makeIndirect(structTreeRoot.getDocument());
-            parentTree.addEntry(pageStructParentIndex, parentsOfPageMcrs);
+            int structParents = (int) page.getStructParentIndex() != -1 ? (int) page.getStructParentIndex() : (int) page.getDocument().getNextStructParentIndex();
+            page.getPdfObject().put(PdfName.StructParents, new PdfNumber(structParents));
+            parentTree.addEntry((Integer) structParents, parentsOfPageMcrs);
             structTreeRoot.getDocument().checkIsoConformance(parentsOfPageMcrs, IsoKey.TAG_STRUCTURE_ELEMENT);
             parentsOfPageMcrs.flush();
         }

forms/src/test/resources/com/itextpdf/forms/FormFieldsTaggingTest/cmp_taggedPdfWithForms03.pdf

@@ -59,7 +59,6 @@ This file is part of the iText (R) project.
 import com.itextpdf.test.annotations.type.IntegrationTest;
 
 import org.junit.BeforeClass;
-import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
@@ -76,7 +75,6 @@ public static void beforeClass() {
     }
 
     @Test
-    @Ignore("DEVSIX-1253")
     public void test01() throws IOException, InterruptedException {
         String outFile = destinationFolder + "parentTreeTest01.pdf";
         String cmpFile = sourceFolder + "cmp_parentTreeTest01.pdf";
@@ -109,7 +107,6 @@ public void test01() throws IOException, InterruptedException {
 
 
     @Test
-    @Ignore("DEVSIX-1253")
     public void test02() throws IOException, InterruptedException {
         String outFile = destinationFolder + "parentTreeTest02.pdf";
         String cmpFile = sourceFolder + "cmp_parentTreeTest02.pdf";
@@ -142,7 +139,6 @@ public void test02() throws IOException, InterruptedException {
     }
 
     @Test
-    @Ignore("DEVSIX-1253")
     public void test03() throws IOException, InterruptedException {
         String outFile = destinationFolder + "parentTreeTest03.pdf";
         String cmpFile = sourceFolder + "cmp_parentTreeTest03.pdf";
@@ -176,7 +172,6 @@ public void test03() throws IOException, InterruptedException {
     }
 
     @Test
-    @Ignore("DEVSIX-1253")
     public void test04() throws IOException, InterruptedException {
         String outFile = destinationFolder + "parentTreeTest04.pdf";
         String cmpFile = sourceFolder + "cmp_parentTreeTest04.pdf";
@@ -208,7 +203,6 @@ public void test04() throws IOException, InterruptedException {
     }
 
     @Test
-    @Ignore("DEVSIX-1253")
     public void test05() throws IOException, InterruptedException {
         String outFile = destinationFolder + "parentTreeTest05.pdf";
         String cmpFile = sourceFolder + "cmp_parentTreeTest05.pdf";
@@ -257,7 +251,6 @@ public void test05() throws IOException, InterruptedException {
     }
 
     @Test
-    @Ignore("DEVSIX-1253")
     public void test06() throws IOException, InterruptedException {
         String outFile = destinationFolder + "parentTreeTest06.pdf";
         String cmpFile = sourceFolder + "cmp_parentTreeTest06.pdf";