Merge branch 'layout_tagging_helper' into 7.1

Author: yulian-gaponenko

io/src/main/java/com/itextpdf/io/LogMessageConstant.java

@@ -49,15 +49,23 @@ This file is part of the iText (R) project.
 public final class LogMessageConstant {
 
     public static final String ACTION_WAS_SET_TO_LINK_ANNOTATION_WITH_DESTINATION = "Action was set for a link annotation containing destination. The old destination will be cleared.";
-    public static final String ASSOCIATED_FILE_SPEC_SHALL_INCLUDE_AFRELATIONSHIP = "For associated files their associated file specification dictionaries shall include the AFRelationship key.";
     public static final String ALREADY_FLUSHED_INDIRECT_OBJECT_MADE_FREE = "An attempt is made to free already flushed indirect object reference. Indirect reference wasn't freed.";
+    public static final String ALREADY_TAGGED_HINT_MARKED_ARTIFACT = "A layout tagging hint for which an actual tag was already created in tags structure is marked as artifact. Existing tag will be left in the tags tree.";
+    public static final String ASSOCIATED_FILE_SPEC_SHALL_INCLUDE_AFRELATIONSHIP = "For associated files their associated file specification dictionaries shall include the AFRelationship key.";
+    public static final String ATTEMPT_TO_CREATE_A_TAG_FOR_FINISHED_HINT = "Attempt to create a tag for a hint which is already marked as finished, tag will not be created.";
     public static final String ATTEMPT_TO_MOVE_TO_FLUSHED_PARENT = "An attempt is made to move the tag tree pointer to the tag parent which has been already flushed. Tag tree pointer is moved to the root tag instead.";
     public static final String CALCULATE_HASHCODE_FOR_MODIFIED_PDFNUMBER = "Calculate hashcode for modified PdfNumber.";
+    public static final String CANNOT_ADD_FINISHED_HINT_AS_A_NEW_KID_HINT = "Layout tagging hints addition failed: cannot add a hint that is already marked as finished. Consider using com.itextpdf.layout.tagging.LayoutTaggingHelper#moveKidHint method for moving already finished kid hint from not yet finished parent hint.";
+    public static final String CANNOT_ADD_HINTS_TO_FINISHED_PARENT = "Layout tagging hints addition failed: cannot add new kid hints to a parent which hint is already marked as finished. Consider using com.itextpdf.layout.tagging.LayoutTaggingHelper#replaceKidHint method for replacing not yet finished kid hint of a finished parent hint.";
+    public static final String CANNOT_ADD_KID_HINT_WHICH_IS_ALREADY_ADDED_TO_ANOTHER_PARENT = "Layout tagging hints addition failed: cannot add a kid hint to a new parent if it is already added to another parent. Consider using com.itextpdf.layout.tagging.LayoutTaggingHelper#moveHint method instead.";
+    public static final String CANNOT_MOVE_FINISHED_HINT = "Layout tagging hints modification failed: cannot move kid hint for which both itself and it's parent are already marked as finished.";
+    public static final String CANNOT_MOVE_HINT_TO_FINISHED_PARENT = "Layout tagging hints modification failed: cannot move kid hint to a parent that is already marked as finished.";
+    public static final String CANNOT_REPLACE_FINISHED_HINT = "Layout tagging hints modification failed: cannot replace a kid hint that is already marked as finished.";
     public static final String CANNOT_RESOLVE_ROLE_IN_NAMESPACE_TOO_MUCH_TRANSITIVE_MAPPINGS = "Cannot resolve \"{0}\" role in {1} namespace mapping to standard role, because of the too much transitive mappings.";
     public static final String CANNOT_RESOLVE_ROLE_TOO_MUCH_TRANSITIVE_MAPPINGS = "Cannot resolve \"{0}\" role mapping to standard role, because of the too much transitive mappings.";
     public static final String CLIP_ELEMENT = "Element content was clipped because some height properties are set.";
-    public static final String COLOR_ALPHA_CHANNEL_IS_IGNORED = "Alpha channel {0} was ignored during color creation. Note that opacity can be achieved in some places by using 'setOpacity' method or 'TransparentColor' class";
     public static final String COLORANT_INTENSITIES_INVALID = "Some of colorant intensities are invalid: they are bigger than 1 or less than 0. We will force them to become 1 or 0 respectively.";
+    public static final String COLOR_ALPHA_CHANNEL_IS_IGNORED = "Alpha channel {0} was ignored during color creation. Note that opacity can be achieved in some places by using 'setOpacity' method or 'TransparentColor' class";
     public static final String COLOR_NOT_PARSED = "Color \"{0}\" was not parsed. It has invalid value. Defaulting to black color.";
     public static final String COULD_NOT_FIND_GLYPH_WITH_CODE = "Could not find glyph with the following code: {0}";
     public static final String CREATED_ROOT_TAG_HAS_MAPPING = "Created root tag has role mapping: \"/Document\" role{0} is mapped{1}. Resulting tag structure might have invalid root tag.";
@@ -127,6 +135,7 @@ public final class LogMessageConstant {
     public static final String STRUCTURE_ELEMENT_REPLACED_BY_ITS_ID_IN_STRUCTURE_DESTINATION = "Structure destinations shall specify structure element ID in remote go-to actions. Structure element has been replaced with its ID in the structure destination";
     public static final String SUM_OF_TABLE_COLUMNS_IS_GREATER_THAN_100 = "Sum of table columns is greater than 100%.";
     public static final String TABLE_WIDTH_IS_MORE_THAN_EXPECTED_DUE_TO_MIN_WIDTH = "Table width is more than expected due to min width of cell(s).";
+    public static final String TAGGING_HINT_NOT_FINISHED_BEFORE_CLOSE = "Tagging hint wasn't finished before closing.";
     public static final String TAG_STRUCTURE_CONTEXT_WILL_BE_REINITIALIZED_ON_SERIALIZATION = "Tag structure context is not null and will be reinitialized in the copy of document. The copy may lose some data";
     public static final String TAG_STRUCTURE_INIT_FAILED = "Tag structure initialization failed, tag structure is ignored, it might be corrupted.";
     public static final String TYPE3_FONT_CANNOT_BE_ADDED = "Type 3 font cannot be added to FontSet. Custom FontProvider class may be created for this purpose.";

kernel/src/main/java/com/itextpdf/kernel/PdfException.java

@@ -106,6 +106,9 @@ public class PdfException extends RuntimeException {
     public static final String CannotReadAStreamInOrderToAppendNewBytes = "Cannot read a stream in order to append new bytes.";
     public static final String CannotReadPdfObject = "Cannot read PdfObject.";
     public static final String CannotRecogniseDocumentFontWithEncoding = "Cannot recognise document font {0} with {1} encoding";
+    public static final String CannotRelocateRootTag = "Cannot relocate root tag.";
+    public static final String CannotRelocateTagWhichIsAlreadyFlushed = "Cannot relocate tag which is already flushed.";
+    public static final String CannotRelocateTagWhichParentIsAlreadyFlushed = "Cannot relocate tag which parent is already flushed.";
     public static final String CannotRemoveDocumentRootTag = "Cannot remove document root tag.";
     public static final String CannotRemoveMarkedContentReferenceBecauseItsPageWasAlreadyFlushed = "Cannot remove marked content reference, because its page has been already flushed.";
     public static final String CannotRemoveTagBecauseItsParentIsFlushed = "Cannot remove tag, because its parent is flushed.";

kernel/src/main/java/com/itextpdf/kernel/pdf/tagutils/TagStructureContext.java

@@ -528,6 +528,38 @@ boolean targetTagStructureVersionIs2() {
         return PdfVersion.PDF_2_0.compareTo(tagStructureTargetVersion) <= 0;
     }
 
+    void flushParentIfBelongsToPage(PdfStructElem parent, PdfPage currentPage) {
+        if (parent.isFlushed() || waitingTagsManager.getObjForStructDict(parent.getPdfObject()) != null
+                || parent.getPdfObject() == getRootTag().getPdfObject()) {
+            return;
+        }
+
+        List<IStructureNode> kids = parent.getKids();
+        boolean readyToBeFlushed = true;
+        for (IStructureNode kid : kids) {
+            if (kid instanceof PdfMcr) {
+                PdfDictionary kidPage = ((PdfMcr) kid).getPageObject();
+                if (!kidPage.isFlushed() && (currentPage == null || !kidPage.equals(currentPage.getPdfObject()))) {
+                    readyToBeFlushed = false;
+                    break;
+                }
+            } else if (kid instanceof PdfStructElem) {
+                // If kid is structElem and was already flushed then in kids list there will be null for it instead of
+                // PdfStructElement. And therefore if we get into this if-clause it means that some StructElem wasn't flushed.
+                readyToBeFlushed = false;
+                break;
+            }
+        }
+
+        if (readyToBeFlushed) {
+            IStructureNode parentsParent = parent.getParent();
+            parent.flush();
+            if (parentsParent instanceof PdfStructElem) {
+                flushParentIfBelongsToPage((PdfStructElem)parentsParent, currentPage);
+            }
+        }
+    }
+
     private boolean isRoleAllowedToBeRoot(PdfName role) {
         if (targetTagStructureVersionIs2()) {
             return PdfName.Document.equals(role);
@@ -622,40 +654,6 @@ private void removePageTagFromParent(IStructureNode pageTag, IStructureNode pare
         }
     }
 
-    private void flushParentIfBelongsToPage(PdfStructElem parent, PdfPage currentPage) {
-        if (parent.isFlushed() || waitingTagsManager.getObjForStructDict(parent.getPdfObject()) != null
-                || parent.getPdfObject() == getRootTag().getPdfObject()) {
-            return;
-        }
-
-        List<IStructureNode> kids = parent.getKids();
-        boolean allKidsBelongToPage = true;
-        for (IStructureNode kid : kids) {
-            if (kid instanceof PdfMcr) {
-                PdfDictionary kidPage = ((PdfMcr) kid).getPageObject();
-                if (!kidPage.isFlushed() && !kidPage.equals(currentPage.getPdfObject())) {
-                    allKidsBelongToPage = false;
-                    break;
-                }
-            } else if (kid instanceof PdfStructElem) {
-                // If kid is structElem and was already flushed then in kids list there will be null for it instead of
-                // PdfStructElement. And therefore if we get into this if-clause it means that some StructElem wasn't flushed.
-                allKidsBelongToPage = false;
-                break;
-            }
-        }
-
-        if (allKidsBelongToPage) {
-            IStructureNode parentsParent = parent.getParent();
-            parent.flush();
-            if (parentsParent instanceof PdfStructElem) {
-                flushParentIfBelongsToPage((PdfStructElem)parentsParent, currentPage);
-            }
-        }
-
-        return;
-    }
-
     private String composeExceptionBasedOnNamespacePresence(String role, PdfNamespace namespace, String withoutNsEx, String withNsEx) {
         if (namespace == null) {
             return MessageFormat.format(withoutNsEx, role);