inkflow 0.1.0.dev0__py3-none-any.whl

inkflow/pipeline.py

@@ -0,0 +1,244 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from lxml import etree
+
+from inkflow import ns
+from inkflow.content import (
+    inject_style,
+    remove_unreferenced_zones,
+    substitute_content,
+    substitute_zone_numbers,
+)
+from inkflow.layout import resolve_chain, resolve_parent_path, strip_layout_layers
+from inkflow.manifest import (
+    Animation,
+    Bounce,
+    Deck,
+    FadeIn,
+    FadeOut,
+    MarkdownSlide,
+    Slide,
+    Transition,
+)
+
+# ── Path conventions ─────────────────────────────────────────────────────────
+
+
+def resolve_slide_src(src: str, project_dir: Path) -> Path:
+    """Resolve a Slide.src string to an absolute Path.
+
+    Bare single-part names (no separator) are looked up in slides/.
+    Explicit paths (with / or absolute) are resolved relative to project_dir.
+    """
+    p = Path(src)
+    if p.is_absolute():
+        return p if p.suffix else p.with_suffix(".svg")
+    if len(p.parts) == 1:
+        name = p.stem if p.suffix else src
+        return project_dir / "slides" / (name + ".svg")
+    if not p.suffix:
+        p = p.with_suffix(".svg")
+    return (project_dir / p).resolve()
+
+
+def _resolve_content_src(src: str, project_dir: Path) -> Path:
+    """Resolve a MarkdownSlide content path to an absolute Path.
+
+    Bare single-part names are looked up in slides/ with a .md suffix.
+    """
+    p = Path(src)
+    if p.is_absolute():
+        return p if p.suffix else p.with_suffix(".md")
+    if len(p.parts) == 1:
+        name = p.stem if p.suffix else src
+        return project_dir / "slides" / (name + ".md")
+    if not p.suffix:
+        p = p.with_suffix(".md")
+    return (project_dir / p).resolve()
+
+
+# ── Animation classes ─────────────────────────────────────────────────────────
+
+_ANIM_CLASS: dict[type, str] = {
+    FadeIn: "anim-fade-in",
+    FadeOut: "anim-fade-out",
+    Bounce: "anim-bounce",
+}
+
+_INKSCAPE_NAMESPACES: frozenset[str] = frozenset({ns.INKSCAPE, ns.SODIPODI})
+
+
+def clean_inkscape_svg(src: Path) -> str:
+    tree = etree.parse(src)
+    root = tree.getroot()
+
+    for ns_uri in _INKSCAPE_NAMESPACES:
+        for el in root.findall(f".//{{{ns_uri}}}*"):
+            parent = el.getparent()
+            if parent is not None:
+                parent.remove(el)
+
+    for el in root.iter():
+        to_del = [
+            k
+            for k in el.attrib
+            if isinstance(k, str)
+            and any(k.startswith(f"{{{ns_uri}}}") for ns_uri in _INKSCAPE_NAMESPACES)
+        ]
+        for k in to_del:
+            del el.attrib[k]
+
+    etree.cleanup_namespaces(root)
+    return etree.tostring(root, encoding="unicode", pretty_print=True)
+
+
+def annotate_svg(svg_str: str, animations: list[Animation]) -> str:
+    root = etree.fromstring(svg_str.encode())
+
+    for anim in animations:
+        css_class = _ANIM_CLASS.get(type(anim))
+        if css_class is None:
+            continue
+
+        eid = anim.element.lstrip("#")
+        el = root.find(f'.//*[@id="{eid}"]')
+        if el is None:
+            print(f"[inkflow] warning: element #{eid} not found in SVG")
+            continue
+
+        existing = el.get("class", "")
+        el.set("class", f"{existing} {css_class}".strip())
+        el.set("data-step", str(anim.step))
+
+    return etree.tostring(root, encoding="unicode")
+
+
+def _serialize_transition(t: Transition | None) -> dict[str, object]:
+    if t is None:
+        return {"type": "cut", "duration": 0.0}
+    return {"type": type(t).__name__.lower(), **vars(t)}
+
+
+def resolve_transitions(deck: Deck) -> list[dict[str, object]]:
+    return [
+        _serialize_transition(
+            slide.transition if slide.transition is not None else deck.transition
+        )
+        for slide in deck.slides
+    ]
+
+
+def compose_with_ancestors(svg_str: str, chain: list[Path]) -> str:
+    """Prepend ancestor SVG content below the slide's own content."""
+    slide_root = etree.fromstring(svg_str.encode())
+    strip_layout_layers(slide_root)
+
+    ancestor_groups: list[etree._Element] = []  # pyright: ignore[reportPrivateUsage]
+    merged_defs: list[etree._Element] = []  # pyright: ignore[reportPrivateUsage]
+
+    for ancestor_path in chain:
+        anc_str = clean_inkscape_svg(ancestor_path)
+        anc_root = etree.fromstring(anc_str.encode())
+        strip_layout_layers(anc_root)
+
+        for defs_el in anc_root.findall(f"{{{ns.SVG}}}defs"):
+            merged_defs.extend(list(defs_el))
+
+        children = [el for el in anc_root if el.tag != f"{{{ns.SVG}}}defs"]
+        if children:
+            g = etree.Element(f"{{{ns.SVG}}}g")
+            for child in children:
+                g.append(child)
+            ancestor_groups.append(g)
+
+    if merged_defs:
+        slide_defs = slide_root.find(f"{{{ns.SVG}}}defs")
+        if slide_defs is None:
+            slide_defs = etree.Element(f"{{{ns.SVG}}}defs")
+            slide_root.insert(0, slide_defs)
+        for i, def_el in enumerate(merged_defs):
+            slide_defs.insert(i, def_el)
+
+    insert_pos = next(
+        (i + 1 for i, el in enumerate(slide_root) if el.tag == f"{{{ns.SVG}}}defs"),
+        0,
+    )
+    for i, group in enumerate(ancestor_groups):
+        slide_root.insert(insert_pos + i, group)
+
+    return etree.tostring(slide_root, encoding="unicode")
+
+
+def _resolve_markdown_slide(
+    ms: MarkdownSlide, project_dir: Path, theme: str | None
+) -> Slide:
+    from inkflow.markdown import build_slide_content
+
+    # Use project_dir as the synthetic svg_path parent so multi-part relative
+    # paths in the template string resolve relative to the project root.
+    template_path = resolve_parent_path(
+        ms.template, project_dir / "_", project_dir, theme
+    )
+    content_path = (
+        _resolve_content_src(ms.content, project_dir)
+        if ms.content is not None
+        else None
+    )
+    content = build_slide_content(content_path, ms.steps, ms._extra)  # pyright: ignore[reportPrivateUsage]
+    return Slide(
+        src=str(template_path),
+        animations=ms.animations,
+        content=content,
+        transition=ms.transition,
+        style=ms.style,
+    )
+
+
+def process_slide(
+    slide: Slide,
+    project_dir: Path,
+    theme: str | None,
+    slide_number: int,
+    total_slides: int,
+    deck_style: str = "",
+    font_size: int = 36,
+) -> str:
+    src = resolve_slide_src(slide.src, project_dir)
+    svg_str = clean_inkscape_svg(src)
+    chain = resolve_chain(src, project_dir, theme)
+    if chain:
+        svg_str = compose_with_ancestors(svg_str, chain)
+    svg_str = substitute_zone_numbers(svg_str, slide_number, total_slides)
+    if slide.content:
+        svg_str = substitute_content(svg_str, slide.content, project_dir, font_size)
+    if slide.animations:
+        svg_str = annotate_svg(svg_str, slide.animations)
+    combined_css = "\n".join(filter(None, [deck_style, slide.style]))
+    if combined_css:
+        svg_str = inject_style(svg_str, combined_css)
+    svg_str = remove_unreferenced_zones(svg_str)
+    return svg_str
+
+
+def process_deck(deck: Deck, project_dir: Path) -> list[str]:
+    total = len(deck.slides)
+    results: list[str] = []
+    for i, entry in enumerate(deck.slides):
+        if isinstance(entry, MarkdownSlide):
+            slide = _resolve_markdown_slide(entry, project_dir, deck.theme)
+        else:
+            slide = entry
+        results.append(
+            process_slide(
+                slide,
+                project_dir,
+                deck.theme,
+                i + 1,
+                total,
+                deck.style,
+                deck.font_size,
+            )
+        )
+    return results

inkflow/presenter.css

@@ -0,0 +1,196 @@
+/* Catppuccin Mocha */
+:root {
+  --bg:      #1e1e2e;
+  --surface: #313244;
+  --overlay: #45475a;
+  --text:    #cdd6f4;
+  --subtext: #a6adc8;
+  --accent:  #cba6f7;
+  --green:   #a6e3a1;
+  --red:     #f38ba8;
+  --blue:    #89b4fa;
+}
+
+*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
+
+body {
+  background: var(--bg);
+  color: var(--text);
+  font-family: 'JetBrains Mono', 'Fira Code', ui-monospace, monospace;
+  height: 100vh;
+  display: flex;
+  flex-direction: column;
+  overflow: hidden;
+  user-select: none;
+}
+
+#stage {
+  flex: 1;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: 0.5rem;
+  min-height: 0;
+}
+
+#stage > svg,
+#stage > :first-child {
+  max-width: 100%;
+  max-height: 100%;
+  width: auto;
+  height: auto;
+}
+
+#statusbar {
+  flex-shrink: 0;
+  background: var(--surface);
+  color: var(--subtext);
+  font-size: 0.7rem;
+  padding: 0.25rem 0.75rem;
+  display: flex;
+  align-items: center;
+  gap: 1rem;
+  border-top: 1px solid var(--accent);
+}
+
+#statusbar .sep { color: var(--overlay); }
+
+#ws-dot {
+  display: inline-block;
+  width: 6px;
+  height: 6px;
+  border-radius: 50%;
+  background: var(--red);
+  margin-right: 4px;
+  transition: background 0.3s;
+}
+#ws-dot.connected { background: var(--green); }
+
+#hint {
+  margin-left: auto;
+  color: var(--overlay);
+}
+
+/* ── Curtain (blackout / whiteout) ── */
+#curtain {
+  display: none;
+  position: fixed;
+  inset: 0;
+  z-index: 20;
+  cursor: pointer;
+}
+#curtain.visible { display: block; }
+
+/* ── Help overlay ── */
+#help {
+  display: none;
+  position: fixed;
+  inset: 0;
+  z-index: 30;
+  background: rgba(0, 0, 0, 0.6);
+  align-items: center;
+  justify-content: center;
+}
+#help.visible { display: flex; }
+
+#help-box {
+  background: var(--surface);
+  border: 1px solid var(--accent);
+  border-radius: 8px;
+  padding: 1.5rem 2rem;
+  min-width: 26rem;
+}
+
+#help-box h2 {
+  color: var(--accent);
+  font-size: 0.85rem;
+  margin-bottom: 1rem;
+  letter-spacing: 0.05em;
+}
+
+#help-box table { border-collapse: collapse; width: 100%; }
+#help-box td { padding: 0.2rem 0.5rem; font-size: 0.75rem; }
+#help-box td:first-child { color: var(--accent); white-space: nowrap; text-align: right; }
+#help-box td:last-child  { color: var(--subtext); padding-left: 1rem; }
+
+#help-box p {
+  margin-top: 1rem;
+  font-size: 0.7rem;
+  color: var(--overlay);
+  text-align: center;
+}
+
+kbd {
+  background: var(--overlay);
+  color: var(--text);
+  border-radius: 3px;
+  padding: 0.1em 0.35em;
+  font-size: 0.85em;
+}
+
+/* ── Error overlay ── */
+#error-overlay {
+  display: none;
+  position: fixed;
+  inset: 0;
+  z-index: 50;
+  background: rgba(30, 30, 46, 0.95);
+  align-items: flex-start;
+  justify-content: center;
+  padding: 3rem 2rem;
+  overflow-y: auto;
+}
+#error-overlay.visible { display: flex; }
+
+#error-box {
+  background: var(--surface);
+  border: 1px solid var(--red);
+  border-radius: 8px;
+  padding: 1.5rem 2rem;
+  max-width: 72rem;
+  width: 100%;
+}
+
+#error-box h2 {
+  color: var(--red);
+  font-size: 0.85rem;
+  margin-bottom: 1rem;
+  letter-spacing: 0.05em;
+}
+
+#error-box pre {
+  color: var(--text);
+  font-size: 0.75rem;
+  white-space: pre-wrap;
+  word-break: break-all;
+  line-height: 1.6;
+}
+
+/* ── Animation classes ── */
+
+.anim-fade-in {
+  opacity: 0;
+  transition: opacity 0.4s ease;
+}
+.anim-fade-in.active {
+  opacity: 1;
+}
+
+.anim-fade-out {
+  opacity: 1;
+  transition: opacity 0.4s ease;
+}
+.anim-fade-out.active {
+  opacity: 0;
+}
+
+/* Bounce-in from below */
+.anim-bounce {
+  opacity: 0;
+  transform: translateY(14px);
+  transition: opacity 0.35s ease, transform 0.35s cubic-bezier(0.34, 1.56, 0.64, 1);
+}
+.anim-bounce.active {
+  opacity: 1;
+  transform: translateY(0);
+}

inkflow/presenter.html

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en" data-theme="__DATA_THEME__">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Inkflow</title>
+  <style>__STYLES__</style>
+  <style>__CSS__</style>
+</head>
+<body>
+  <div id="error-overlay">
+    <div id="error-box">
+      <h2>BUILD ERROR</h2>
+      <pre id="error-msg"></pre>
+    </div>
+  </div>
+  <div id="curtain"></div>
+  <div id="help" role="dialog" aria-modal="true">
+    <div id="help-box">
+      <h2>KEYBINDINGS</h2>
+      <table>
+        <tr><td>→ Space l</td><td>Advance step / next slide</td></tr>
+        <tr><td>← Backspace h</td><td>Back one step / previous slide</td></tr>
+        <tr><td>↓ j</td><td>Next slide (skip steps)</td></tr>
+        <tr><td>↑ k</td><td>Previous slide (skip steps)</td></tr>
+        <tr><td>^ Home</td><td>First slide</td></tr>
+        <tr><td>$ End</td><td>Last slide</td></tr>
+        <tr><td>g 12 ↵</td><td>Go to slide 12</td></tr>
+        <tr><td>b .</td><td>Blackout</td></tr>
+        <tr><td>w</td><td>Whiteout</td></tr>
+        <tr><td>f</td><td>Toggle fullscreen</td></tr>
+        <tr><td>t</td><td>Toggle dark / light mode</td></tr>
+        <tr><td>?</td><td>This help</td></tr>
+      </table>
+      <p>Press <kbd>?</kbd> or <kbd>Esc</kbd> to close</p>
+    </div>
+  </div>
+  <div id="stage"></div>
+  <div id="statusbar">
+    <span id="slide-info">– / –</span>
+    <span class="sep">|</span>
+    <span id="step-info">step –</span>
+    <span class="sep">|</span>
+    <span><span id="ws-dot"></span><span id="ws-label">disconnected</span></span>
+    <span id="hint">← → Space · navigate  ·  g goto  ·  ? help</span>
+  </div>
+
+  <script>__JS__</script>
+</body>
+</html>