This commit adds a nix-darwin module for komorebi and komorebi-bar,
exposed via `darwinModules.default` and `darwinModules.komorebi`.
The module provides the following options:
* `services.komorebi.enable`: enables the komorebi launchd agent
* `services.komorebi.config`: typed Nix configuration (defaults to example
config)
* `services.komorebi.configFile`: path to a JSON config file (validated
against schema)
* `services.komorebi.logLevel`: log verbosity level
* `services.komorebi.applicationSpecificConfiguration`: fetches
app-specific configs from remote GitHub repositories at pinned
revisions
* `services.komorebi-bar.enable`: enables komorebi-bar launchd agent(s)
* `services.komorebi-bar.bars.<name>`: named bar instances, one per
monitor
* `services.komorebi-bar.bars.<name>.config`: typed Nix configuration per
bar
* `services.komorebi-bar.bars.<name>.configFile`: path to a JSON config
file per bar
The applicationSpecificConfiguration option supports multiple sources,
allowing users to combine the upstream default from
LGUG2Z/komorebi-application-specific-configuration with their own
personal overrides from other repositories.
When configFile is specified, the JSON file is validated against the
flake's version of the schema before being passed to the binary.
A new flake check, `darwin-module-validation`, validates the module
options and exercises the configFile validation against the example
JSON files loaded into `komorebic` for the `quickstart` cmd.
This commit adds NixOS module option generation for komorebi and
komorebi-bar configurations, along with a nix and JSONSchema validation
test harness that runs as part of `nix flake check`.
`schemars-nixgen` (same as `schemars-docgen`, not sure if I'm gonna
release this...) generates strongly-typed Nix option definitions from
the generated JSONSchema files, allowing users to write type-checked Nix
configurations that map directly to the config files.
This will eventually be plugged into a nix-darwin module which I have
yet to start writing.
This commit improves the scrolling layout animation by dynamically
choosing the window hiding position based on which side of the viewport
the window is scrolling out of.
Previously, all hidden windows went to the same corner (based on the
global window_hiding_position setting), causing jarring animations when
windows scrolled back into view from the opposite side of the screen.
Now windows scrolling off the left edge hide to the bottom-left, and
windows scrolling off the right edge hide to the bottom-right. This
ensures windows animate back in from the side they scrolled out to.
This commit prevents the event channel from being flooded with
AXWindowMoved and AXWindowResized notifications during window
animations.
Previously, every frame of an animation would trigger macOS
accessibility notifications, which were then converted to MoveEnd and
ResizeEnd events. With a 60 FPS animation, this meant ~15 events per
window per animation, quickly filling the bounded channel (capacity 20)
and causing "channel is full; dropping notification" warnings.
The fix removes kAXWindowMovedNotification and kAXWindowResizedNotification
from the window's observer in pre_render() before the animation starts,
then restores them in post_render() after the animation completes. This
stops notifications at the source rather than filtering them later.
This commit optimizes the objc2 dependency tree by disabling default
features and enabling only the minimal set of features actually used
by the codebase. This reduces compilation time and dependency bloat.
I was meant to do this earlier but during the initial implementation it was
easier to just pull in everything. Now that we are getting ready for a public
release it's time to improve on this.
I ended up:
* Removing unused direct dependencies:
- objc2-core-services
- objc2-core-video
* Setting `default-features = false` on all objc2 crates and added only
the specific features required for the types and methods used
* Updating objc2, objc2-app-kit, objc2-foundation,
objc2-application-services, objc2-core-foundation, objc2-core-graphics,
and objc2-quartz-core with minimal feature sets
After all those changes, the following transitive dependencies are no longer
pulled in: objc2-metal, objc2-core-image, objc2-core-data, objc2-cloud-kit,
objc2-core-text, and loads of unused Foundation/AppKit class bindings.
Some before and after numbers:
| Metric | Before | After | Change |
|---------------------------------|---------|---------|----------|
| objc2 dep lines (komorebi) | 84 | 50 | -40.5% |
| objc2 dep lines (komorebi-bar) | 91 | 59 | -35.2% |
| Dependency tree (komorebi) | 973 | 917 | -5.8% |
| Dependency tree (komorebi-bar) | 1181 | 1131 | -4.2% |
| Clean build time | 3m 05s | 2m 21s | -23.8% |
The almost 24% reduction in clean build time is a big win!
This commit adds window movement animations to komorebi for macOS,
maintaining configuration API compatibility with komorebi for Windows.
The animation system is adapted from the Windows implementation but uses
macOS-specific APIs for screen update batching and accessibility
control, and borrows heavily from the implementation details of
animations in rift.
In order to have decent performance, there are some calls to private
APIS. For this reason, the animation feature will be marked as "UNSAFE".
UNSAFE features should be expected to break between major operating
system updates, and depending on which way I want to go, may only
support one major macOS version at a time (i.e. they will not have a
backwards compatibility guarantee with previous versions of macOS).
This currently look awful when used with the Scrolling layout, but looks
relatively good with other layouts. As with Windows, the animations
when two windows of very different sizes change position aren't great.
Some high level notes on the implementation:
* Uses the private SkyLight framework for screen update batching via
SLSDisableUpdate/SLSReenableUpdate - these APIs prevent visual flicker
by compositing all window position changes at once rather than updating
each window individually during layout operations
* AnimationEngine runs animations in background threads with frame-based
timing, supporting cancellation when new animations are triggered for
the same window
* MovementRenderDispatcher implements the RenderDispatcher trait to
interpolate window positions using configurable easing functions
* All 30+ easing styles from the Windows implementation are supported,
including standard CSS-style functions and CubicBezier for custom curves
* Enhanced User Interface (AXEnhancedUserInterface) is temporarily
disabled during window positioning operations for better performance
* The Transparency animation prefix is not supported on macOS as there
is no equivalent to the Win32 transparency feature
This feature is off-by-default and can be enabled in the static config
or via komorebic commands (animation, animation-duration, animation-fps,
animation-style).
This commit ensures that NSWorkspaceDidActivateApplicationNotification
and NSWorkspaceDidDeactivateApplicationNotification get emitted not just
for the loginwindow but for all apps with a valid name.
This helps us to catch events from windows which don't emit
AXWindowCreated consistently like Mail, Calendar, etc.
Additionally, if a window has been closed with cmd+w but the application
is still active, the border manager will pick a window container to mark
as the new focused window container, and call window.focus() on the
selected window to align the focus with the focused border color.
This commit addresses a bug that was introduced/made visible in a5cbb4d.
The nixpkgs flake input (tracking nixpkgs-unstable) was updated from
github:NixOS/nixpkgs/f6b44b2401525650256b977063dbcf830f762369 to
github:NixOS/nixpkgs/0d59e0290eefe0f12512043842d7096c4070f30e and as a
result the version of AppKit being linked against jumped from
2022.44.149 to 2487.50.124.
Builds prior to a5cbb4d were building against macOS 13 (Ventura) era
frameworks due to the use of compatability stubs in nixpkgs, whereas the
nixpkgs-unstable update in a5cbb4d now links against the actual running
system's framework versions (in this case, macOS 15).
With github:NixOS/nixpkgs/f6b44b2401525650256b977063dbcf830f762369:
```
❯ otool -L target/debug/komorebi | grep -E 'AppKit|Foundation|CoreFoundation|libSystem'
/System/Library/Frameworks/CoreFoundation.framework/Versions/A/CoreFoundation (compatibility version 150.0.0, current version 1775.118.101)
/System/Library/Frameworks/AppKit.framework/Versions/C/AppKit (compatibility version 45.0.0, current version 2022.44.149)
/System/Library/Frameworks/Foundation.framework/Versions/C/Foundation (compatibility version 300.0.0, current version 1775.118.101)
/usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1292.100.5)
```
With github:NixOS/nixpkgs/0d59e0290eefe0f12512043842d7096c4070f30e
```
❯ otool -L target/debug/komorebi | grep -E 'AppKit|Foundation|CoreFoundation|libSystem'
/System/Library/Frameworks/CoreFoundation.framework/Versions/A/CoreFoundation (compatibility version 150.0.0, current version 2420.0.0)
/System/Library/Frameworks/AppKit.framework/Versions/C/AppKit (compatibility version 45.0.0, current version 2487.50.124)
/System/Library/Frameworks/Foundation.framework/Versions/C/Foundation (compatibility version 300.0.0, current version 2420.0.0)
/usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1345.100.2)
```
Somewhere between macOS 13 and macOS 15 Apple added stricter
thread-safety assertions in the AppKit framework, which resulted in the
calls to `NSWindow::close()` in border.rs to crash on an assertion
failure ("transaction must be valid")
```
* thread #9, stop reason = EXC_BREAKPOINT (code=1, subcode=0x19e543cc0)
frame #0: 0x000000019e543cc0 AppKit`-[NSWMWindowCoordinator performTransactionUsingBlock:] + 752
AppKit`-[NSWMWindowCoordinator performTransactionUsingBlock:]:
-> 0x19e543cc0 <+752>: brk #0x1
0x19e543cc4 <+756>: adrp x0, 827
0x19e543cc8 <+760>: add x0, x0, #0x4ba ; "assertion failure: transaction must be valid"
0x19e543ccc <+764>: bl 0x19e6eb58c ; symbol stub for: _os_crash
Target 0: (komorebi) stopped.
(lldb) bt
* thread #9, stop reason = EXC_BREAKPOINT (code=1, subcode=0x19e543cc0)
* frame #0: 0x000000019e543cc0 AppKit`-[NSWMWindowCoordinator performTransactionUsingBlock:] + 752
frame #1: 0x000000019e372a00 AppKit`-[NSWindow(NSWMWindowManagement) window:didUpdateWithChangedProperties:] + 104
frame #2: 0x000000027a366720 WindowManagement`-[_WMWindow performUpdatesUsingBlock:] + 100
frame #3: 0x000000027a365714 WindowManagement`-[_WMWindow applyTags😷] + 712
frame #4: 0x000000027a365cf8 WindowManagement`-[_WMWindow setVisible:] + 84
frame #5: 0x000000019d91b064 AppKit`-[NSWindow _setVisible:] + 268
frame #6: 0x000000019da16df0 AppKit`-[NSWindow _doWindowWillBecomeHidden] + 88
frame #7: 0x000000019e3662e0 AppKit`-[NSWindow _reallyDoOrderWindowOutRelativeTo:] + 160
frame #8: 0x000000019e366794 AppKit`-[NSWindow _reallyDoOrderWindow:] + 80
frame #9: 0x000000019e3669e4 AppKit`-[NSWindow _doOrderWindow:] + 264
frame #10: 0x000000019e360c84 AppKit`-[NSWindow _finishClosingWindow] + 444
frame #11: 0x000000019daa6cc8 AppKit`-[NSWindow _close] + 380
frame #12: 0x0000000100c3380c komorebi`_$LT$$LP$$RP$$u20$as$u20$objc2..encode..EncodeArguments$GT$::__invoke::h1be54296556f108b(msg_send_fn=(libobjc.A.dylib`objc_msgSend), receiver=0x0000000132e09ea0, sel=Sel @ 0x0000000170b58e38, (null)=<unavailable>) at encode.rs:433:26
frame #13: 0x0000000100c30f84 komorebi`objc2::runtime::message_receiver::msg_send_primitive::send::h0de1c4d240a2223f(receiver=0x0000000132e09ea0, sel=Sel @ 0x0000000170b58e78, args=<unavailable>) at message_receiver.rs:172:18
frame #14: 0x0000000100c2e904 komorebi`objc2::runtime::message_receiver::MessageReceiver::send_message::h86c04ca17a2b6faf(self=0x0000000132e09ea0, sel=Sel @ 0x0000000170b58ed0, args=<unavailable>) at message_receiver.rs:432:38
frame #15: 0x0000000100b9b1bc komorebi`_$LT$MethodFamily$u20$as$u20$objc2..__macro_helpers..msg_send_retained..MsgSend$LT$Receiver$C$Return$GT$$GT$::send_message::h6cb30a52e558d44c(receiver=0x0000000132e09ea0, sel=Sel @ 0x0000000170b58f48, args=<unavailable>) at msg_send_retained.rs:35:28
frame #16: 0x0000000100ba14b8 komorebi`objc2_app_kit::generated::__NSWindow::NSWindow::close::h34bc4ef6fc286b23(self=0x0000000132e09ea0) at extern_methods.rs:266:14
frame #17: 0x00000001002b22f0 komorebi`komorebi::border_manager::border::Border::destroy::_$u7b$$u7b$closure$u7d$$u7d$::h61d54fa62ea0b107((null)=AutoreleasePool @ 0x0000000170b58fb8) at border.rs:161:35
```
To fix this, this commit ensures that the call to `NSWindow::close()` is
made on the main thread using `DispatchQueue::main().exec_sync()`.
For reasons unknown, CFRunLoop::run_in_mode no longer processes
NSApplication events on Tahoe.
Display callbacks seem to now be more tightly coupled to the
NSApplication event loop, so we initialize NSApplication with
sharedApplication as early as possible to establish a window server
connection, and then in our main loop we poll app.nextEvent every 0.1s
for NSApplication events, which is where the
DisplayReconfigurationListener callback will finally kick in again.
This commit was originally contributed as faed6ec by LGUG2Z/komorebi by
@CtByte
This commit changes the way how the default interface and network
activity is loaded by spawning a new thread on each request. This way
the main thread is not blocked by this process.
There has been instances where getting the default interface blocked the
egui ui thread, resulting in a frozen bar.
This commit was originally contributed as 31c969f to LGUG2Z/komorebi by
@alex-ds13
- When promoting a container it is using the
`remove_focused_container()` and `insert_container_at_idx` functions
which will remove the focused container size from `resize_dimensions`
and then add the new container with size `None`. Then it was adding
the previously stored size of the main container back to the first
one. However this would result in at least 3 issues:
1. We were removing the size from index 0, however when inserting it
back on the primary_idx we might not add it to index 0, specially
now that there could be locked containers so if container 0 is
locked we would be adding it to the next container, which would
result in the main container having no size information which
would result in a recalculation on the next update and it would
revert back to default, so if a user had resized their containers
that information would be lost.
2. We were removing the size from index 0. Then on
`remove_focused_container` it would remove the size from the
focused container index, but since we had already removed one
size from the `resize_dimensions` that index would no longer
match the actual focused container, so once again we would be
losing information.
3. Since we were removing the size of the focused container idx from
`resize_dimensions` (albeit the wrong one as stated above), this
would mean that the container that moved to that position would
have no resize information so it would show up as if the main
container was taking up half width of the area, ignoring any user
resize, until the next workspace update was triggered.
- This commit completely ignores the `resize_dimensions` since promoting
a container simply means moving one container from one position to the
main one (usually index 0) and then shift all the rest to the "right".
The existing `resize_dimensions` should be kept untouched. To do this
we use the functions `remove_respecting_locks` and
`insert_respecting_locks` on the containers themselves, which simply
move the container and shifts the others which is precisely what we
want.
This commit adds a new workspace crate, version, which is consumed by
komorebi and komorebic.
If either of those binaries are being built by
the Nix Flake, the git rev info will be pulled from inputs.self.rev
instead of querying the git repo, because the git files are not passed
to the derivation.
The build.rs for the version crate decides if the build is happening by
querying the shadow-rs build output for BRANCH, which will always be
empty when a "nix build" is running.
Cargo builds will use the standard git information retrieval mechanisms
in shadow-rs.
The information in both cases is exposed as version::LONG_VERSION, and
passed to clap as the string to return when either binary is called with
the --version flag.
This commit makes the komorebic promote-swap command reversible by
storing the previous container index in the Workspace state.
If the current container index is the same as the layout's primary
index, and there is a previous promotion swap container index available,
the two containers at those indices will be swapped, effectively making
a second call to promote-swap an undo.
This commit adds a new SocketMessage variant PromoteSwap and
corresponding komorebic promote-swap command.
PromoteSwap will also promote the focused window container to the
largest tile in the layout, but instead of removing the focused
container x from the Ring and inserting it into position 0, possibly
changing the positions of other windows between 0 and x, the indices x
and 0 in the Ring will be swapped directly.
Implements the equivalent of
https://github.com/LGUG2Z/komorebi/commit/18ee6678962bc31a39ce59fd4a1f6a9ee752ac5c
This commit makes the `stack-all` command simpler, by simply making a
`VecDeque` with all the tiled windows of the workspace, then it creates
a new container with that `VecDeque` and changes the workspace
containers to be just this new container which has all the windows in
it.
Then and only then do we focus and show the previously focused window
and hide all the rest.
This way we don't have a bunch of `FocusChange`/`Cloak`/`Uncloak` events
coming up which might conflict with each other when the user has
transparency and animations enabled.
With this commit, there will only be one focus event for the focused
window and one cloak event for each of the other windows.
This commit adds visual feedback in the form of a ghost tile for
preselections made by the preselect-direction command.
A container with the id "PRESELECT" will be added to the workspace, and
replaced when the next manage-able window is spawned.
A new command, cancel-preselect has been added to remove both the
preselection index and the ghost tile if the user changes their mind.
This commit expands the hack introduced in 4d25d4e which deals with
inconsistent window titles returned by apps from different macOS APIs.
The same issue that was happening with Activity Monitor was also
happening with Google Chrome, so this hack has been updated to a more
general "contains" check.
This commit adds a new feature to preselect the direction of the next
spawned window with a corresponding komorebic preselect-direction
command which takes an OperationDirection.
If the OperationDirection is valid from the current position, it will be
stored in the Workspace state, and then read, applied, and deleted when
the next manage-able window is spawned.
I was running komorebi on a MacBook Pro today and ended up quite quickly
being able to reproduce the ws switching loops that I thought I had
fixed (well, I still can't reproduce them on my Mac Mini).
This commit adds an additional cooldown period of 1s to
workspace_reconciliator::send_notification, which seems to do the trick
for me on the MacBook Pro.
This commit makes some small tweaks to account for the hiding and
showing of partially visible windows on the Scrolling layout.
This can happen when resize dimensions have been applied which leaves
only a certain percentage of the window within the work area.
If a window is only partially within the work area, the call to hide
will silently fail.
In order to deal with this there is some jank added when hiding
workspaces and updating workspaces to see if we are leaving a Scrolling
workspace with a partially-visible window, and if we are, to reposition
that window to be fully on within the work area before hiding it.
This commit makes a small improvement to the Scrolling layout by hiding
windows to which layouts which are not contained within the horizontal
bounds of the work area would otherwise be applied.
This should also allow this layout to now be useable on configurations
using multiple monitors.