How alexays/waybar works
Project Type and Purpose
• Type: Native desktop application (not a web service), with a plugin-style modular architecture.
• Purpose: Display status information (workspaces, battery, network, media, custom scripts, etc.) in a Wayland bar.
a. Core Application (src/main.cpp, AModule/IModule, factory, bar, client, group)
b. Configuration Loader (config.cpp + resources/config.jsonc)
c. Module Plugins (src/modules + include/modules):
– Compositor modules (sway, river, hyprland, dwl, niri, wlr) via IPC/protocols (protocol/*.xml)
– System modules (battery, cpu, memory, network, pulseaudio, mpd, etc.)
– Custom modules (user scripts, CFFI)
d. Rendering Layer (GTK layer shell via gtkmm3, CSS styling in resources/style.css, waybar_icons.gresource.xml)
e. IPC/Protocol Layer (DBus-menu, Status-Notifier, compositor IPC)
f. Utility Libraries (util/*: JSON, threading, signal handling, backends)
g. External Services & System Interfaces:
– Wayland compositor (Sway, River, Hyprland, etc.)
– DBus (UPower, NetworkManager, PulseAudio, SystemD, etc.)
– MPD, sndio, WirePlumber, evdev, pipewire
1. On startup, Core reads config → Configuration Loader
2. Core passes config to Factory → instantiates requested Module Plugins
3. Each Module:
– Registers with Core’s Bar/Group for layout
– Uses Utility Libraries to fetch data (JSON parser, Backend APIs)
– Listens/subscribes via IPC (DBus, compositor socket) or polls system APIs
4. Module emits updates → Core pushes to Rendering Layer (GTK) → displayed on screen
5. User events (clicks, scrolls) captured by Rendering Layer → routed back to Module or Core → possibly send commands via compositor IPC or DBus
Architectural Patterns and Principles
• Plugin-style modularity: IModule/AModule interface, Factory pattern for instantiation
• Separation of concerns:
– Core (lifecycle, layout) vs. Modules (data acquisition) vs. Renderer (UI)
– Util layer isolates common code (JSON, signals, threads)
– Protocol definitions in XML under protocol/ kept separate from code
• Build & Deployment: Meson subprojects for third-party libs; Dockerfiles and Nix flake for reproducible builds
Technologies & Frameworks
• C++17, gtkmm3 (UI), JSONCpp (config & data), libsigc++ (signals), fmt/spdlog (logging), Wayland protocols
• IPC: DBus-menu / Status-Notifier, compositor-specific sockets (Sway IPC, River IPC, etc.)
• Build: Meson, Ninja, scdoc (man pages), Docker, Nix