How dinhphu-0124/mackey works
MacKey is a macOS Vietnamese input method with a companion settings and utility interface. The main workflow is a user typing in another application, with the engine transforming keystrokes into Vietnamese text according to the selected input style and encoding. Users configure typing behavior in the dashboard; separate capabilities include macro management and suggestions, text conversion, and release updates. Engine internals are represented where excerpts identify them. UI-to-engine wiring and several UI implementations were not sampled, so those links are marked unverified.
Main entry points: Engine.cpp Key Event Engine · AppDelegate.m Menu Bar · MacroViewController.mm Macro Manager · ViewController.m Settings Dashboard
Components 18
App Interface
- Menu Bar
Source/Sources/MacKey/macOS/ModernKey/AppDelegate.m - Settings Dashboard
Source/Sources/MacKey/macOS/ModernKey/ViewController.m - Macro Manager
Source/Sources/MacKey/macOS/ModernKey/MacroViewController.mm - Macro Suggestions
Source/Sources/MacKey/macOS/ModernKey/MacroSuggestionController.mm - Convert Window
Source/Sources/MacKey/macOS/ModernKey/ConvertToolViewController.mm - About and Updates
Source/Sources/MacKey/macOS/ModernKey/AboutViewController.m
Typing Engine
- Key Event Engine
Source/Sources/MacKey/engine/Engine.cpp - Vietnamese Rules
Source/Sources/MacKey/engine/Vietnamese.cpp - Key Types and Codes
Source/Sources/MacKey/engine/DataType.h - Macro Runtime
Source/Sources/MacKey/engine/Macro.cpp
Text Utilities
- Conversion Engine
Source/Sources/MacKey/engine/ConvertTool.cpp - XLSX Import
Source/Sources/MacKey/macOS/ModernKey/xlsx_parser.py - XLSX Export
Source/Sources/MacKey/macOS/ModernKey/xlsx_exporter.py
App Services
- App Manager
Source/Sources/MacKey/macOS/ModernKey/MacKeyManager.m - Smart Switching
Source/Sources/MacKey/engine/SmartSwitchKey.cpp
Other components
- User
- Text Application
- GitHub Releases API
Connections 18
- User → Menu Bar: opens controls
README.md - User → Text Application: types text
README.md - Menu Bar → Settings Dashboard: opens settings
README.md - Menu Bar → Macro Manager: opens manager
README.md - Menu Bar → Convert Window: opens converter
README.md - Menu Bar → About and Updates: opens about
README.md - About and Updates → GitHub Releases API: checks releases
README.md - Text Application → Key Event Engine: sends keystrokes
- Key Event Engine → Text Application: replaces text
- Key Event Engine → Vietnamese Rules: uses rules
- Key Event Engine → Key Types and Codes: uses definitions
- Key Event Engine → Macro Runtime: checks suggestions
- Macro Suggestions → Macro Runtime: shows suggestions
- Settings Dashboard → Smart Switching: configures switching
- Convert Window → Conversion Engine: requests conversion
- Macro Manager → XLSX Import: imports macros
README.md - Macro Manager → XLSX Export: exports macros
README.md - App Manager → Key Event Engine: manages engine