How albertlauncher/albert works
Project Type and Purpose
• Albert is a desktop-agnostic, plugin-based keyboard launcher written in C++/Qt.
• It consists of a core engine (query processing, plugin management), a Qt front end (UI), and many extension plugins.
Top-Level Architectural Components
a. Frontend (Qt GUI & IPC)
• Directory: src/frontend, plus Qt UI files under src/settings.
• Responsibilities: capture user keystrokes, display results, forward queries.
b. Core Engine
• Subsystems:
– Query Engine (src/query): processes queries, orchestrates handlers.
– Plugin Framework (src/plugin, include/albert/*): loads plugins, manages metadata, resolves dependencies.
– RPC Server (src/app/rpcserver): optional inter-process control.
– Telemetry & Logging (src/app/telemetry*, include/albert/logging.h).
c. Extensions (Plugins)
• Directory: plugins/*
• Each plugin implements Extension, QueryHandler or TriggerQueryHandler interfaces.
• Loaded at runtime by PluginLoader/PluginProvider.
d. Platform Abstraction
• Directory: src/platform
e. Utilities & Shared Models
• Directory: src/util, src/common: shared types (Item, Action), algorithms (Levenshtein), indexers.
f. Settings UI
• Directory: src/settings: MVC pattern for preferences dialogs.
g. External Services & Resources
• Telemetry endpoint (optional).
h. Build & Distribution
• CMake (CMakeLists.txt, cmake/), Dockerfiles (.docker/), Flatpak, macOS bundles (dist/).
Relationships & Data Flow
• User input → Frontend
• Frontend emits query → Core Query Engine
• Query Engine → Global/Trigger/Fallback handlers (in core & plugins)
• Handlers consult Plugin instances → return Item/Action objects
• Query Engine ranks Items → returns to Frontend
• Frontend renders list → User selects → Action invoked (via Core or Plugin)
• Core dispatches telemetry/logs, writes usage DB
Architectural Patterns & Principles
• Plugin-based architecture: loose coupling between core and extension code.
• Registry/Factory pattern for plugin discovery (ExtensionRegistry, PluginRegistry).
• Separation of concerns: Frontend vs. Core vs. Platform vs. Plugins.
• MVC in settings UI.
• Use of asynchronous execution (BackgroundExecutor) to avoid blocking UI.
• Clear component names (use the same terms: Frontend, QueryEngine, PluginLoader, ExtensionPlugin, PlatformAbstraction, TelemetryProvider).
• Annotations for major technologies: “Qt5/6”, “C++17”, “CMake”, “Docker/Flatpak”.