Set typo ascender/descender for type3 fonts based on font dictionary

Refactor type 3 fonts glyph space normalization.

DEVSIX-5199

Author: yulian-gaponenko

forms/src/test/resources/com/itextpdf/forms/PdfFormFieldMultilineTextTest/cmp_multilineFormFieldNewLineFontType3Test.pdf

@@ -118,14 +118,39 @@ public int[] getGlyphWidths() {
         return glyphWidths;
     }
 
+    /**
+     * Gets typo (a.k.a. sTypo or OS/2) vertical metric corresponding to ascender.
+     *
+     * <p>
+     * Typo vertical metrics are the primary source for iText ascender/descender calculations.
+     *
+     * @return typo ascender value in normalized 1000-units
+     */
     public int getTypoAscender() {
         return typoAscender;
     }
 
+    /**
+     * Gets typo (a.k.a. sTypo or OS/2) vertical metric corresponding to descender.
+     *
+     * <p>
+     * Typo vertical metrics are the primary source for iText ascender/descender calculations.
+     *
+     * @return typo descender value in normalized 1000-units
+     */
     public int getTypoDescender() {
         return typoDescender;
     }
 
+    /**
+     * Gets the capital letters height.
+     *
+     * <p>
+     * This property defines the vertical coordinate of the top of flat capital letters,
+     * measured from the baseline.
+     *
+     * @return cap height in 1000-units
+     */
     public int getCapHeight() {
         return capHeight;
     }
@@ -237,14 +262,39 @@ protected void setGlyphWidths(int[] glyphWidths) {
         this.glyphWidths = glyphWidths;
     }
 
+    /**
+     * Sets typo (a.k.a. sTypo or OS/2) vertical metric corresponding to ascender.
+     *
+     * <p>
+     * Typo vertical metrics are the primary source for iText ascender/descender calculations.
+     *
+     * @param typoAscender typo ascender value in normalized 1000-units
+     */
     protected void setTypoAscender(int typoAscender) {
         this.typoAscender = (int) (typoAscender * normalizationCoef);
     }
 
-    protected void setTypoDescender(int typoDesctender) {
-        this.typoDescender = (int) (typoDesctender * normalizationCoef);
-    }
-
+    /**
+     * Sets typo (a.k.a. sTypo or OS/2) vertical metric corresponding to descender.
+     *
+     * <p>
+     * Typo vertical metrics are the primary source for iText ascender/descender calculations.
+     *
+     * @param typoDescender typo descender value in normalized 1000-units
+     */
+    protected void setTypoDescender(int typoDescender) {
+        this.typoDescender = (int) (typoDescender * normalizationCoef);
+    }
+
+    /**
+     * Sets the capital letters height.
+     *
+     * <p>
+     * This property defines the vertical coordinate of the top of flat capital letters,
+     * measured from the baseline.
+     *
+     * @param capHeight cap height in 1000-units
+     */
     protected void setCapHeight(int capHeight) {
         this.capHeight = (int) (capHeight * normalizationCoef);
     }

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

@@ -200,14 +200,29 @@ static String trimFontStyle(String name) {
         }
     }
 
+    /**
+     * Sets typo ascender. See also {@link FontMetrics#setTypoAscender(int)}.
+     *
+     * @param ascender typo ascender value in 1000-units
+     */
     protected void setTypoAscender(int ascender) {
         fontMetrics.setTypoAscender(ascender);
     }
 
+    /**
+     * Sets typo descender. See also {@link FontMetrics#setTypoDescender(int)}.
+     *
+     * @param descender typo descender value in 1000-units
+     */
     protected void setTypoDescender(int descender) {
         fontMetrics.setTypoDescender(descender);
     }
 
+    /**
+     * Sets the capital letters height. See also {@link FontMetrics#setCapHeight(int)}.
+     *
+     * @param capHeight cap height in 1000-units
+     */
     protected void setCapHeight(int capHeight) {
         fontMetrics.setCapHeight(capHeight);
     }
@@ -217,7 +232,8 @@ protected void setXHeight(int xHeight) {
     }
 
     /**
-     * Sets the PostScript italic angel.
+     * Sets the PostScript italic angle.
+     *
      * <p>
      * Italic angle in counter-clockwise degrees from the vertical. Zero for upright text, negative for text that leans to the right (forward).
      *

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

@@ -58,6 +58,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfObject;
 import com.itextpdf.kernel.pdf.PdfStream;
 
+import java.util.Arrays;
 import java.util.HashMap;
 
 import org.slf4j.Logger;
@@ -127,9 +128,7 @@ static String createRandomFontName() {
 
     static int[] convertSimpleWidthsArray(PdfArray widthsArray, int first, int missingWidth) {
         int[] res = new int[256];
-        for (int i = 0; i < res.length; i++) {
-            res[i] = missingWidth;
-        }
+        Arrays.fill(res, missingWidth);
         if (widthsArray == null) {
             Logger logger = LoggerFactory.getLogger(FontUtil.class);
             logger.warn(LogMessageConstant.FONT_DICTIONARY_WITH_NO_WIDTHS);

kernel/src/main/java/com/itextpdf/kernel/font/FontUtil.java

@@ -77,6 +77,8 @@ public abstract class PdfFont extends PdfObjectWrapper<PdfDictionary> {
     protected FontProgram fontProgram;
 
     protected static final byte[] EMPTY_BYTES = new byte[0];
+
+    @Deprecated
     protected static final double[] DEFAULT_FONT_MATRIX = {0.001, 0, 0, 0.001, 0, 0};
 
     protected Map<Integer, Glyph> notdefGlyphs = new HashMap<>();
@@ -208,6 +210,7 @@ public boolean appendDecodedCodesToGlyphsList(List<Glyph> list, PdfString charac
 
     public abstract void writeText(String text, PdfOutputStream stream);
 
+    @Deprecated
     public double[] getFontMatrix() {
         return DEFAULT_FONT_MATRIX;
     }

kernel/src/main/java/com/itextpdf/kernel/font/PdfFont.java

@@ -439,17 +439,7 @@ protected void flushFontData(String fontName, PdfName subtype) {
         if (isForceWidthsOutput() || !isBuiltInFont() || fontEncoding.hasDifferences()) {
             getPdfObject().put(PdfName.FirstChar, new PdfNumber(firstChar));
             getPdfObject().put(PdfName.LastChar, new PdfNumber(lastChar));
-            PdfArray wd = new PdfArray();
-            for (int k = firstChar; k <= lastChar; ++k) {
-                if (shortTag[k] == 0) {
-                    wd.add(new PdfNumber(0));
-                } else {
-                    //prevent lost of widths info
-                    int uni = fontEncoding.getUnicode(k);
-                    Glyph glyph = uni > -1 ? getGlyph(uni) : fontProgram.getGlyphByCode(k);
-                    wd.add(new PdfNumber(getGlyphWidth(glyph)));
-                }
-            }
+            PdfArray wd = buildWidthsArray(firstChar, lastChar);
             getPdfObject().put(PdfName.Widths, wd);
         }
         PdfDictionary fontDescriptor = !isBuiltInFont() ? getFontDescriptor(fontName) : null;
@@ -514,12 +504,27 @@ protected PdfDictionary getFontDescriptor(String fontName) {
         return fontDescriptor;
     }
 
+    protected PdfArray buildWidthsArray(int firstChar, int lastChar) {
+        PdfArray wd = new PdfArray();
+        for (int k = firstChar; k <= lastChar; ++k) {
+            if (shortTag[k] == 0) {
+                wd.add(new PdfNumber(0));
+            } else {
+                int uni = fontEncoding.getUnicode(k);
+                Glyph glyph = uni > -1 ? getGlyph(uni) : fontProgram.getGlyphByCode(k);
+                wd.add(new PdfNumber(glyph != null ? glyph.getWidth() : 0));
+            }
+        }
+        return wd;
+    }
+
     protected abstract void addFontStream(PdfDictionary fontDescriptor);
 
     protected void setFontProgram(T fontProgram) {
         this.fontProgram = fontProgram;
     }
 
+    @Deprecated
     protected double getGlyphWidth(Glyph glyph) {
         return glyph != null ? glyph.getWidth() : 0;
     }