Introduce TYPOGRAPHY_CONFIG property

Also introduce EnumUtil#throwIfNull for unwrapping enums from nullable in .net;
introduce methods for surrogate pairs creation in TextUtil.

DEVSIX-1813

Author: yulian-gaponenko

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

@@ -71,13 +71,13 @@ public final class LogMessageConstant {
     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.";
     public static final String DESTINATION_NOT_PERMITTED_WHEN_ACTION_IS_SET = "Destinations are not permitted for link annotations that already have actions. The old action will be removed.";
-    public static final String EMBEDDED_GO_TO_DESTINATION_NOT_SPECIFIED = "No destination in the target was specified for action. Destination entry is mandatory for embedded go-to actions.";
     public static final String DIRECTONLY_OBJECT_CANNOT_BE_INDIRECT = "DirectOnly object cannot be indirect";
     public static final String DOCFONT_HAS_ILLEGAL_DIFFERENCES = "Document Font has illegal differences array. Entry {0} references a glyph ID over 255 and will be ignored.";
     public static final String DOCUMENT_ALREADY_HAS_FIELD = "The document already has field {0}. Annotations of the fields with this name will be added to the existing one as children. If you want to have separate fields, please, rename them manually before copying.";
     public static final String DOCUMENT_SERIALIZATION_EXCEPTION_RAISED = "Unhandled exception while serialization";
     public static final String ELEMENT_DOES_NOT_FIT_AREA = "Element does not fit current area. {0}";
     public static final String ELEMENT_WAS_FORCE_PLACED_KEEP_WITH_NEXT_WILL_BE_IGNORED = "Element was placed in a forced way. Keep with next property will be ignored";
+    public static final String EMBEDDED_GO_TO_DESTINATION_NOT_SPECIFIED = "No destination in the target was specified for action. Destination entry is mandatory for embedded go-to actions.";
     public static final String ENCOUNTERED_INVALID_MCR = "Corrupted tag structure: encountered invalid marked content reference - it doesn't refer to any page or any mcid. This content reference will be ignored.";
     public static final String ENCRYPTED_PAYLOAD_FILE_SPEC_SHALL_HAVE_AFRELATIONSHIP_FILED_EQUAL_TO_ENCRYPTED_PAYLOAD = "Encrypted payload file spec shall have 'AFRelationship' filed equal to 'EncryptedPayload'";
     public static final String ENCRYPTION_ENTRIES_P_AND_ENCRYPT_METADATA_NOT_CORRESPOND_PERMS_ENTRY = "Encryption dictionary entries P and EncryptMetadata have value that does not correspond to encrypted values in Perms key.";
@@ -97,12 +97,12 @@ public final class LogMessageConstant {
     public static final String GRAPHICS_STATE_WAS_DELETED = "Graphics state is always deleted after event dispatching. If you want to preserve it in renderer info, use preserveGraphicsState method after receiving renderer info.";
     public static final String IF_PATH_IS_SET_VERTICES_SHALL_NOT_BE_PRESENT = "If Path key is set, Vertices key shall not be present. Remove Vertices key before setting Path";
     public static final String IMAGE_HAS_AMBIGUOUS_SCALE = "The image cannot be auto scaled and scaled by a certain parameter simultaneously";
-    public static final String IMAGE_HAS_JBIG2DECODE_FILTER = "Image cannot be inline if it has JBIG2Decode filter. It will be added as an ImageXObject";
-    public static final String IMAGE_HAS_JPXDECODE_FILTER = "Image cannot be inline if it has JPXDecode filter. It will be added as an ImageXObject";
-    public static final String IMAGE_HAS_ICC_PROFILE_WITH_INCOMPATIBLE_NUMBER_OF_COLOR_COMPONENTS_COMPARED_TO_COLOR_SPACE = "Image has icc profile with incompatible number of color components compared to image color space. The icc profile will be ignored.";
     public static final String IMAGE_HAS_ICC_PROFILE_WITH_INCOMPATIBLE_NUMBER_OF_COLOR_COMPONENTS_COMPARED_TO_BASE_COLOR_SPACE_IN_INDEXED_COLOR_SPACE = "Image has icc profile with incompatible number of color components compared to base color space in image indexed color space. The icc profile will be ignored.";
+    public static final String IMAGE_HAS_ICC_PROFILE_WITH_INCOMPATIBLE_NUMBER_OF_COLOR_COMPONENTS_COMPARED_TO_COLOR_SPACE = "Image has icc profile with incompatible number of color components compared to image color space. The icc profile will be ignored.";
     public static final String IMAGE_HAS_INCORRECT_OR_UNSUPPORTED_BASE_COLOR_SPACE_IN_INDEXED_COLOR_SPACE_OVERRIDDEN_BY_ICC_PROFILE = "Image has incorrect or unsupported base color space in indexed color space, it will be overridden by one based on embedded icc profile.";
     public static final String IMAGE_HAS_INCORRECT_OR_UNSUPPORTED_COLOR_SPACE_OVERRIDDEN_BY_ICC_PROFILE = "Image has incorrect or unsupported color space, that will be overridden by one based on embedded icc profile.";
+    public static final String IMAGE_HAS_JBIG2DECODE_FILTER = "Image cannot be inline if it has JBIG2Decode filter. It will be added as an ImageXObject";
+    public static final String IMAGE_HAS_JPXDECODE_FILTER = "Image cannot be inline if it has JPXDecode filter. It will be added as an ImageXObject";
     public static final String IMAGE_HAS_MASK = "Image cannot be inline if it has a Mask";
     public static final String IMAGE_SIZE_CANNOT_BE_MORE_4KB = "Inline image size cannot be more than 4KB. It will be added as an ImageXObject";
     public static final String INCORRECT_PAGEROTATION = "Encounterd a page rotation that was not a multiple of 90°/ (Pi/2) when generating default appearances for form fields";
@@ -145,15 +145,16 @@ public final class LogMessageConstant {
     public static final String SOME_TARGET_FIELDS_ARE_NOT_SET_OR_INCORRECT = "Some fields in target dictionary are not set or incorrect. Null will be returned.";
     public static final String SOURCE_DOCUMENT_HAS_ACROFORM_DICTIONARY = "Source document has AcroForm dictionary. The pages you are going to copy may have FormFields, but they will not be copied, because you have not used any IPdfPageExtraCopier";
     public static final String START_MARKER_MISSING_IN_PFB_FILE = "Start marker is missing in the pfb file";
+    public static final String STDSCRIPTCONFIG_DESIGNED_ONLY_FOR_STD_SCRIPTS = "StandardScriptConfig class is designed for only standard scripts, otherwise it might be incompatible.";
     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 TOUNICODE_CMAP_MORE_THAN_2_BYTES_NOT_SUPPORTED = "ToUnicode CMap more than 2 bytes not supported.";
     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.";
     public static final String TYPE3_FONT_ISSUE_TAGGED_PDF = "Type 3 font issue. Font Descriptor is required for tagged PDF. FontName shall be specified.";
-    public static final String TOUNICODE_CMAP_MORE_THAN_2_BYTES_NOT_SUPPORTED = "ToUnicode CMap more than 2 bytes not supported.";
     public static final String UNABLE_TO_REGISTER_EVENT_DATA_HANDLER_SHUTDOWN_HOOK = "Unable to register event data handler shutdown hook because of security reasons.";
     public static final String UNABLE_TO_SEARCH_FOR_EVENT_CONTEXT = "It is impossible to retrieve event context because of the security reasons. Event counting may behave in unexpected way";
     public static final String UNEXPECTED_BEHAVIOUR_DURING_TABLE_ROW_COLLAPSING = "Unexpected behaviour during table row collapsing. Calculated rowspan was less then 1.";

io/src/main/java/com/itextpdf/io/util/EnumUtil.java

@@ -0,0 +1,17 @@
+package com.itextpdf.io.util;
+
+/**
+ * This file is a helper class for internal usage only.
+ * Be aware that it's API and functionality may be changed in future.
+ */
+public final class EnumUtil {
+    private EnumUtil() {
+    }
+
+    public static <T extends Enum<T>> T throwIfNull(T enumInstance) {
+        if (enumInstance == null) {
+            throw new RuntimeException("Expected not null enum instance");
+        }
+        return enumInstance;
+    }
+}

io/src/main/java/com/itextpdf/io/util/TextUtil.java

@@ -81,6 +81,15 @@ public static boolean isSurrogateLow(char c) {
         return c >= '\udc00' && c <= '\udfff';
     }
 
+    public static char highSurrogate(int codePoint) {
+        return (char) ((codePoint >>> 10)
+                + ('\uD800' - (0x010000 >>> 10)));
+    }
+
+    public static char lowSurrogate(int codePoint) {
+        return (char) ((codePoint & 0x3ff) + '\uDC00');
+    }
+
     /**
      * Checks if two subsequent characters in a String are
      * are the higher and the lower character in a surrogate

layout/src/main/java/com/itextpdf/layout/property/Property.java

@@ -191,6 +191,7 @@ private Property() {
     public static final int TEXT_RISE = 72;
     public static final int TOP = 73;
     public static final int TRANSFORM = 53;
+    public static final int TYPOGRAPHY_CONFIG = 117;
     public static final int UNDERLINE = 74;
     public static final int VERTICAL_ALIGNMENT = 75;
     public static final int VERTICAL_BORDER_SPACING = 116;
@@ -207,7 +208,7 @@ private Property() {
      * related to textual operations. Indicates whether or not this type of property is inheritable.
      */
     private static final boolean[] INHERITED_PROPERTIES;
-    private static final int MAX_INHERITED_PROPERTY_ID = 108;
+    private static final int MAX_INHERITED_PROPERTY_ID = 117;
 
     static {
         INHERITED_PROPERTIES = new boolean[MAX_INHERITED_PROPERTY_ID + 1];
@@ -242,6 +243,7 @@ private Property() {
         INHERITED_PROPERTIES[Property.UNDERLINE] = true;
         INHERITED_PROPERTIES[Property.WORD_SPACING] = true;
         INHERITED_PROPERTIES[Property.TAGGING_HELPER] = true;
+        INHERITED_PROPERTIES[Property.TYPOGRAPHY_CONFIG] = true;
     }
 
     /**

layout/src/main/java/com/itextpdf/layout/renderer/TextRenderer.java

@@ -556,45 +556,55 @@ public LayoutResult layout(LayoutContext layoutContext) {
     public void applyOtf() {
         updateFontAndText();
         Character.UnicodeScript script = this.<Character.UnicodeScript>getProperty(Property.FONT_SCRIPT);
-        if (!otfFeaturesApplied) {
-            if (script == null && TypographyUtils.isTypographyModuleInitialized()) {
-                // Try to autodetect complex script.
-                Collection<Character.UnicodeScript> supportedScripts = TypographyUtils.getSupportedScripts();
-                Map<Character.UnicodeScript, Integer> scriptFrequency = new EnumMap<Character.UnicodeScript, Integer>(Character.UnicodeScript.class);
-                for (int i = text.start; i < text.end; i++) {
-                    int unicode = text.get(i).getUnicode();
-                    if (unicode > -1) {
-                        Character.UnicodeScript glyphScript = Character.UnicodeScript.of(unicode);
-                        if (scriptFrequency.containsKey(glyphScript)) {
-                            scriptFrequency.put(glyphScript, scriptFrequency.get(glyphScript) + 1);
-                        } else {
-                            scriptFrequency.put(glyphScript, 1);
+        if (!otfFeaturesApplied && TypographyUtils.isTypographyModuleInitialized() && text.start < text.end) {
+            if (hasOtfFont()) {
+                Object typographyConfig = this.<Object>getProperty(Property.TYPOGRAPHY_CONFIG);
+                if (script == null) {
+                    Collection<Character.UnicodeScript> supportedScripts = null;
+        	        if (typographyConfig != null) {
+    	                supportedScripts = TypographyUtils.getSupportedScripts(typographyConfig);
+	                }
+	                if (supportedScripts == null) {
+	                    supportedScripts = TypographyUtils.getSupportedScripts();
+	                }
+
+                    // Try to autodetect complex script.
+                    Map<Character.UnicodeScript, Integer> scriptFrequency = new EnumMap<Character.UnicodeScript, Integer>(Character.UnicodeScript.class);
+                    for (int i = text.start; i < text.end; i++) {
+                        int unicode = text.get(i).getUnicode();
+                        if (unicode > -1) {
+                            Character.UnicodeScript glyphScript = Character.UnicodeScript.of(unicode);
+                            if (scriptFrequency.containsKey(glyphScript)) {
+                                scriptFrequency.put(glyphScript, scriptFrequency.get(glyphScript) + 1);
+                            } else {
+                                scriptFrequency.put(glyphScript, 1);
+                            }
                         }
                     }
-                }
-                Integer max = 0;
-                Map.Entry<Character.UnicodeScript, Integer> selectedEntry = null;
-                for (Map.Entry<Character.UnicodeScript, Integer> entry : scriptFrequency.entrySet()) {
-                    Character.UnicodeScript entryScript = entry.getKey();
-                    if (entry.getValue() > max && !Character.UnicodeScript.COMMON.equals(entryScript) && !Character.UnicodeScript.UNKNOWN.equals(entryScript)
-                            && !Character.UnicodeScript.INHERITED.equals(entryScript)) {
-                        max = entry.getValue();
-                        selectedEntry = entry;
-                    }
-                }
-                if (selectedEntry != null) {
-                    Character.UnicodeScript selectScript = ((Map.Entry<Character.UnicodeScript, Integer>) selectedEntry).getKey();
-                    if ((selectScript == Character.UnicodeScript.ARABIC || selectScript == Character.UnicodeScript.HEBREW) && parent instanceof LineRenderer) {
-                        setProperty(Property.BASE_DIRECTION, BaseDirection.DEFAULT_BIDI);
+                    Integer max = 0;
+                    Map.Entry<Character.UnicodeScript, Integer> selectedEntry = null;
+                    for (Map.Entry<Character.UnicodeScript, Integer> entry : scriptFrequency.entrySet()) {
+                        Character.UnicodeScript entryScript = entry.getKey();
+                        if (entry.getValue() > max && !Character.UnicodeScript.COMMON.equals(entryScript) && !Character.UnicodeScript.UNKNOWN.equals(entryScript)
+                                && !Character.UnicodeScript.INHERITED.equals(entryScript)) {
+                            max = entry.getValue();
+                            selectedEntry = entry;
+                        }
                     }
-                    if (supportedScripts != null && supportedScripts.contains(selectScript)) {
-                        script = selectScript;
+                    if (selectedEntry != null) {
+                        Character.UnicodeScript selectScript = ((Map.Entry<Character.UnicodeScript, Integer>) selectedEntry).getKey();
+                        if ((selectScript == Character.UnicodeScript.ARABIC || selectScript == Character.UnicodeScript.HEBREW) && parent instanceof LineRenderer) {
+                            setProperty(Property.BASE_DIRECTION, BaseDirection.DEFAULT_BIDI);
+                        }
+                        if (supportedScripts != null && supportedScripts.contains(selectScript)) {
+                            script = selectScript;
+                        }
                     }
                 }
-            }
 
-            if (hasOtfFont() && script != null) {
-                TypographyUtils.applyOtfScript(font.getFontProgram(), text, script);
+                if (script != null) {
+                    TypographyUtils.applyOtfScript(font.getFontProgram(), text, script, typographyConfig);
+                }
             }
 
             FontKerning fontKerning = (FontKerning) this.<FontKerning>getProperty(Property.FONT_KERNING, FontKerning.NO);
@@ -1446,5 +1456,4 @@ public void remove() {
         }
 
     }
-
 }

layout/src/main/java/com/itextpdf/layout/renderer/TypographyUtils.java

@@ -111,24 +111,24 @@ final class TypographyUtils {
                 supportedScripts = (Collection<Character.UnicodeScript>) callMethod(TYPOGRAPHY_PACKAGE + SHAPER, GET_SUPPORTED_SCRIPTS, new Class[]{});
             } catch (Exception e) {
                 supportedScripts = null;
-                moduleFound = false;
-                cachedClasses.clear();
-                cachedMethods.clear();
-
                 logger.error(e.getMessage());
             }
         }
+        moduleFound = supportedScripts != null;
+        if (!moduleFound) {
+            cachedClasses.clear();
+            cachedMethods.clear();
+        }
         TYPOGRAPHY_MODULE_INITIALIZED = moduleFound;
         SUPPORTED_SCRIPTS = supportedScripts;
     }
 
-    static void applyOtfScript(FontProgram fontProgram, GlyphLine text, Character.UnicodeScript script) {
+    static void applyOtfScript(FontProgram fontProgram, GlyphLine text, Character.UnicodeScript script, Object typographyConfig) {
         if (!TYPOGRAPHY_MODULE_INITIALIZED) {
             logger.warn(typographyNotFoundException);
         } else {
-            callMethod(TYPOGRAPHY_PACKAGE + SHAPER, APPLY_OTF_SCRIPT, new Class[]{TrueTypeFont.class, GlyphLine.class, Character.UnicodeScript.class},
-                    fontProgram, text, script);
-//            Shaper.applyOtfScript((TrueTypeFont)fontProgram, text, script);
+            callMethod(TYPOGRAPHY_PACKAGE + SHAPER, APPLY_OTF_SCRIPT, new Class[]{TrueTypeFont.class, GlyphLine.class, Character.UnicodeScript.class, Object.class},
+                    fontProgram, text, script, typographyConfig);
         }
     }
 
@@ -238,6 +238,15 @@ static Collection<Character.UnicodeScript> getSupportedScripts() {
         }
     }
 
+    static Collection<Character.UnicodeScript> getSupportedScripts(Object typographyConfig) {
+        if (!TYPOGRAPHY_MODULE_INITIALIZED) {
+            logger.warn(typographyNotFoundException);
+            return null;
+        } else {
+            return (Collection<Character.UnicodeScript>) callMethod(TYPOGRAPHY_PACKAGE + SHAPER, GET_SUPPORTED_SCRIPTS, (Object) null, new Class[] {Object.class}, typographyConfig);
+        }
+    }
+
     static boolean isTypographyModuleInitialized() {
         return TYPOGRAPHY_MODULE_INITIALIZED;
     }
@@ -254,6 +263,8 @@ private static Object callMethod(String className, String methodName, Object tar
             logger.warn(MessageFormatUtil.format("Cannot find method {0} for class {1}", methodName, className));
         } catch (ClassNotFoundException e) {
             logger.warn(MessageFormatUtil.format("Cannot find class {0}", className));
+        } catch (IllegalArgumentException e) {
+            logger.warn(MessageFormatUtil.format("Illegal arguments passed to {0}#{1} method call: {2}", className, methodName, e.getMessage()));
         } catch (Exception e) {
             throw new RuntimeException(e.toString(), e);
         }