Improve coverage of ImageRenderInfo class

DEVSIX-7101

Author: Vitali Prudnikovich

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/parser/data/ImageRenderInfo.java

@@ -64,22 +64,22 @@ public class ImageRenderInfo extends AbstractRenderInfo {
     /**
      * The coordinate transformation matrix that was in effect when the image was rendered.
      */
-    private Matrix ctm;
-    private PdfImageXObject image;
+    private final Matrix ctm;
+    private final PdfImageXObject image;
     /**
      * The color space dictionary from resources which are associated with the image.
      */
-    private PdfDictionary colorSpaceDictionary;
+    private final PdfDictionary colorSpaceDictionary;
     /**
      * Defines if the encountered image was inline.
      */
-    private boolean isInline;
-    private PdfName resourceName;
+    private final boolean isInline;
+    private final PdfName resourceName;
 
     /**
      * Hierarchy of nested canvas tags for the text from the most inner (nearest to text) tag to the most outer.
      */
-    private List<CanvasTag> canvasTagHierarchy;
+    private final List<CanvasTag> canvasTagHierarchy;
 
     /**
      * Creates an ImageRenderInfo.
@@ -93,8 +93,8 @@ public class ImageRenderInfo extends AbstractRenderInfo {
      * @param colorSpaceDictionary the color space dictionary from resources which are associated with the image
      * @param isInline             defines if the encountered image was inline
      */
-    public ImageRenderInfo(Stack<CanvasTag> canvasTagHierarchy, CanvasGraphicsState gs, Matrix ctm, PdfStream imageStream,
-                           PdfName resourceName, PdfDictionary colorSpaceDictionary, boolean isInline) {
+    public ImageRenderInfo(Stack<CanvasTag> canvasTagHierarchy, CanvasGraphicsState gs, Matrix ctm,
+            PdfStream imageStream, PdfName resourceName, PdfDictionary colorSpaceDictionary, boolean isInline) {
         super(gs);
         this.canvasTagHierarchy = Collections.<CanvasTag>unmodifiableList(new ArrayList<>(canvasTagHierarchy));
         this.resourceName = resourceName;
@@ -221,14 +221,14 @@ public boolean hasMcid(int mcid) {
     public boolean hasMcid(int mcid, boolean checkTheTopmostLevelOnly) {
         if (checkTheTopmostLevelOnly) {
             if (canvasTagHierarchy != null) {
-                int infoMcid = getMcid();
+                final int infoMcid = getMcid();
                 return infoMcid != -1 && infoMcid == mcid;
             }
         } else {
-            for (CanvasTag tag : canvasTagHierarchy) {
-                if (tag.hasMcid())
-                    if (tag.getMcid() == mcid)
-                        return true;
+            for (final CanvasTag tag : canvasTagHierarchy) {
+                if (tag.hasMcid() && (tag.getMcid() == mcid)) {
+                    return true;
+                }
             }
         }
         return false;

kernel/src/test/java/com/itextpdf/kernel/pdf/canvas/parser/PdfCanvasProcessorIntegrationTest.java

@@ -44,6 +44,7 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.io.logs.IoLogMessageConstant;
 import com.itextpdf.io.source.ByteArrayOutputStream;
+import com.itextpdf.kernel.geom.Matrix;
 import com.itextpdf.kernel.logs.KernelLogMessageConstant;
 import com.itextpdf.kernel.exceptions.PdfException;
 import com.itextpdf.kernel.colors.Color;
@@ -220,6 +221,36 @@ public void patternColorParsingValidPdfTest() throws IOException {
         }
     }
 
+    @Test
+    public void checkImageRenderInfoProcessorTest() throws IOException {
+        PdfDocument document = new PdfDocument(new PdfReader(SOURCE_FOLDER + "tableWithImageAndText.pdf"),
+                new PdfWriter(new ByteArrayOutputStream()));
+
+        PdfPage page = document.getPage(1);
+        RecordFirstImageEventListener eventListener = new RecordFirstImageEventListener();
+        PdfCanvasProcessor processor = new PdfCanvasProcessor(eventListener);
+        processor.processPageContent(page);
+
+        // Check caught image's ImageRenderInfo
+        ImageRenderInfo imageRenderInfo = eventListener.getImageRenderInfo();
+        final float EPS = 0.001f;
+        Assert.assertFalse(imageRenderInfo.isInline());
+        Assert.assertEquals(1024, imageRenderInfo.getImage().getWidth(), EPS);
+        Assert.assertEquals(768, imageRenderInfo.getImage().getHeight(), EPS);
+        Assert.assertEquals("/Im1", imageRenderInfo.getImageResourceName().toString());
+        Assert.assertEquals(new com.itextpdf.kernel.geom.Vector(212.67f, 676.25f, 1),
+                imageRenderInfo.getStartPoint());
+        Assert.assertEquals(new Matrix(169.67f, 0, 0, 0, 127.25f, 0, 212.67f, 676.25f, 1),
+                imageRenderInfo.getImageCtm());
+        Assert.assertEquals(21590.508, imageRenderInfo.getArea(), EPS);
+        Assert.assertNull(imageRenderInfo.getColorSpaceDictionary());
+        Assert.assertEquals(1, imageRenderInfo.getCanvasTagHierarchy().size());
+        Assert.assertTrue(imageRenderInfo.hasMcid(5, true));
+        Assert.assertTrue(imageRenderInfo.hasMcid(5));
+        Assert.assertFalse(imageRenderInfo.hasMcid(1));
+        Assert.assertEquals(5, imageRenderInfo.getMcid());
+    }
+
     private static class ColorParsingEventListener implements IEventListener {
         private List<IEventData> content = new ArrayList<>();
         private static final String pathDataExpected = "Path data expected.";
@@ -267,6 +298,32 @@ public Set<EventType> getSupportedEvents() {
         }
     }
 
+    private static class RecordFirstImageEventListener implements IEventListener {
+
+        private ImageRenderInfo imageRenderInfo = null;
+
+        RecordFirstImageEventListener() {
+        }
+
+        public void eventOccurred(IEventData data, EventType type) {
+            switch (type) {
+                case RENDER_IMAGE:
+                    if (imageRenderInfo == null) {
+                        imageRenderInfo = (ImageRenderInfo) data;
+                    }
+                    break;
+            }
+        }
+
+        public Set<EventType> getSupportedEvents() {
+            return null;
+        }
+
+        public ImageRenderInfo getImageRenderInfo() {
+            return imageRenderInfo;
+        }
+    }
+
     private static class RecordEveryHighLevelEventListener implements IEventListener {
         private static final String END_EVENT_OCCURRENCE = "------------------------------------";
         private StringBuilder sb;

kernel/src/test/java/com/itextpdf/kernel/pdf/canvas/parser/data/ImageRenderInfoTest.java

@@ -0,0 +1,57 @@
+package com.itextpdf.kernel.pdf.canvas.parser.data;
+
+import com.itextpdf.io.image.ImageDataFactory;
+import com.itextpdf.kernel.geom.Matrix;
+import com.itextpdf.kernel.pdf.PdfDictionary;
+import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfStream;
+import com.itextpdf.kernel.pdf.canvas.CanvasGraphicsState;
+import com.itextpdf.kernel.pdf.canvas.CanvasTag;
+import com.itextpdf.kernel.pdf.xobject.PdfImageXObject;
+import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.annotations.type.UnitTest;
+
+import java.net.MalformedURLException;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+import java.util.*;
+
+@Category(UnitTest.class)
+public class ImageRenderInfoTest extends ExtendedITextTest {
+    private static final String SOURCE_FOLDER = "./src/test/resources/com/itextpdf/kernel/parser/data/"
+            + "ImageRenderInfoTest/";
+    private final float EPS = 0.001f;
+
+    @Test
+    public void checkImageRenderInfoTest() throws MalformedURLException {
+        String source_image = SOURCE_FOLDER + "simple.tif";
+
+        PdfImageXObject image = new PdfImageXObject(ImageDataFactory.create(source_image));
+        PdfStream imageStream = image.getPdfObject();
+        Matrix matrix = new Matrix(2, 0.5f, 0, 2, 0.5f, 0);
+        Stack<CanvasTag> tagHierarchy = new Stack<CanvasTag>();
+        tagHierarchy.push(new CanvasTag(new PdfName("tag"), 2));
+        ImageRenderInfo imageRenderInfo = new ImageRenderInfo(tagHierarchy, new TestGraphicsState(), matrix,
+                imageStream, new PdfName("Im1"), new PdfDictionary(), true);
+
+        Assert.assertTrue(imageRenderInfo.isInline());
+        Assert.assertEquals(image.getWidth(), imageRenderInfo.getImage().getWidth(), EPS);
+        Assert.assertEquals("/Im1", imageRenderInfo.getImageResourceName().toString());
+        Assert.assertEquals(new com.itextpdf.kernel.geom.Vector(0.5f, 0, 1), imageRenderInfo.getStartPoint());
+        Assert.assertEquals(matrix, imageRenderInfo.getImageCtm());
+        Assert.assertEquals(4, imageRenderInfo.getArea(), EPS);
+        Assert.assertEquals(0, imageRenderInfo.getColorSpaceDictionary().size());
+        Assert.assertEquals(1, imageRenderInfo.getCanvasTagHierarchy().size());
+        Assert.assertTrue(imageRenderInfo.hasMcid(2, true));
+        Assert.assertTrue(imageRenderInfo.hasMcid(2));
+        Assert.assertFalse(imageRenderInfo.hasMcid(1));
+        Assert.assertEquals(2, imageRenderInfo.getMcid());
+    }
+
+    private class TestGraphicsState extends CanvasGraphicsState {
+        protected TestGraphicsState() {
+        }
+    }
+}