Add support for hyphenation to wrapped text

CHANGELOG.md

@@ -7,6 +7,7 @@ Release date: UNRELEASED
 ### New features and improvements
 
 * Added an option to the `reverse` command to also flip the line direction (#654)
+* Added a `--hyphenate LANG` option to the `text` command (#668)
 
 ### Bug fixes
 

pyproject.toml

@@ -52,6 +52,7 @@ glcontext = { version = ">=2.3.2", optional = true }  # 2.3.2 needed to fix #200
 moderngl = { version = ">=5.6.2,!=5.7.1,!=5.7.2", optional = true }  # see moderngl/moderngl#525
 Pillow = { version = ">=9.0.1", optional = true }
 PySide6 = { version = ">=6.4.0.1", optional = true }
+pyphen = "^0.14.0"
 
 
 [tool.poetry.group.dev.dependencies]

vpype/text.py

@@ -27,6 +27,8 @@
 from pathlib import Path
 from typing import Callable
 
+import pyphen
+
 from .model import LineCollection
 
 __all__ = ["FONT_NAMES", "text_line", "text_block"]
@@ -145,8 +147,12 @@ def text_line(
     return lc
 
 
-def _word_wrap(paragraph: str, width: float, measure_func: Callable[[str], float]):
+def _word_wrap(
+    paragraph: str, width: float, lang: str | None, measure_func: Callable[[str], float]
+):
     """Break text in multiple line."""
+    dic = pyphen.Pyphen(lang=lang) if lang else None
+    print(lang, dic)
     result = []
     for line in paragraph.split("\n"):
         # handle empty lines
@@ -162,13 +168,23 @@ def _word_wrap(paragraph: str, width: float, measure_func: Callable[[str], float
         for a, b in zip(fields[::2], fields[1::2]):
             w = measure_func(x + a)
             if w > width:
-                if x == "":
-                    result.append(a)
-                    continue
-                else:
-                    result.append(x)
-                    x = ""
-            x += a + b
+                for aa, ab in dic.iterate(a) if dic else ():  # try hyphenating
+                    xa = x + aa + "\u002D"  # our fonts don't have a true hyphen
+                    w = measure_func(xa)
+                    if w <= width:
+                        result.append(xa)
+                        x = ab + b
+                        break
+                else:  # no fitting hyphenation
+                    if x == "":  # single word exceeds width
+                        result.append(a)
+                        continue
+                    else:
+                        result.append(x)
+                        x = ""
+                    x += a + b
+            else:
+                x += a + b
         if x != "":
             result.append(x + "\n")
     return result
@@ -195,6 +211,7 @@ def text_block(
     align: str = "left",
     line_spacing: float = 1,
     justify=False,
+    hyphenate=None,
 ) -> LineCollection:
     """Create a wrapped block of text using the provided width.
 
@@ -210,6 +227,7 @@ def text_block(
             left alignment)
         line_spacing: line spacing (default: 1.0)
         justify: should the text be justified (default: False)
+        hyphenate: wrapped text is hyphenated with the given language (default: None)
     """
 
     font = _Font.get(font_name)
@@ -221,7 +239,7 @@ def measure(txt):
         bounds = _text_line(txt, font).bounds()
         return bounds[2] if bounds else 0.0
 
-    lines = _word_wrap(paragraph, width, measure)
+    lines = _word_wrap(paragraph, width, hyphenate, measure)
 
     lc_arr = [
         _justify_text(line, font, width)

vpype_cli/text.py

@@ -16,6 +16,12 @@
 )
 @click.option("-s", "--size", type=LengthType(), default=18, help="Text size (default: 18).")
 @click.option("-w", "--wrap", type=LengthType(), help="Wrap to provided width.")
+@click.option(
+    "-h",
+    "--hyphenate",
+    type=TextType(),
+    help="Hyphenate wrapped words using the provided language.",
+)
 @click.option("-j", "--justify", is_flag=True, help="Justify text block (wrap-mode only).")
 @click.option(
     "-p",
@@ -38,6 +44,7 @@ def text(
     font: str,
     size: float,
     wrap: float | None,
+    hyphenate: str | None,
     justify: float,
     position: tuple[float, float],
     align: str,
@@ -53,7 +60,8 @@ def text(
 
     In wrap mode, the text start at (0, 0) and expends left until it reach the specified width.
     The `--align` option controls how the text is laid out within the column and behaves as
-    typically expected.
+    typically expected. The `--hyphenate` options enables hyphenation using the provided
+    language code.
 
     To start the text at the different location than (0, 0), use the `--position` option.
     """
@@ -64,7 +72,13 @@ def text(
 
     if wrap:
         lc = vp.text_block(
-            string, font_name=font, width=wrap, size=size, align=align, justify=justify
+            string,
+            font_name=font,
+            width=wrap,
+            size=size,
+            align=align,
+            justify=justify,
+            hyphenate=hyphenate,
         )
     else:
         lc = vp.text_line(string, font_name=font, size=size, align=align)