Keep enclosed subscripts on their text line

A smaller glyph whose baseline is shifted off the line, such as the "2" in
"CO2", overlaps the line too little to clear the line-overlap threshold and
ended up on a line of its own. When such an element partially overlaps the
line and sits horizontally within the run already collected, it is enclosed
by surrounding text and belongs to that line. A smaller element that merely
sits close but is not enclosed, like a subtitle beside a heading, keeps its
own line.

Author: splitbrain

src/Document/ContentStream/PositionedText/LineGroupingStrategy/TextOverlapStrategy.php

@@ -48,6 +48,8 @@ public function group(array $positionedTextElements): iterable {
 
             $positionedTextElementsOnLine = [$highestPositionedTextElement];
             $processedIndices[$i] = true;
+            $lineLeftX = $highestPositionedTextElement->absoluteMatrix->offsetX;
+            $lineRightX = $highestPositionedTextElement->absoluteMatrix->offsetX;
             for ($j = $i + 1; $j < $nrOfItems; $j++) {
                 if (isset($processedIndices[$j])) {
                     continue;
@@ -63,9 +65,22 @@ public function group(array $positionedTextElements): iterable {
 
                 $overlap = min($highestElementTop, $currentElementTop) - max($highestPositionedTextElementBottom, $currentElementBottom);
                 $smallestElementHeight = min($positionedTextElementHeight, $highestPositionedTextElementHeight);
-                if ($smallestElementHeight !== 0.0 && $overlap / $smallestElementHeight * 100 >= $this->overlapPercentage) {
+                if ($smallestElementHeight === 0.0) {
+                    continue;
+                }
+
+                $belongsOnLine = $overlap / $smallestElementHeight * 100 >= $this->overlapPercentage;
+
+                $isEnclosedSubscript = $overlap > 0.0
+                    && $positionedTextElementHeight < $highestPositionedTextElementHeight
+                    && $positionedTextElement->absoluteMatrix->offsetX >= $lineLeftX
+                    && $positionedTextElement->absoluteMatrix->offsetX <= $lineRightX;
+
+                if ($belongsOnLine || $isEnclosedSubscript) {
                     $positionedTextElementsOnLine[] = $positionedTextElement;
                     $processedIndices[$j] = true;
+                    $lineLeftX = min($lineLeftX, $positionedTextElement->absoluteMatrix->offsetX);
+                    $lineRightX = max($lineRightX, $positionedTextElement->absoluteMatrix->offsetX);
                 }
             }
 

tests/Samples/files/issue-127/contents.yml

@@ -479,8 +479,7 @@ pages:
       davon Kassenkredite 973.606 169.622 187.393 25.376 591.215 6.398 644.427 1.754.857 509.372 375.948 50.464 819.072 g g +80,2 +200,3 +100,6 +98,9 +38,5 x x
       davon Wertpapierschulden u. Kredite 14.155.560 3.236.587 2.031.803 1.057.262 7.829.909 1.616.176 15.399.208 15.723.382 3.701.622 2.178.372 1.148.446 8.694.942 g g +11,1 +14,4 +7,2 +8,6 +11,0 x x
       1)
-      Schulden beim öffentlichen Bereich 961.509 74.851 14.424 73.031 799.203 1.792.088 4.475.428 1.214.517 93.984 13.024 48.468 1.059.041 g g +26,3 +25,6 -9,7 -33,6 +32,5 x x
-      1)
+      Schulden beim öffentlichen Bereich1) 961.509 74.851 14.424 73.031 799.203 1.792.088 4.475.428 1.214.517 93.984 13.024 48.468 1.059.041 g g +26,3 +25,6 -9,7 -33,6 +32,5 x x
       davon Kassenkredite 443.012 23.973 2.064 28.936 388.038 32.928 203.824 586.893 48.750 2.064 3.487 532.591 g g +32,5 +103,4 +0,0 -87,9 +37,3 x x
       davon Kredite 518.498 50.878 12.360 44.095 411.165 1.759.160 4.271.604 627.624 45.234 10.960 44.981 526.450 g g +21,0 -11,1 -11,3 +2,0 +28,0 x x
       1)

tests/Samples/files/issue-215/contents.yml

@@ -253,8 +253,7 @@ pages:
       30. Welche Auswirkungen könnte die geplante Bodenversiegelung auf das 
       lokale Klima und die Luftqualität haben?
       31. Welche Maßnahmen hält die Bundesregierung für notwendig, um negati-
-      ve klimatische Effekte, wie eine Verschlechterung der CO -Bilanz oder 
-      2
+      ve klimatische Effekte, wie eine Verschlechterung der CO2-Bilanz oder 
       die Entstehung von städtischen Hitzeinseln, durch das Bauprojekt zu ver-
       hindern oder zu minimieren?
       32. Welche Maßnahmen sind vorgesehen, um insbesondere die Folgen von 

tests/Samples/files/issue-254/contents.yml

@@ -2584,16 +2584,14 @@ pages:
       Interventionsbereiche: katastrophenresiliente Gesellschaft; Schutz und Sicherheit; Cycherheit.
       d)Cluster „Digitalisierung, Industrie und Weltraum“: Stärkung der Kapazitäten und Sicherung der Souveränität Europas 
       in für Digitalisierung und Produktion wichtigen Schlüsseltechnologien sowie in der Weltraumtechnologie, entlang 
-      der gesamten Wertschöpfungskette, mit Blick auf den Aufbau einer wettbewerbsfähigen, digitalen, CO-armen und 
-      2
+      der gesamten Wertschöpfungskette, mit Blick auf den Aufbau einer wettbewerbsfähigen, digitalen, CO2-armen und 
       kreislauforientierten Industrie; Sicherung einer nachhaltigen Rohstoffversorgung; Entwicklung fortgeschrittener 
       Werkstoffe und Bereitstellung der Grundlage für Fortschritt und Innovation im Bereich der globalen 
       gesellschaftlichen Herausforderungen.
       Interventionsbereiche: Herstellungsverfahren; digitale Schlüsseltechnologien, einschließlich Quantentechnologien; 
       neue Grundlagentechnologien; fortgeschrittene Werkstoffe; künstliche Intelligenz und Robotik; Internet der 
       nächsten Generation; fortgeschrittene Rechensy und Massendatenverarbeitung (Big Data); kreislauforientierte 
-      Industrie; CO-arme und saubere Industrien; Weltraumtätigkeiten, einschließlich Erdbeobachtung.
-      2
+      Industrie; CO2-arme und saubere Industrien; Weltraumtätigkeiten, einschließlich Erdbeobachtung.
       e) Cluster „Klima, Energie und Mobilität“: Bekämpfung des Klimawandels, indem bessere Kenntnisse über dessen 
       Ursachen und Verlauf, Risiken, Auswirkungen und Chancen erlangt, die Sektoren Energie und Verkehr klima- und 
       umweltfreundlicher, effizienter und wettbewerbsfähiger, intelligenter, sicherer und tragfähiger gemacht, die Nutzung 
@@ -2607,8 +2605,7 @@ pages:
       f) Cluster „Lebensmittel, Bioökonomie, natürliche Ressourcen, Landwirtschaft und Umwelt“: Umweltschutz, 
       Wiederherstellung, nachhaltige Bewirtschaftung und Nutzung der natürlichen und biologischen Land-, 
       Binnengewässer- und Meeresressourcen zur Beendigung der Erosion der biologischen Vielfalt sowie zur Sicherung 
-      der Nahrungsmittel- und Nährstoffversorgung für alle und des Übergangs zu einer CO-armen und ressourcenef­
-      2
+      der Nahrungsmittel- und Nährstoffversorgung für alle und des Übergangs zu einer CO2-armen und ressourcenef­
       fizienten Kreislaufwirtschaft und einer nachhaltigen Bioökonomie.
   -
     content: |-
@@ -3132,13 +3129,10 @@ pages:
       können.
       15.Durch Sy mit dem Innovationsfonds im Rahmen des Emissionshandelssytems (im Folgenden 
       „Innovationsfonds“) wird Folgendes sichergestellt:
-      a) Der Innovationsfonds ist gezielt auf Innovationen im Bereich CO-arme Technologien und Prozesse ausgerichtet, 
-      2
-      darunter umweltverträgliche CO-Abscheidung und -Nutzung, die erheblich zur Eindämmung des Klimawandels 
-      2
+      a) Der Innovationsfonds ist gezielt auf Innovationen im Bereich CO2-arme Technologien und Prozesse ausgerichtet, 
+      darunter umweltverträgliche CO2-Abscheidung und -Nutzung, die erheblich zur Eindämmung des Klimawandels 
       beitragen, sowie Produkte, die kohlenstoffintensive Produkte ersetzen, und soll die Gestaltung und Umsetzung von 
-      Projekten, die auf eine umweltverträgliche Abscheidung und geologische Speicherung von CO abzielen, und 
-      2 
+      Projekten, die auf eine umweltverträgliche Abscheidung und geologische Speicherung von CO2 abzielen, und 
       innovative Technologien für erneuerbare Energien und Energiespeicherung anregen sowie umweltfreundlichere 
       Produkte ermöglichen und Anreize dafür schaffen;
       b)mit dem Programm werden Mittel für die Entwicklung und Demonstration von Technologien, einschließlich 

tests/Unit/Document/ContentStream/PositionedText/LineGroupingStrategy/TextOverlapStrategyTest.php

@@ -34,4 +34,31 @@ public function testOrdersLinesTopToBottomOnANegativeOriginPage(): void {
             iterator_to_array((new TextOverlapStrategy())->group([$bottom, $top]), false),
         );
     }
+
+    public function testKeepsAnEnclosedSubscriptOnItsLine(): void {
+        // A subscript like the "2" in "CO2" has a smaller font and a baseline shifted down, so it overlaps the line
+        // too little to clear the threshold on its own. Because it is enclosed horizontally by text on the line
+        // ("CO" before it, "-Bilanz" after it) it still belongs to that line rather than forming a line of its own.
+        $left = new PositionedTextElement('(CO)', new TransformationMatrix(1, 0, 0, 1, 50, 100), new TextState(null, 10));
+        $subscript = new PositionedTextElement('(2)', new TransformationMatrix(1, 0, 0, 1, 60, 98), new TextState(null, 7));
+        $right = new PositionedTextElement('(-Bilanz)', new TransformationMatrix(1, 0, 0, 1, 70, 100), new TextState(null, 10));
+
+        static::assertSame(
+            [[$left, $subscript, $right]],
+            iterator_to_array((new TextOverlapStrategy())->group([$left, $right, $subscript]), false),
+        );
+    }
+
+    public function testKeepsASmallerButNotEnclosedLineSeparate(): void {
+        // A smaller line that merely sits close (e.g. a subtitle below a heading) overlaps the heading just as much
+        // as an enclosed subscript would, but it is not enclosed horizontally by the heading's text, so it must keep
+        // its own line instead of being absorbed.
+        $heading = new PositionedTextElement('(BERTOSSI)', new TransformationMatrix(1, 0, 0, 1, 20, 800), new TextState(null, 22));
+        $subtitle = new PositionedTextElement('(Commande)', new TransformationMatrix(1, 0, 0, 1, 200, 796), new TextState(null, 12));
+
+        static::assertSame(
+            [[$heading], [$subtitle]],
+            iterator_to_array((new TextOverlapStrategy())->group([$subtitle, $heading]), false),
+        );
+    }
 }