GlyphLayoutProcessor for correct glyph layout and support of DIN 91379 (Issue PDFBOX-4951)

examples/src/main/java/org/apache/pdfbox/examples/pdmodel/DoGlyphLayoutBidi.java

@@ -0,0 +1,125 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pdfbox.examples.pdmodel;
+
+import org.apache.pdfbox.pdmodel.GlyphLayoutProcessor;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDPageContentStream;
+import org.apache.pdfbox.pdmodel.font.PDType0Font;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * Examples for bidirectional text with GlyphLayoutProcessor
+ *
+ * @author Volker Kunert
+ * @version 2026-05
+ */
+public class DoGlyphLayoutBidi {
+    public static final String TEXT1 = "نحن الآن في شهر رمضان 1447 هجري";
+    public static final String TEXT2 = "Guten Tag ";
+    public static final String TEXT3 = "السلام عليكم";
+    public static final String TEXT4 = " Good afternoon";
+
+    /*
+     * Main
+     */
+    public static void main(String[] args) {
+        new DoGlyphLayoutBidi().test();
+    }
+
+    /*
+     * show one line
+     */
+    public static float showLine(PDPageContentStream cs, PDType0Font font, float fontSize,
+                                 float x, float y, String text) throws IOException {
+        return showLine(cs, new PDType0Font[]{font}, fontSize, x, y, new String[]{text});
+    }
+
+    /*
+     * show one line
+     */
+    public static float showLine(PDPageContentStream cs, PDType0Font[] fonts, float fontSize,
+                                 float x, float y, String[] texts) throws IOException {
+        cs.beginText();
+        cs.newLineAtOffset(x, y);
+
+        if (fonts.length != texts.length) {
+            throw new IllegalArgumentException("Size of fonts and texts is different");
+        }
+        for (int i = 0; i < texts.length; i++) {
+            cs.setFont(fonts[i], fontSize);
+            cs.showText(texts[i]);
+        }
+        cs.endText();
+
+        float height = fonts[0].getBoundingBox().getHeight();
+        y -= height / 1000f * fontSize;
+        return y;
+    }
+
+    /**
+     * Start the example
+     */
+    public void test() {
+        try {
+            GlyphLayoutProcessor glyphLayoutProcessor = new GlyphLayoutProcessor();
+
+            String outputFilename = "DoGlyphLayoutBidi.pdf";
+            String arabicPath = "/org/apache/pdfbox/examples/glyphlayout/noto/NotoSansArabic-Regular.ttf";
+            String lgcPath = "/org/apache/pdfbox/examples/glyphlayout/noto/NotoSans-Regular.ttf";
+
+            float fontSize = 12.0f;
+
+            PDDocument pdDocument = new PDDocument();
+
+            PDType0Font arabicFont = createPdType0Font(glyphLayoutProcessor, pdDocument, arabicPath);
+            PDType0Font lgcFont = createPdType0Font(glyphLayoutProcessor, pdDocument, lgcPath);
+
+            PDPage blankPage = new PDPage();
+            pdDocument.addPage(blankPage);
+            PDPageContentStream cs = new PDPageContentStream(pdDocument, pdDocument.getPage(0),
+                    PDPageContentStream.AppendMode.APPEND, true);
+            cs.setGlyphLayoutProcessor(glyphLayoutProcessor);
+
+            float x = blankPage.getBBox().getLowerLeftX() + fontSize;
+            float y = blankPage.getBBox().getUpperRightY() - fontSize;
+
+            y = showLine(cs, arabicFont, fontSize, x, y, TEXT1);
+            showLine(cs, new PDType0Font[]{lgcFont, arabicFont, lgcFont}, fontSize, x, y, new String[]{TEXT2, TEXT3, TEXT4});
+            cs.close();
+            pdDocument.save(outputFilename);
+            pdDocument.close();
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    /*
+     * Create the PDType0Font font
+     */
+    private PDType0Font createPdType0Font(GlyphLayoutProcessor glyphLayoutProcessor, PDDocument pdDocument,
+                                          String fontPath) {
+        InputStream fontStream = this.getClass().
+                getResourceAsStream(fontPath);
+        PDType0Font font = glyphLayoutProcessor.loadFont(pdDocument, fontStream);
+        return font;
+    }
+}

examples/src/main/java/org/apache/pdfbox/examples/pdmodel/DoGlyphLayoutDin91379.java

@@ -0,0 +1,148 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pdfbox.examples.pdmodel;
+
+import org.apache.pdfbox.pdmodel.GlyphLayoutProcessor;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDPageContentStream;
+import org.apache.pdfbox.pdmodel.font.PDType0Font;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * Example of formatting for letters defined in: DIN 91379: Characters in Unicode for the electronic processing
+ * of names and data exchange in Europe
+ * <p/>
+ * Font used: Arimo-Regular.ttf, see
+ * https://fonts.google.com/specimen/Arimo
+ * <p/>
+ * Use of the positioning features of Java.
+ *
+ * @author Volker Kunert
+ * @version 2026-04-04
+ */
+public class DoGlyphLayoutDin91379 {
+    public static String LATIN_CHARS_DIN_91379 =
+                    "DIN 91379: Characters in Unicode for the electronic processing of names \n"
+                    + "and data exchange in Europe\n"
+                    + "Font used: Arimo-Regular.ttf\n"
+                    + "\n"
+                    + "bll; Latin Letters (normative)\n"
+                    + "A B C D E F G H I J K L M N O P Q R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z\n"
+                    + "À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ð Ñ Ò Ó Ô Õ Ö Ø Ù Ú Û Ü Ý Þ ß à á â ã ä å æ ç è é ê ë ì í î ï ð ñ ò ó\n"
+                    + "ô õ ö ø ù ú û ü ý þ ÿ Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č Ď ď Đ đ Ē ē Ĕ ĕ Ė ė Ę ę Ě ě Ĝ ĝ Ğ ğ Ġ ġ Ģ ģ Ĥ ĥ Ħ\n"
+                    + "ħ Ĩ ĩ Ī ī Ĭ ĭ Į į İ ı IJ ij Ĵ ĵ Ķ ķ ĸ Ĺ ĺ Ļ ļ Ľ ľ Ŀ ŀ Ł ł Ń ń Ņ ņ Ň ň ʼn Ŋ ŋ Ō ō Ŏ ŏ Ő ő Œ œ Ŕ ŕ Ŗ ŗ Ř ř Ś ś Ŝ ŝ Ş\n"
+                    + "ş Š š Ţ ţ Ť ť Ŧ ŧ Ũ ũ Ū ū Ŭ ŭ Ů ů Ű ű Ų ų Ŵ ŵ Ŷ ŷ Ÿ Ź ź Ż ż Ž ž Ƈ ƈ Ə Ɨ Ơ ơ Ư ư Ʒ Ǎ ǎ Ǐ ǐ Ǒ ǒ Ǔ ǔ Ǖ ǖ\n"
+                    + "Ǘ ǘ Ǚ ǚ Ǜ ǜ Ǟ ǟ Ǣ ǣ Ǥ ǥ Ǧ ǧ Ǩ ǩ Ǫ ǫ Ǭ ǭ Ǯ ǯ ǰ Ǵ ǵ Ǹ ǹ Ǻ ǻ Ǽ ǽ Ǿ ǿ Ȓ ȓ Ș ș Ț ț Ȟ ȟ ȧ Ȩ ȩ Ȫ ȫ Ȭ ȭ\n"
+                    + "Ȯ ȯ Ȱ ȱ Ȳ ȳ ə ɨ ʒ Ḃ ḃ Ḇ ḇ Ḋ ḋ Ḍ ḍ Ḏ ḏ Ḑ ḑ ḗ Ḝ ḝ Ḟ ḟ Ḡ ḡ Ḣ ḣ Ḥ ḥ Ḧ ḧ Ḩ ḩ Ḫ ḫ ḯ Ḱ ḱ Ḳ ḳ Ḵ ḵ Ḷ ḷ Ḻ ḻ Ṁ\n"
+                    + "ṁ Ṃ ṃ Ṅ ṅ Ṇ ṇ Ṉ ṉ Ṓ ṓ Ṕ ṕ Ṗ ṗ Ṙ ṙ Ṛ ṛ Ṟ ṟ Ṡ ṡ Ṣ ṣ Ṫ ṫ Ṭ ṭ Ṯ ṯ Ẁ ẁ Ẃ ẃ Ẅ ẅ Ẇ ẇ Ẍ ẍ Ẏ ẏ Ẑ ẑ Ẓ ẓ Ẕ ẕ\n"
+                    + "ẖ ẗ ẞ Ạ ạ Ả ả Ấ ấ Ầ ầ Ẩ ẩ Ẫ ẫ Ậ ậ Ắ ắ Ằ ằ Ẳ ẳ Ẵ ẵ Ặ ặ Ẹ ẹ Ẻ ẻ Ẽ ẽ Ế ế Ề ề Ể ể Ễ ễ Ệ ệ Ỉ ỉ Ị ị Ọ ọ Ỏ ỏ Ố\n"
+                    + "ố Ồ ồ Ổ ổ Ỗ ỗ Ộ ộ Ớ ớ Ờ ờ Ở ở Ỡ ỡ Ợ ợ Ụ ụ Ủ ủ Ứ ứ Ừ ừ Ử ử Ữ ữ Ự ự Ỳ ỳ Ỵ ỵ Ỷ ỷ Ỹ ỹ\n"
+                    + "Sequences\n"
+                    + "A̋ C̀ C̄ C̆ C̈ C̕ C̣ C̦ C̨̆ D̂ F̀ F̄ G̀ H̄ H̦ H̱ J́ J̌ K̀ K̂ K̄ K̇ K̕ K̛ K̦ K͟H \n"
+                    + "K͟h L̂ L̥ L̥̄ L̦ M̀ M̂ M̆ M̐ N̂ N̄ N̆ N̦ P̀ P̄ P̕ P̣ R̆ R̥ R̥̄ S̀ S̄ S̛̄ S̱ T̀ T̄ \n"
+                    + "T̈ T̕ T̛ U̇ Z̀ Z̄ Z̆ Z̈ Z̧ a̋ c̀ c̄ c̆ c̈ c̕ c̣ c̦ c̨̆ d̂ f̀ f̄ g̀ h̄ h̦ j́ k̀ \n"
+                    + "k̂ k̄ k̇ k̕ k̛ k̦ k͟h l̂ l̥ l̥̄ l̦ m̀ m̂ m̆ m̐ n̂ n̄ n̆ n̦ p̀ p̄ p̕ p̣ r̆ r̥ r̥̄ \n"
+                    + "s̀ s̄ s̛̄ s̱ t̀ t̄ t̕ t̛ u̇ z̀ z̄ z̆ z̈ z̧ Ç̆ Û̄ ç̆ û̄ ÿ́ Č̕ Č̣ č̕ č̣ ē̍ Ī́ ī́ \n"
+                    + "ō̍ Ž̦ Ž̧ ž̦ ž̧ Ḳ̄ ḳ̄ Ṣ̄ ṣ̄ Ṭ̄ ṭ̄ Ạ̈ ạ̈ Ọ̈ ọ̈ Ụ̄ Ụ̈ ụ̄ ụ̈ \n"
+                    + "bnlreq; Non-Letters N1 (normative)\n"
+                    + "  ' , - . ` ~ ¨ ´ · ʹ ʺ ʾ ʿ ˈ ˌ ’ ‡ \n"
+                    + "bnl; Non-Letters N2 (normative)\n"
+                    + "! \" # $ % & ( ) * + / 0 1 2 3 4 5 6 7 8 9 : ; < = > \n"
+                    + "? @ [ \\ ] ^ _ { | } ¡ ¢ £ ¥ § © ª « ¬ ® ¯ ° ± ² ³ µ \n"
+                    + "¶ ¹ º » ¿ × ÷ € \n"
+                    + "bnlopt; Non-Letters N3 (normative)\n"
+                    + "¤ ¦ ¸ ¼ ½ ¾ \n"
+                    + "gl; Greek Letters (extended)\n"
+                    + "Ά Έ Ή Ί Ό Ύ Ώ ΐ Α Β Γ Δ Ε Ζ Η Θ Ι Κ Λ Μ Ν Ξ Ο Π Ρ Σ \n"
+                    + "Τ Υ Φ Χ Ψ Ω Ϊ Ϋ ά έ ή ί ΰ α β γ δ ε ζ η θ ι κ λ μ ν \n"
+                    + "ξ ο π ρ ς σ τ υ φ χ ψ ω ϊ ϋ ό ύ ώ \n"
+                    + "cl; Cyrillic Letters (extended)\n"
+                    + "Ѝ А Б В Г Д Е Ж З И Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш \n"
+                    + "Щ Ъ Ь Ю Я а б в г д е ж з и й к л м н о п р с т у ф \n"
+                    + "х ц ч ш щ ъ ь ю я ѝ \n"
+                    + "enl; Non-Letters E1 (extended)\n"
+                    + "ƒ ʰ ʳ ˆ ˜ ˢ ᵈ ᵗ ‘ ‚ “ ” „ † … ‰ ′ ″ ‹ › ⁰ ⁴ ⁵ ⁶ ⁷ ⁸ \n"
+                    + "⁹ ⁿ ₀ ₁ ₂ ₃ ₄ ₅ ₆ ₇ ₈ ₉ ™ ∞ ≤ ≥ \n"
+                    + "Additional non-letters (not included in DIN 91379): – — •�";
+
+   /*
+     * Start the test
+     */
+    public static void main(String[] args) {
+        try {
+            GlyphLayoutProcessor glyphLayoutProcessor = new GlyphLayoutProcessor();
+
+            String outputFilename = "DoGlyphLayoutDin91379.pdf";
+            float fontSize = 12.0f;
+
+            PDDocument pdDocument = new PDDocument();
+            InputStream fontStream = DoGlyphLayoutDin91379Form.class.
+                    getResourceAsStream("/org/apache/pdfbox/examples/glyphlayout/arimo/Arimo-Regular.ttf");
+            PDType0Font font = glyphLayoutProcessor.loadFont(pdDocument, fontStream);
+
+            PDPage blankPage = new PDPage();
+            pdDocument.addPage(blankPage);
+            PDPageContentStream cs = new PDPageContentStream(pdDocument, pdDocument.getPage(0),
+                    PDPageContentStream.AppendMode.APPEND, true);
+            cs.setGlyphLayoutProcessor(glyphLayoutProcessor);
+
+            float x = blankPage.getBBox().getLowerLeftX() + fontSize;
+            float y = blankPage.getBBox().getUpperRightY() - fontSize;
+            showComposites(cs, font, fontSize, x, y, LATIN_CHARS_DIN_91379);
+            cs.close();
+            pdDocument.save(outputFilename);
+            pdDocument.close();
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    /*
+     * break the text into lines and show them
+     */
+    public static void showComposites(PDPageContentStream cs, PDType0Font font, float fontSize,
+                                      float x, float y, String s) throws Exception {
+
+        s = s.replaceAll("\t", "    ");
+        String[] lines = s.split("[\n]");
+
+        float height = font.getBoundingBox().getHeight();
+
+        for (String line : lines) {
+            if (!line.isEmpty()) {
+                showCompositesLine(cs, font, fontSize, x, y, line);
+                y -= height / 1000f * fontSize;
+            }
+        }
+    }
+
+    /*
+     * show one line
+     */
+    public static void showCompositesLine(PDPageContentStream cs, PDType0Font font, float fontSize,
+                                          float x, float y, String line) throws IOException {
+        cs.beginText();
+        cs.setFont(font, fontSize);
+        cs.newLineAtOffset(x, y);
+        cs.showText(line);
+        cs.endText();
+    }
+}