Skip to content

README.md

Latest commit

 

History

History
114 lines (97 loc) · 4.97 KB

README.md

File metadata and controls

114 lines (97 loc) · 4.97 KB
Raw

vec4ipa UI (WinUI 3 workbench)

A single-file, self-contained Windows GUI for the vec4ipa tool suite (IPA strings ↔ 16-D articulatory vectors), built with WinUI 3 and .NET 9. The engine is the same header-only core the CLI tools use (../src/ipa2vec_core.h), compiled once into ipa2vec_core.dll and called via P/Invoke — numbers are identical to the command line.

Layout

ui/
├── vec4ipa_ui.c            legacy Win32 wrapper (superseded, kept for reference)
├── app.rc / app.res        Win32 resources (legacy)
├── assets/                 application icon sources (SVG/PNG)
├── fonts/                  Gentium Book Plus + NewComputerModern10 (SIL OFL 1.1)
└── winui/                  the WinUI 3 front-end
    ├── vec4ipa_ui.csproj   project (unpackaged, self-contained; MSIX via wap/)
    ├── wap/                Windows Application Packaging project (MSIX)
    ├── App.xaml(.cs)       application entry, startup diagnostics
    ├── Program.cs          explicit entry point (logs Application.Start
    │                       failures to %TEMP%\vec4ipa\crash.log)
    ├── MainWindow.xaml(.cs) the whole workbench UI
    ├── Core.cs             P/Invoke bindings to ipa2vec_core.dll
    ├── core_wrap.c         C export layer (compiled into the DLL)
    ├── app.manifest        DPI awareness etc.
    ├── install_msix.ps1    install the packaged app from wap\AppPackages
    └── build.bat           build script

Features

  • Fluent materials: Mica window backdrop (Windows 11) with theme-driven containers, in-app acrylic popovers (narrowness picker, format picker, symbol hover card), accent pills and animated motion throughout
  • IPA → vectors: type or click symbols on the soft keyboard; output as plain vectors, two-layer IR (with rebuilt IPA) or JSON
  • Vector → IPA: 16-D input (multi-line for batch), width 0-4, live vector editor with reverse preview
  • Long-press pickers: the narrowness control and the output format selector pop up as acrylic overlays — hold the button to open, slide with a magnetic S-curve cursor (the format list animates its accent selection pill between rows)
  • Loop: IPA → vectors → reverse fit with the tone annotation (tone=(…) groups) round-tripped
  • IPA soft keyboard: continuous scroll with grouped sections — Consonants (by place), Non-pulmonic (ejectives/implosives/clicks), Vowels (trapezium order), Diacritics, Letters, Tones, Recent. Hover shows a Fluent symbol card (acrylic, animated), double-click opens details
  • Symbol compare, weighted distance, history, examples, open-file batch convert, convert+reverse loop
  • Views: base table, module details, statistics, metric weights, effective weights, module enablement, metric.json loading
  • Export: bundled CLI tools, command lines, table CSV, IR layer1/layer2 files, output saving
  • Window: custom title bar, drag-resizable splitter, theme (system/light/dark), English/中文 UI, window state persistence, CLI-compatible startup arguments, MSIX packaging via the WAP project (wap/)

Build

Requirements:

  • MinGW-w64 gcc (builds ipa2vec_core.dll)
  • Visual Studio 2022 Build Tools with the MSBuild tools and Universal Windows Platform build tools workloads (WinUI 3 build tasks; plain dotnet build is not enough)
  • .NET SDK 9
ui\winui\build.bat            # builds the DLL, then publishes to dist\
ui\winui\build.bat clean      # remove build output

Output: ui\winui\dist\ — a self-contained folder with vec4ipa_ui.exe, runnable without installing anything.

Single-file (PublishSingleFile) publishing is not supported: WindowsAppSDK self-contained apps fail at startup in that mode (known platform limitation).

Command line

vec4ipa_ui [OPTIONS] [IPA-STRING]
  --narrowness LEVEL    reverse-fit narrowness (broadest|broad|medium|narrow|narrowest, or 0-4; alias --width; default narrow)
  -q, --query SYM      query one symbol on startup
  -r, --reverse VEC    16-D vector -> IPA on startup
  --theme system|light|dark
  --export-tools DIR   write the bundled CLI tools to DIR
  -h, --help
  IPA-STRING           forward IPA -> vectors on startup

Fonts

The GUI uses Gentium Book Plus (normative IPA letterforms); the application icon renders its arrow with NewComputerModern10. Both are SIL OFL 1.1 licensed and ship in ui/fonts/ with the license text; the app falls back to system fonts if they are absent.

Notes

  • Startup diagnostics (startup.log, crash.log — including the explicit Program.cs entry point, which catches Application.Start failures before the App ctor's handler exists) go to %TEMP%\vec4ipa\, never into the app folder.
  • The window uses the Fluent Mica backdrop (Windows 11); the XAML containers stay transparent so the material shows through, and the theme (system/light/dark) drives both the material and the theme resources.