# omar-haidar/androidide architecture

> Architecture diagram of the GitHub repository omar-haidar/androidide, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/omar-haidar/androidide
- Repository: https://github.com/omar-haidar/androidide

## Overview

##### Project type and purpose
- AndroidIDE is a fully offline Android application (an IDE) comprising:
– A user-facing Android app (UI, editor, designer, terminal emulator).
– Numerous reusable libraries (common, shared, sdk-info, xml-inflater, treeview, emulatorview, lexers).
– In-app language-server clients (LSP modules: api, java, xml) talking over JSON-RPC.
– Build tools and services (GradleBuildService, tooling-api modules, eventbus, jsonrpc).
- Purpose: provide code editing, project creation, build/Gradle support, LSP-driven code intelligence, and an integrated terminal on Android.

##### File structure & architectural patterns
- Top-level modules:
– /app: Android app module (Activities, Fragments, Views, ViewModels).
– /common, /shared: core utility & model libraries.
– /emulatorview, /xml-inflater, /treeview, /lexers, /sdk-info: specialized feature libraries.
– /actions: plugin-style registry of editor/build actions.
– /lsp (api, java, xml, models, testing): LSP client stacks.
– /build-tools, /gradle-plugin: bundled CLI libs (eventbus, jsonrpc, tooling-api, google-formatter, javac-services, etc.).
- Architectural patterns:
– Modular monorepo with clear separation of UI, domain services, tooling services, and language tooling.
– MVVM in /app (Activities→ViewModels→Services).
– EventBus for in-app event dispatch (publish–subscribe).
– JSON-RPC channels for LSP and build tooling.
– ShellServer abstraction wrapping Termux/Busybox for executing external binaries.

##### Readme insights
- Lists key features: Gradle, terminal, SDK manager, LSP, UI designer, Git (terminal only).
- Indicates under-development modules (partial LSP/Kotlin, UI Designer).
- Confirms use of GPLv3 and embedded third-party editors (Rosemoe), terminal (Termux), tree view, Java LSP server.

a. Components
1. AndroidIDE App (UI Layer)
– Activities/Fragments/ViewModels/Adapters/Views (code editor, designer UI, file/terminal UI).
2. Common/Shared Libraries
– Utilities: File I/O, JSON, logging, preferences, eventbus, progress management.
3. Actions Registry
– Plugin architecture for build/editor actions (build, run, lint, copy/paste, find, etc.).
4. Shell & Build Service
– ShellServer (Termux-backed); GradleBuildService; ToolingApiServer; eventbus & jsonrpc modules.
5. Language-Server Clients
– LSP API layer; Java LSP client; XML LSP client. Communicates via JSON-RPC.
6. External Binaries & SDK Data
– Bundled aapt2, busybox, gradle-wrapper, tooling-api jars, android.jar, SDK metadata (sdk-info).
7. UI Feature Libraries
– emulatorview (terminal emulator), xml-inflater (layout preview), treeview, lexers.
b. Relationships & interactions
1. UI Layer → ViewModels → Services
– E.g., EditorActivityActionMenu triggers a build action.
2. BuildAction → GradleBuildService → ToolingApiServerImpl → Tooling API modules → Gradle Daemon (local process).
3. EditorCompletion → LSP API → JSONRpc (lsp/api, jsonrpc) → JavaLanguageServer / XMLLanguageServer (in-app service).
4. TerminalActivity → ShellServer → JNI/Busybox binaries.
6. Common & Shared libs support cross-cutting (% logging, preferences, file search, progress).
c. Key patterns & principles
- Layered modular architecture: clear UI/domain/tooling separation.
- Plugin architecture for actions (ActionsRegistry).
- MVVM for UI; EventBus for decoupled messaging.
- JSON-RPC for language/build server communication.
- Shell abstraction for invoking native binaries on Android.
d. Technologies & frameworks
- Android SDK (API≥26)
- Gradle multi-module
- Kotlin & Java
- Rosemoe’s Sora code editor widget
- GreenRobot EventBus
- LSP4J / custom JSON-RPC
- Termux & Busybox binaries

##### Essential elements
- Action path is traceable end-to-end (e.g., “RunActionMenu → GradleBuildService → Gradle Daemon → Build Artifacts”).
- JSON-RPC channels between App and LSP or Tooling API.
- Don’t over-crowd: group related feature libs (emulatorview, xml-inflater, treeview, lexers) under “UI Feature Libraries.”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% AndroidIDE App Core
    subgraph "AndroidIDE App" 
        direction TB
        subgraph "UI & ViewModels"
            direction TB
            AndroidApp["Activities/Fragments\n(code editor, designer, terminal)"]:::ui
            VM["ViewModels"]:::ui
        end
        subgraph "Services Layer"
            direction TB
            BS["GradleBuildService"]:::services
            LSP["LSP Clients"]:::services
            SH["ShellServer"]:::services
        end
    end

    %% External Processes & Binaries
    subgraph "External Processes & Binaries"
        direction TB
        GradleDaemon["Gradle Daemon"]:::external
        JavaLS["Java LSP Server"]:::external
        XMLLS["XML LSP Server"]:::external
        ShellBinaries["Termux/Busybox Binaries"]:::external
    end

    %% Utility & Feature Libraries
    subgraph "Utility Libraries" 
        direction TB
        commonLib["Common Library"]:::utils
        sharedLib["Shared Library"]:::utils
        EventBusCore["EventBus Core"]:::utils
        EventBusEvents["EventBus Events"]:::utils
    end

    subgraph "UI Feature Libraries"
        direction TB
        emulatorview["Terminal Emulator View"]:::ui
        xmlInflater["XML Inflater"]:::ui
        treeviewLib["Tree View"]:::ui
        lexers["Language Lexers"]:::ui
    end

    %% Build Tools Modules
    subgraph "Build Tools Modules"
        direction TB
        JSONRPC["JSON-RPC Core"]:::utils
        JavacServices["Javac Services"]:::utils
        GoogleFormat["Google-Formatter"]:::utils
        BuilderModel["Project-Model Builder"]:::utils
        FuzzySearch["Fuzzy-Search"]:::utils
        XMLDOM["XML DOM Utilities"]:::utils
        XMLFormatter["XML-Formatter"]:::utils
        ToolingAPIImpl["Tooling API Server Impl"]:::services
    end

    %% Actions & Gradle Plugin
    subgraph "Actions & Plugins"
        direction TB
        actionsReg["Actions Registry"]:::utils
        GradlePlugin["Gradle Plugin CLI"]:::utils
    end

    %% LSP Modules
    subgraph "LSP Client Modules"
        direction TB
        LSPAPI["LSP API Client"]:::services
        LSJava["Java LSP Client"]:::services
        LSXML["XML LSP Client"]:::services
        LSPModels["LSP Models"]:::utils
        LSPTesting["LSP Testing Utils"]:::utils
    end

    %% SDK Info
    SDKInfo["Android SDK Metadata"]:::utils

    %% EventBus Node
    EventBus["EventBus"]:::utils

    %% Connections
    AndroidApp -->|binds to| VM
    VM -->|invokes| BS
    VM -->|invokes| LSP
    VM -->|invokes| SH

    BS -->|uses| ToolingAPIImpl
    ToolingAPIImpl -- JSON-RPC --> GradleDaemon
    LSP -->|JSON-RPC| JSONRPC
    JSONRPC --> JavaLS
    JSONRPC --> XMLLS
    SH -->|executes| ShellBinaries

    %% EventBus interactions
    EventBusCore --> EventBus
    BS -->|publishes/subscribes| EventBus
    LSP -->|publishes/subscribes| EventBus
    AndroidApp -->|listens| EventBus

    %% Dependencies on Libraries
    AndroidApp --> commonLib
    AndroidApp --> sharedLib
    BS --> commonLib
    LSP --> commonLib
    actionsReg --> commonLib
    actionsReg --> sharedLib
    AndroidApp --> actionsReg
    AndroidApp --> emulatorview
    AndroidApp --> xmlInflater
    AndroidApp --> treeviewLib
    AndroidApp --> lexers
    BS --> JavacServices
    BS --> GoogleFormat
    BS --> BuilderModel
    BS --> FuzzySearch
    BS --> XMLDOM
    BS --> XMLFormatter
    BS --> GradlePlugin
    LSP --> LSPAPI
    LSP --> LSJava
    LSP --> LSXML
    LSP --> LSPModels
    LSP --> LSPTesting
    AndroidApp --> SDKInfo

    %% Click Events
    click AndroidApp "https://github.com/omar-haidar/androidide/tree/main/app/"
    click commonLib "https://github.com/omar-haidar/androidide/tree/main/common/"
    click sharedLib "https://github.com/omar-haidar/androidide/tree/main/shared/"
    click actionsReg "https://github.com/omar-haidar/androidide/tree/main/actions/"
    click SH "https://github.com/omar-haidar/androidide/blob/main/common/src/main/java/com/itsaky/androidide/shell/ShellServer.java"
    click BS "https://github.com/omar-haidar/androidide/blob/main/app/src/main/java/com/itsaky/androidide/services/GradleBuildService.java"
    click ToolingAPIImpl "https://github.com/omar-haidar/androidide/blob/main/build-tools/tooling-api-impl/src/main/java/com/itsaky/androidide/tooling/impl/ToolingApiServerImpl.kt"
    click JSONRPC "https://github.com/omar-haidar/androidide/tree/main/build-tools/jsonrpc/"
    click EventBusCore "https://github.com/omar-haidar/androidide/tree/main/build-tools/eventbus/"
    click EventBusEvents "https://github.com/omar-haidar/androidide/tree/main/build-tools/eventbus-events/"
    click JavacServices "https://github.com/omar-haidar/androidide/tree/main/build-tools/javac-services/"
    click GoogleFormat "https://github.com/omar-haidar/androidide/tree/main/build-tools/google-java-format/"
    click BuilderModel "https://github.com/omar-haidar/androidide/tree/main/build-tools/builder-model-impl/"
    click FuzzySearch "https://github.com/omar-haidar/androidide/tree/main/build-tools/fuzzysearch/"
    click XMLDOM "https://github.com/omar-haidar/androidide/tree/main/build-tools/xml-dom/"
    click XMLFormatter "https://github.com/omar-haidar/androidide/tree/main/build-tools/xml-formatter/"
    click SDKInfo "https://github.com/omar-haidar/androidide/tree/main/sdk-info/"
    click emulatorview "https://github.com/omar-haidar/androidide/tree/main/emulatorview/"
    click xmlInflater "https://github.com/omar-haidar/androidide/tree/main/xml-inflater/"
    click treeviewLib "https://github.com/omar-haidar/androidide/tree/main/treeview/"
    click lexers "https://github.com/omar-haidar/androidide/tree/main/lexers/"
    click LSPAPI "https://github.com/omar-haidar/androidide/tree/main/lsp/api/"
    click LSJava "https://github.com/omar-haidar/androidide/tree/main/lsp/java/"
    click LSXML "https://github.com/omar-haidar/androidide/tree/main/lsp/xml/"
    click LSPModels "https://github.com/omar-haidar/androidide/tree/main/lsp/models/"
    click LSPTesting "https://github.com/omar-haidar/androidide/tree/main/lsp/testing/"
    click GradlePlugin "https://github.com/omar-haidar/androidide/tree/main/gradle-plugin/"

    %% Styles
    classDef ui fill:#cfe2f3,stroke:#0366d6,color:#0366d6
    classDef services fill:#d9ead3,stroke:#27632a,color:#27632a
    classDef external fill:#fce5cd,stroke:#b45f06,color:#b45f06
    classDef utils fill:#eeeeee,stroke:#666666,color:#333333
```
