Support Character encodings related rules in UA-2

DEVSIX-9004

Author: AnhelinaM

commons/src/main/java/com/itextpdf/commons/datastructures/Tuple2.java

@@ -22,6 +22,8 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.commons.datastructures;
 
+import java.util.Objects;
+
 /**
  * Simple tuple container that holds two elements.
  *
@@ -61,6 +63,38 @@ public T2 getSecond() {
         return second;
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * <p>
+     * Note, that in case current class is overridden, equals should also be overridden.
+     *
+     * @param obj {@inheritDoc}
+     *
+     * @return {@inheritDoc}
+     */
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null || getClass() != obj.getClass()) {
+            return false;
+        }
+        Tuple2<T1, T2> that = (Tuple2<T1, T2>) obj;
+        return Objects.equals(this.first, that.first) && Objects.equals(this.second, that.second);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return {@inheritDoc}
+     */
+    @Override
+    public int hashCode() {
+        return Objects.hash((Object) first, (Object) second);
+    }
+
     /**
      * {@inheritDoc}
      */

commons/src/test/java/com/itextpdf/commons/datastructures/Tuple2Test.java

@@ -23,10 +23,11 @@ This file is part of the iText (R) project.
 package com.itextpdf.commons.datastructures;
 
 import com.itextpdf.test.ExtendedITextTest;
-
-import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 
 @Tag("UnitTest")
@@ -51,4 +52,48 @@ public void testTuple2_TestWithNullFirstValue() {
         assertNull(tuple.getFirst());
         assertEquals(Integer.valueOf(1), tuple.getSecond());
     }
+
+    @Test
+    public void equalsTest() {
+        Tuple2<String, Integer> tuple1 = new Tuple2<>("test", 1);
+        Tuple2<String, Integer> tuple2 = new Tuple2<>("test", 1);
+        assertEquals(tuple1, tuple2);
+    }
+
+    @Test
+    public void equalsSameTest() {
+        Tuple2<String, Integer> tuple = new Tuple2<>("test", 1);
+        assertEquals(tuple, tuple);
+    }
+
+    @Test
+    public void equalsNullTest() {
+        Tuple2<String, Integer> tuple = new Tuple2<>("test", 1);
+        assertNotEquals(tuple, null);
+    }
+
+    @Test
+    public void notEqualsTest() {
+        Tuple2<String, Integer> tuple1 = new Tuple2<>("test", 1);
+        Tuple2<String, Integer> tuple2 = new Tuple2<>("test", 2);
+        Tuple2<String, Integer> tuple3 = new Tuple2<>("test2", 2);
+        assertNotEquals(tuple1, tuple2);
+        assertNotEquals(tuple2, tuple3);
+        assertNotEquals(tuple1, tuple3);
+    }
+
+    @Test
+    public void equalsWithCustomTest() {
+        Tuple2<String, Integer> tuple1 = new Tuple2<>("test", 1);
+        Tuple2<String, Integer> tuple2 = new CustomTuple2<>("test", 1);
+        Tuple2<String, Integer> tuple3 = new CustomTuple2<>("test", 1);
+        assertNotEquals(tuple1, tuple2);
+        assertEquals(tuple2, tuple3);
+    }
+
+    private static class CustomTuple2<T1, T2> extends Tuple2<T1, T2> {
+        public CustomTuple2(T1 test, T2 i) {
+            super(test, i);
+        }
+    }
 }

io/src/main/java/com/itextpdf/io/font/OpenTypeParser.java

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.io.font;
 
+import com.itextpdf.commons.datastructures.Tuple2;
 import com.itextpdf.io.exceptions.IOException;
 import com.itextpdf.io.exceptions.IoExceptionMessageConstant;
 import com.itextpdf.io.font.constants.FontStretches;
@@ -124,25 +125,34 @@ static class PostTable {
     }
 
     static class CmapTable {
+        /**
+         * Collection of the pairs representing Platform ID and Encoding ID of the “cmap” subtables
+         * present in the font program.
+         */
+        List<Tuple2<Integer, Integer>> cmapEncodings = new ArrayList<>();
         /**
          * The map containing the code information for the table 'cmap', encoding 1.0.
          * The key is the code and the value is an {@code int[2]} where position 0
          * is the glyph number and position 1 is the glyph width normalized to 1000 units.
+         *
          * @see TrueTypeFont#UNITS_NORMALIZATION
          */
         Map<Integer, int[]> cmap10;
         /**
          * The map containing the code information for the table 'cmap', encoding 3.1 in Unicode.
          * The key is the code and the value is an {@code int[2]} where position 0
          * is the glyph number and position 1 is the glyph width normalized to 1000 units.
+         *
          * @see TrueTypeFont#UNITS_NORMALIZATION
          */
         Map<Integer, int[]> cmap31;
         Map<Integer, int[]> cmapExt;
         boolean fontSpecific = false;
     }
 
-    /** The file name. */
+    /**
+     * The file name.
+     */
     protected String fileName;
     /**
      * The file in use.
@@ -418,7 +428,8 @@ private void initializeSfntTables() throws java.io.IOException {
 
     /**
      * Reads the font data.
-     * @param all if true, all tables will be read, otherwise only 'head', 'name', and 'os/2'.
+     *
+     * @param all if {@code true}, all tables will be read, otherwise only 'head', 'name', and 'os/2'
      */
     protected void loadTables(boolean all) throws java.io.IOException {
         readNameTable();
@@ -537,8 +548,9 @@ protected IntHashtable readKerning(int unitsPerEm) throws java.io.IOException {
      * Read the glyf bboxes from 'glyf' table.
      *
      * @param unitsPerEm {@link HeaderTable#unitsPerEm}
+     *
      * @throws IOException the font is invalid
-     * @throws java.io.IOException  the font file could not be read
+     * @throws java.io.IOException the font file could not be read
      */
     protected int[][] readBbox(int unitsPerEm) throws java.io.IOException {
         int tableLocation[];
@@ -586,7 +598,7 @@ protected int[][] readBbox(int unitsPerEm) throws java.io.IOException {
             int start = locaTable[glyph];
             if (start != locaTable[glyph + 1]) {
                 raf.seek(tableGlyphOffset + start + 2);
-                bboxes[glyph] = new int[] {
+                bboxes[glyph] = new int[]{
                         FontProgram.convertGlyphSpaceToTextSpace(raf.readShort()) / unitsPerEm,
                         FontProgram.convertGlyphSpaceToTextSpace(raf.readShort()) / unitsPerEm,
                         FontProgram.convertGlyphSpaceToTextSpace(raf.readShort()) / unitsPerEm,
@@ -611,7 +623,7 @@ protected int readNumGlyphs() throws java.io.IOException {
      * Extracts the names of the font in all the languages available.
      *
      * @throws IOException on error
-     * @throws java.io.IOException  on error
+     * @throws java.io.IOException on error
      */
     private void readNameTable() throws java.io.IOException {
         int[] table_location = tables.get("name");
@@ -661,7 +673,7 @@ private void readNameTable() throws java.io.IOException {
      * Read horizontal header, table 'hhea'.
      *
      * @throws IOException the font is invalid.
-     * @throws java.io.IOException  the font file could not be read.
+     * @throws java.io.IOException the font file could not be read.
      */
     private void readHheaTable() throws java.io.IOException {
         int[] table_location = tables.get("hhea");
@@ -691,7 +703,7 @@ private void readHheaTable() throws java.io.IOException {
      * Read font header, table 'head'.
      *
      * @throws IOException the font is invalid.
-     * @throws java.io.IOException  the font file could not be read.
+     * @throws java.io.IOException the font file could not be read.
      */
     private void readHeadTable() throws java.io.IOException {
         int[] table_location = tables.get("head");
@@ -719,7 +731,7 @@ private void readHeadTable() throws java.io.IOException {
      * Depends on {@link HeaderTable#unitsPerEm} property.
      *
      * @throws IOException the font is invalid.
-     * @throws java.io.IOException  the font file could not be read.
+     * @throws java.io.IOException the font file could not be read.
      */
     private void readOs_2Table() throws java.io.IOException {
         int[] table_location = tables.get("OS/2");
@@ -825,6 +837,7 @@ private void readCmapTable() throws java.io.IOException {
         for (int k = 0; k < num_tables; ++k) {
             int platId = raf.readUnsignedShort();
             int platSpecId = raf.readUnsignedShort();
+            cmaps.cmapEncodings.add(new Tuple2<>(platId, platSpecId));
             int offset = raf.readInt();
             if (platId == 3 && platSpecId == 0) {
                 cmaps.fontSpecific = true;

io/src/main/java/com/itextpdf/io/font/TrueTypeFont.java

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.io.font;
 
+import com.itextpdf.commons.datastructures.Tuple2;
 import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.io.exceptions.IOException;
 import com.itextpdf.io.exceptions.IoExceptionMessageConstant;
@@ -32,6 +33,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.font.otf.OpenTypeGdefTableReader;
 import com.itextpdf.io.logs.IoLogMessageConstant;
 import com.itextpdf.io.util.IntHashtable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
@@ -41,13 +44,11 @@ This file is part of the iText (R) project.
 import java.util.Set;
 import java.util.SortedSet;
 import java.util.stream.Collectors;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class TrueTypeFont extends FontProgram {
 
 
-	private OpenTypeParser fontParser;
+    private OpenTypeParser fontParser;
 
     protected int[][] bBoxes;
 
@@ -104,6 +105,7 @@ public boolean hasKernPairs() {
      *
      * @param first the first glyph
      * @param second the second glyph
+     *
      * @return the kerning to be applied
      */
     @Override
@@ -218,6 +220,37 @@ public Set<Integer> mapGlyphsCidsToGids(Set<Integer> glyphs) {
                 .collect(Collectors.toSet());
     }
 
+    /**
+     * Checks whether current {@link TrueTypeFont} program contains the “cmap” subtable
+     * with provided platform ID and encoding ID.
+     *
+     * @param platformID platform ID
+     * @param encodingID encoding ID
+     *
+     * @return {@code true} if “cmap” subtable with provided platform ID and encoding ID is present in the font program,
+     * {@code false} otherwise
+     */
+    public boolean isCmapPresent(int platformID, int encodingID) {
+        OpenTypeParser.CmapTable cmaps = fontParser.getCmapTable();
+        if (cmaps == null) {
+            return false;
+        }
+        return cmaps.cmapEncodings.contains(new Tuple2<>(platformID, encodingID));
+    }
+
+    /**
+     * Gets the number of the “cmap” subtables for the current {@link TrueTypeFont} program.
+     *
+     * @return the number of the “cmap” subtables
+     */
+    public int getNumberOfCmaps() {
+        OpenTypeParser.CmapTable cmaps = fontParser.getCmapTable();
+        if (cmaps == null) {
+            return 0;
+        }
+        return cmaps.cmapEncodings.size();
+    }
+
     protected void readGdefTable() throws java.io.IOException {
         int[] gdef = fontParser.tables.get("GDEF");
         if (gdef != null) {
@@ -238,7 +271,8 @@ protected void readGsubTable() throws java.io.IOException {
     protected void readGposTable() throws java.io.IOException {
         int[] gpos = fontParser.tables.get("GPOS");
         if (gpos != null) {
-            gposTable = new GlyphPositioningTableReader(fontParser.raf, gpos[0], gdefTable, codeToGlyph,  fontMetrics.getUnitsPerEm());
+            gposTable = new GlyphPositioningTableReader(fontParser.raf, gpos[0], gdefTable, codeToGlyph,
+                    fontMetrics.getUnitsPerEm());
         }
     }
 
@@ -408,9 +442,9 @@ public void updateUsedGlyphs(SortedSet<Integer> usedGlyphs, boolean subset, List
         if (subsetRanges != null) {
             compactRange = toCompactRange(subsetRanges);
         } else if (!subset) {
-            compactRange = new int[] {0, 0xFFFF};
+            compactRange = new int[]{0, 0xFFFF};
         } else {
-            compactRange = new int[] {};
+            compactRange = new int[]{};
         }
 
         for (int k = 0; k < compactRange.length; k += 2) {
@@ -427,9 +461,11 @@ public void updateUsedGlyphs(SortedSet<Integer> usedGlyphs, boolean subset, List
     /**
      * Normalizes given ranges by making sure that first values in pairs are lower than second values and merges overlapping
      * ranges in one.
+     *
      * @param ranges a {@link List} of integer arrays, which are constituted by pairs of ints that denote
-     *               each range limits. Each integer array size shall be a multiple of two.
-     * @return single merged array consisting of pairs of integers, each of them denoting a range.
+     *               each range limits. Each integer array size shall be a multiple of two
+     *
+     * @return single merged array consisting of pairs of integers, each of them denoting a range
      */
     private static int[] toCompactRange(List<int[]> ranges) {
         List<int[]> simp = new ArrayList<>();

io/src/test/java/com/itextpdf/io/font/TrueTypeFontTest.java

@@ -117,6 +117,14 @@ public void checkSxHeightTtfTest() throws IOException {
         Assertions.assertEquals(536, xHeight);
     }
 
+    @Test
+    public void containsCmapTest() throws IOException {
+        TrueTypeFont fontProgram = (TrueTypeFont) FontProgramFactory.createFont(SOURCE_FOLDER + "glyphs-fmt-6.ttf");
+        Assertions.assertEquals(1, fontProgram.getNumberOfCmaps());
+        Assertions.assertTrue(fontProgram.isCmapPresent(0, 3));
+        Assertions.assertFalse(fontProgram.isCmapPresent(1, 0));
+    }
+
     private void checkCmapTableEntry(FontProgram fontProgram, char uniChar, int expectedGlyphId) {
 
         Glyph glyph = fontProgram.getGlyph(uniChar);

pdfa/src/main/java/com/itextpdf/pdfa/checker/PdfA1Checker.java

@@ -384,7 +384,7 @@ protected void checkContentStream(PdfStream contentStream) {
     @Override
     protected void checkNonSymbolicTrueTypeFont(PdfTrueTypeFont trueTypeFont) {
         String encoding = trueTypeFont.getFontEncoding().getBaseEncoding();
-        // non-symbolic true type font will always has an encoding entry in font dictionary in itext
+        // non-symbolic true type font will always have an encoding entry in font dictionary in itext
         if (!PdfEncodings.WINANSI.equals(encoding) && !PdfEncodings.MACROMAN.equals(encoding) || trueTypeFont.getFontEncoding().hasDifferences()) {
             throw new PdfAConformanceException(PdfaExceptionMessageConstant.ALL_NON_SYMBOLIC_TRUE_TYPE_FONT_SHALL_SPECIFY_MAC_ROMAN_OR_WIN_ANSI_ENCODING_AS_THE_ENCODING_ENTRY, trueTypeFont);
         }

pdfa/src/main/java/com/itextpdf/pdfa/checker/PdfA2Checker.java

@@ -422,7 +422,7 @@ protected void checkNumberOfDeviceNComponents(PdfSpecialCs.DeviceN deviceN) {
     @Override
     protected void checkNonSymbolicTrueTypeFont(PdfTrueTypeFont trueTypeFont) {
         String encoding = trueTypeFont.getFontEncoding().getBaseEncoding();
-        // non-symbolic true type font will always has an encoding entry in font dictionary in itext
+        // non-symbolic true type font will always have an encoding entry in font dictionary in itext
         if (!PdfEncodings.WINANSI.equals(encoding) && !PdfEncodings.MACROMAN.equals(encoding)) {
             throw new PdfAConformanceException(PdfaExceptionMessageConstant.ALL_NON_SYMBOLIC_TRUE_TYPE_FONT_SHALL_SPECIFY_MAC_ROMAN_ENCODING_OR_WIN_ANSI_ENCODING, trueTypeFont);
         }