# majbyr/komi-keyboard-ios architecture

> Architecture diagram of the GitHub repository majbyr/komi-keyboard-ios, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/majbyr/komi-keyboard-ios
- Repository: https://github.com/majbyr/komi-keyboard-ios

## Overview

##### Project type and purpose
- This is an iOS keyboard application (“Komi keyboard”) composed of two deliverables in a single Xcode workspace:
a) A host iOS app (“mainapp”) for setup/configuration and App Store distribution
b) A keyboard extension (“keyboard”) implementing custom Komi layouts with prediction models
- Supporting modules generate and package statistical language models for different scripts (cyrillic, latin, anbur)

##### File structure
- Top-level directories:
– anbur, cyrillic, latin: each defines a script’s Info.plist (keyboard identifier), KeyboardLayouts.swift, and locale strings
– keyboard: the actual extension target – UI components (KeyRow, KeyBase, KeyPopup), controller (KeyboardViewController), PredictionEngine, assets
– mainapp: the container iOS app – AppDelegate, SceneDelegate, ViewController, UI for user settings & install instructions
– models_create: Python scripts (prepare.py, optimize.py) to build JSON language‐model artifacts under cyrillic/models
- Build/deployment:
– komikeyboard.xcodeproj ties together mainapp and keyboard extension; Info.plist configurations, asset catalogs, localization folders
– .xcshareddata and schemes define build targets for the host app and extension

##### README for additional insights
- Confirms iOS 13+ target, Xcode 12.5+ requirement
- Describes the app and points to App Store and screenshots (no architecture details)

a. Main components:
1) Host iOS App (“mainapp”)
2) Keyboard Extension (“keyboard”)
3) Language‐Model Generator Scripts (“models_create”)
4) Script Modules (anbur, cyrillic, latin) each providing layout code and locale bundles
5) JSON Model Artifacts (unigram, bigram, trigram, cap_patterns, completion)
6) iOS System Services (InputMethodKit, App Group / UserDefaults for settings)
b. Relationships & interactions:
– models_create → JSON artifacts → bundled into keyboard extension
– each script module → compiled resource in extension (Info.plist, .xcstrings, KeyboardLayouts.swift)
– mainapp ↔ UserDefaults (or App Group) ↔ keyboard extension for user preferences (enabled layouts, predictions toggle)
– keyboard extension UI (KeyboardViewController) uses PredictionEngine → loads JSON models → makes suggestions
– KeyboardView emits text input events → delivered to host app through standard iOS input APIs
c. Architectural patterns & design principles:
– iOS App‐Extension pattern: separation of host app vs extension sandbox
– MVC for host app (ViewController, extensions.swift helpers)
– Modular layout definition per script for extensibility (anbur, latin, cyrillic)
– Data‐driven prediction engine leveraging precomputed probability tables
d. Key technologies/frameworks:
– Swift, UIKit, InputMethodKit
– Info.plist localization (.xcstrings) for multilingual support
– Python for offline model generation

##### Essential details to capture
– Distinct boundaries: Host App vs Extension vs External Scripts
– Model artifact lifecycle (generation → bundling → runtime usage)
– iOS system dependencies (InputMethodKit hooks, App Group)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Scripts
    subgraph "External Scripts" 
        style ES fill:#FFE5B4,stroke:#E69A2A
        PREP["prepare.py"]:::pipeline
        OPT["optimize.py"]:::pipeline
    end

    %% Script Modules
    subgraph "Script Modules"
        style SM fill:#E0F7FA,stroke:#26A69A
        ANBUR["Anbur Module"]:::module
        CYR["Cyrillic Module"]:::module
        LAT["Latin Module"]:::module
    end

    %% JSON Models
    subgraph "Model Artifacts"
        style MA fill:#E8F5E9,stroke:#43A047
        UNI["unigram_probs.json"]:::data
        BI["bigram_probs.json"]:::data
        TRI["trigram_probs.json"]:::data
        CAP["cap_patterns_probs.json"]:::data
        COMP["completion_probs.json"]:::data
    end

    %% Build & Deployment
    subgraph "Build & Deployment"
        style BD fill:#FFF3E0,stroke:#FB8C00
        XCODE["komikeyboard.xcodeproj"]:::pipeline
        SCHEMES["Shared Schemes"]:::pipeline
    end

    %% Host App
    subgraph "Host App" 
        style HA fill:#E3F2FD,stroke:#1E88E5
        APPD["AppDelegate.swift"]:::ui
        SCEND["SceneDelegate.swift"]:::ui
        VC["ViewController.swift"]:::ui
        EXTNS["Extensions & UI Helpers"]:::ui
        STORY["Storyboards & Localizations"]:::ui
        ASSETS_APP["Assets & Info.plist"]:::ui
    end

    %% Keyboard Extension
    subgraph "Keyboard Extension"
        style KE fill:#E3F2FD,stroke:#1E88E5
        UICOMP["UI Components"]:::ui
        KVC["KeyboardViewController"]:::ui
        KVIEW["KeyboardView.swift"]:::ui
        HEIGHT["KeyboardHeightDetector.swift"]:::ui
        PENG["PredictionEngine.swift"]:::data
        ASSETS_EXT["Assets Catalog"]:::ui
    end

    %% Relationships
    PREP -->|generates| UNI
    OPT -->|optimizes| UNI
    UNI -->|bundled into| PENG
    BI -->|bundled into| PENG
    TRI -->|bundled into| PENG
    CAP -->|bundled into| PENG
    COMP -->|bundled into| PENG

    ANBUR -->|layout & locale| UICOMP
    CYR -->|layout & locale| UICOMP
    LAT -->|layout & locale| UICOMP

    XCODE -->|builds targets| APPD
    XCODE -->|builds targets| KVC
    SCHEMES --> XCODE

    VC -->|conf config via| EXTNS
    EXTNS -->|writes prefs| ASSETS_APP
    ASSETS_APP -->|stored in App Group| PENG
    PENG -->|reads prefs| KVC

    UICOMP --> KVIEW
    KVIEW --> KVC
    KVC -->|loads| PENG
    KVC -->|renders UI via| UICOMP

    %% Click Events - External Scripts
    click PREP "https://github.com/majbyr/komi-keyboard-ios/blob/main/models_create/prepare.py"
    click OPT "https://github.com/majbyr/komi-keyboard-ios/blob/main/models_create/optimize.py"

    %% Click Events - Script Modules
    click ANBUR "https://github.com/majbyr/komi-keyboard-ios/blob/main/anbur/KeyboardLayouts.swift"
    click ANBUR "https://github.com/majbyr/komi-keyboard-ios/blob/main/anbur/Info.plist"
    click CYR "https://github.com/majbyr/komi-keyboard-ios/blob/main/cyrillic/KeyboardLayouts.swift"
    click CYR "https://github.com/majbyr/komi-keyboard-ios/blob/main/cyrillic/Info.plist"
    click CYR "https://github.com/majbyr/komi-keyboard-ios/blob/main/cyrillic/models/unigram_probs.json"
    click LAT "https://github.com/majbyr/komi-keyboard-ios/blob/main/latin/KeyboardLayouts.swift"
    click LAT "https://github.com/majbyr/komi-keyboard-ios/blob/main/latin/Info.plist"

    %% Click Events - Build & Deployment
    click XCODE "https://github.com/majbyr/komi-keyboard-ios/blob/main/komikeyboard.xcodeproj/project.pbxproj"
    click SCHEMES "https://github.com/majbyr/komi-keyboard-ios/blob/main/komikeyboard.xcodeproj/xcshareddata/xcschemes/mainapp.xcscheme"

    %% Click Events - Host App
    click APPD "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/AppDelegate.swift"
    click SCEND "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/SceneDelegate.swift"
    click VC "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/ViewController.swift"
    click EXTNS "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/Extensions.swift"
    click EXTNS "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/HeaderViewConfigurator.swift"
    click EXTNS "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/MenuStackView.swift"
    click EXTNS "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/TextField.swift"
    click EXTNS "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/UIColor+Extensions.swift"
    click STORY "https://github.com/majbyr/komi-keyboard-ios/tree/main/mainapp/Base.lproj/"
    click STORY "https://github.com/majbyr/komi-keyboard-ios/tree/main/mainapp/kv.lproj/"
    click STORY "https://github.com/majbyr/komi-keyboard-ios/tree/main/mainapp/ru.lproj/"
    click STORY "https://github.com/majbyr/komi-keyboard-ios/tree/main/mainapp/locales/"
    click ASSETS_APP "https://github.com/majbyr/komi-keyboard-ios/tree/main/mainapp/Assets.xcassets/"
    click ASSETS_APP "https://github.com/majbyr/komi-keyboard-ios/blob/main/mainapp/Info.plist"

    %% Click Events - Keyboard Extension
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/KeyRow.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/KeyBase.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/KeyPopup.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/CharacterKey.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/CustomKeyButton.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/InvisibleKey.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/SpecialKey.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/SubcharPopup.swift"
    click UICOMP "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/ToolbarView.swift"
    click KVIEW "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/KeyboardView.swift"
    click KVC "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/KeyboardViewController.swift"
    click HEIGHT "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/KeyboardHeightDetector.swift"
    click PENG "https://github.com/majbyr/komi-keyboard-ios/blob/main/keyboard/PredictionEngine.swift"
    click ASSETS_EXT "https://github.com/majbyr/komi-keyboard-ios/tree/main/keyboard/Assets.xcassets/"

    %% Styles
    classDef ui fill:#BBDEFB,stroke:#1976D2
    classDef data fill:#C8E6C9,stroke:#388E3C
    classDef pipeline fill:#FFE0B2,stroke:#EF6C00
    classDef module fill:#B2EBF2,stroke:#009688
```
