OTF: Support GposLookupType7 format (subtable format 2)

DEVSIX-4631

Autoported commit.
Original commit hash: [c62f83b89]

Author: Snipx

itext.tests/itext.io.tests/itext/io/font/otf/GposLookupType7Test.cs

@@ -0,0 +1,64 @@
+/*
+This file is part of the iText (R) project.
+Copyright (c) 1998-2020 iText Group NV
+Authors: iText Software.
+
+This program is offered under a commercial and under the AGPL license.
+For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+AGPL licensing:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+using System;
+using System.Collections.Generic;
+using iText.IO.Font;
+using iText.IO.Util;
+using iText.Test;
+
+namespace iText.IO.Font.Otf {
+    public class GposLookupType7Test : ExtendedITextTest {
+        private static readonly String RESOURCE_FOLDER = iText.Test.TestUtil.GetParentProjectDirectory(NUnit.Framework.TestContext
+            .CurrentContext.TestDirectory) + "/resources/itext/io/font/otf/GposLookupType7Test/";
+
+        [NUnit.Framework.Test]
+        public virtual void VerifyXAdvanceIsAppliedForContextualPositioning() {
+            TrueTypeFont fontProgram = (TrueTypeFont)FontProgramFactory.CreateFont(RESOURCE_FOLDER + "NotoSansMyanmar-Regular.ttf"
+                );
+            GlyphPositioningTableReader gposTableReader = fontProgram.GetGposTable();
+            GposLookupType7 lookup = (GposLookupType7)gposTableReader.GetLookupTable(28);
+            IList<Glyph> glyphs = JavaUtil.ArraysAsList(fontProgram.GetGlyphByCode(25), fontProgram.GetGlyphByCode(174
+                ), fontProgram.GetGlyphByCode(5), fontProgram.GetGlyphByCode(411));
+            GlyphLine gl = new GlyphLine(glyphs);
+            NUnit.Framework.Assert.AreEqual(0, gl.Get(1).GetXAdvance());
+            NUnit.Framework.Assert.IsTrue(lookup.TransformLine(gl));
+            NUnit.Framework.Assert.AreEqual(219, gl.Get(1).GetXAdvance());
+        }
+
+        [NUnit.Framework.Test]
+        public virtual void VerifyXAdvanceIsNotAppliedForUnsatisfiedContextualPositioning() {
+            TrueTypeFont fontProgram = (TrueTypeFont)FontProgramFactory.CreateFont(RESOURCE_FOLDER + "NotoSansMyanmar-Regular.ttf"
+                );
+            GlyphPositioningTableReader gposTableReader = fontProgram.GetGposTable();
+            GposLookupType7 lookup = (GposLookupType7)gposTableReader.GetLookupTable(28);
+            IList<Glyph> glyphs = JavaUtil.ArraysAsList(fontProgram.GetGlyphByCode(1), fontProgram.GetGlyphByCode(174)
+                , fontProgram.GetGlyphByCode(5), fontProgram.GetGlyphByCode(411));
+            GlyphLine gl = new GlyphLine(glyphs);
+            NUnit.Framework.Assert.IsFalse(lookup.TransformLine(gl));
+            for (int i = 0; i < gl.Size(); i++) {
+                NUnit.Framework.Assert.AreEqual(0, gl.Get(i).GetXAdvance());
+                NUnit.Framework.Assert.AreEqual(0, gl.Get(i).GetYAdvance());
+            }
+        }
+    }
+}

itext.tests/itext.io.tests/resources/itext/io/font/otf/GposLookupType7Test/LICENSE_OFL.txt

@@ -0,0 +1,92 @@
+This Font Software is licensed under the SIL Open Font License,
+Version 1.1.
+
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font
+creation efforts of academic and linguistic communities, and to
+provide a free and open framework in which fonts may be shared and
+improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply to
+any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software
+components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to,
+deleting, or substituting -- in part or in whole -- any of the
+components of the Original Version, by changing formats or by porting
+the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed,
+modify, redistribute, and sell modified and unmodified copies of the
+Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in
+Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the
+corresponding Copyright Holder. This restriction only applies to the
+primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created using
+the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

itext.tests/itext.io.tests/resources/itext/io/font/otf/GposLookupType7Test/NOTICE.txt

@@ -0,0 +1,2 @@
+This software uses the following test resources under the following licenses:
+| NotoSansMyanmar-Regular.ttf | OFL-1.1 | LICENSE-OFL.txt |

itext.tests/itext.io.tests/resources/itext/io/font/otf/GposLookupType7Test/NotoSansMyanmar-Regular.ttf

@@ -160,6 +160,8 @@ public const String ENCRYPTED_PAYLOAD_FILE_SPEC_SHALL_HAVE_AFRELATIONSHIP_FILED_
 
         public const String FORM_FIELD_WAS_FLUSHED = "A form field was flushed. There's no way to create this field in the AcroForm dictionary.";
 
+        public const String GPOS_LOOKUP_SUBTABLE_FORMAT_NOT_SUPPORTED = "Subtable format {0} of GPOS Lookup Type {1} is not supported yet";
+
         public const 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 const 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";

itext/itext.io/itext/io/LogMessageConstant.cs

@@ -0,0 +1,36 @@
+/*
+This file is part of the iText (R) project.
+Copyright (c) 1998-2020 iText Group NV
+Authors: iText Software.
+
+This program is offered under a commercial and under the AGPL license.
+For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+AGPL licensing:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+namespace iText.IO.Font.Otf {
+    public abstract class ContextualPositionRule : ContextualRule {
+        /// <summary>Retrieves the position lookup records.</summary>
+        /// <remarks>
+        /// Retrieves the position lookup records. Each record specifies a position in the context glyph
+        /// sequence and a LookupListIndex to the position lookup that is applied at that position.
+        /// </remarks>
+        /// <returns>
+        /// an array of
+        /// <see cref="PosLookupRecord"/>.
+        /// </returns>
+        public abstract PosLookupRecord[] GetPosLookupRecords();
+    }
+}

itext/itext.io/itext/io/font/otf/ContextualPositionRule.cs

@@ -0,0 +1,29 @@
+/*
+This file is part of the iText (R) project.
+Copyright (c) 1998-2020 iText Group NV
+Authors: iText Software.
+
+This program is offered under a commercial and under the AGPL license.
+For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+AGPL licensing:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+namespace iText.IO.Font.Otf {
+    public abstract class ContextualPositionTable : ContextualTable<ContextualPositionRule> {
+        protected internal ContextualPositionTable(OpenTypeFontTableReader openReader, int lookupFlag)
+            : base(openReader, lookupFlag) {
+        }
+    }
+}

itext/itext.io/itext/io/font/otf/ContextualPositionTable.cs

@@ -0,0 +1,90 @@
+/*
+This file is part of the iText (R) project.
+Copyright (c) 1998-2020 iText Group NV
+Authors: iText Software.
+
+This program is offered under a commercial and under the AGPL license.
+For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+AGPL licensing:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+namespace iText.IO.Font.Otf {
+    public abstract class ContextualRule {
+        /// <summary>Gets the length of the context glyph sequence defined by this rule</summary>
+        /// <returns>length of the context</returns>
+        public abstract int GetContextLength();
+
+        /// <summary>Checks if glyph line element matches element from input sequence of the rule.</summary>
+        /// <remarks>
+        /// Checks if glyph line element matches element from input sequence of the rule.
+        /// <br /><br />
+        /// NOTE: rules do not contain the first element of the input sequence, the first element is defined by rule
+        /// position in substitution table. Therefore atIdx shall not be 0.
+        /// </remarks>
+        /// <param name="glyphId">glyph code id</param>
+        /// <param name="atIdx">
+        /// index in the rule sequence. Shall be: 0 &lt; atIdx &lt;
+        /// <see cref="GetContextLength()"/>
+        /// </param>
+        /// <returns>
+        /// 
+        /// <see langword="true"/>
+        /// if glyph matches element
+        /// </returns>
+        public abstract bool IsGlyphMatchesInput(int glyphId, int atIdx);
+
+        /// <summary>Gets the length of the lookahead context glyph sequence defined by this rule</summary>
+        /// <returns>length of the lookahead context</returns>
+        public virtual int GetLookaheadContextLength() {
+            return 0;
+        }
+
+        /// <summary>Gets the length of the backtrack context glyph sequence defined by this rule</summary>
+        /// <returns>length of the backtrack context</returns>
+        public virtual int GetBacktrackContextLength() {
+            return 0;
+        }
+
+        /// <summary>Checks if glyph line element matches element from lookahead sequence of the rule.</summary>
+        /// <param name="glyphId">glyph code id</param>
+        /// <param name="atIdx">
+        /// index in rule sequence. Shall be: 0 &lt;= atIdx &lt;
+        /// <see cref="GetLookaheadContextLength()"/>
+        /// </param>
+        /// <returns>
+        /// 
+        /// <see langword="true"/>
+        /// if glyph matches element from lookahead sequence
+        /// </returns>
+        public virtual bool IsGlyphMatchesLookahead(int glyphId, int atIdx) {
+            return false;
+        }
+
+        /// <summary>Checks if glyph line element matches element from backtrack sequence of the rule.</summary>
+        /// <param name="glyphId">glyph code id</param>
+        /// <param name="atIdx">
+        /// index in rule sequence. Shall be: 0 &lt;= atIdx &lt;
+        /// <see cref="GetBacktrackContextLength()"/>
+        /// </param>
+        /// <returns>
+        /// 
+        /// <see langword="true"/>
+        /// if glyph matches element from backtrack sequence
+        /// </returns>
+        public virtual bool IsGlyphMatchesBacktrack(int glyphId, int atIdx) {
+            return false;
+        }
+    }
+}