[FEAT]: Use Autohotkey v2 by default

[sitiom]

Is your feature request related to a problem? Please describe. Since Autohotkey v2 has reached stable, it might be a good time to migrate completely to v2.

Describe the solution you'd like

Make komorebi use AutoHotkey v2 by default. To do that:

• Migrate the sample config, helper library, and ahk-asc to v2
• Generate v2 syntax by default. For compatibility with v1, add a flag in the ahk-library and ahk-asc commands to generate v1 syntax instead.
• Merge $Env:KOMOREBI_AHK_V1_EXE and $Env:KOMOREBI_AHK_V2_EXE to a single $Env:KOMOREBI_AHK_EXE (either v1 or v2).
• Remove .ahk2 and just have a single komorebi.ahk file (either v1 or v2). Autohotkey v2 has a launcher script where it can detect the version of the running script and run the appropriate interpreter for it. The behavior can be configured in the settings: It would be good for komorebi to make use of it.

Describe alternatives you've considered None.

Additional context Related to #10

[LGUG2Z]

There are some significant changes in AHK2 syntax which require commands to Run and RunWait to be surrounded by single (or maybe double?) quotes. Unfortunately I have been unable to find a way to do string interpolation in AHK2 (eg. command ${arg} --flag ${flag_arg}). Without this, I can't see a way to generate (or even have) an AHK v2 library for komorebic.

For now new users should continue to install AHK v1.1 from the Scoop versions bucket if they want to play around with the sample configurations in this repo.

I will be traveling for most of this month (without a Windows laptop) so I won't be able to do much coding, but if someone can figure out how to handle string interpolation (in any position, not just prepending or appending) in AHK v2, please share the details in this issue.

[sitiom]

From the docs:

Retrieving the contents of variables: To include the contents of a variable in a string, use concatenation or Format. For example:

MsgBox "The value of Var is " . Var . "."
MsgBox "The value in the variable named Var is " Var "."
MsgBox Format("Var has the value {1}.", Var)

Sub-expressions can be combined with strings in the same way. For example:

MsgBox("The sum of X and Y is " . (X + Y))

[LGUG2Z]

I've been able to use the format AHK fn with variadic args collected into an array to update the code here:

https://github.com/LGUG2Z/komorebi/blob/master/derive-ahk/src/lib.rs#L151

However, this doesn't work consistently, and it completely falls apart when generating trying to generate library functions for commands that require flags:

https://github.com/LGUG2Z/komorebi/blob/master/derive-ahk/src/lib.rs#L132

I have considered just dropping the library altogether and providing a single wrapper command like this:

Komorebi(cmd) {
  RunWait(format("komorebic.exe {}", cmd), , "Hide")
}

; usage
Komorebi("window-hiding-behaviour minimize")

; Change the focused window, Alt + Vim direction keys
!h::
{
  Komorebi("focus left")
}

This works well enough, however when running with an ahk2 interpreter, the focus commands produce access denied errors in komorebi which I am unable to reproduce with either ahk1.1 or just by running the commands in the terminal:

2023-01-19T15:11:13.688842Z ERROR process_command{FocusWindow(Right)}:focus_container_in_direction{direction=Right}: komorebi::window: could not set as foreground window, but continuing execution of focus(): The operation completed successfully. (0x00000000)
2023-01-19T15:11:13.689414Z ERROR komorebi::process_command: Access is denied. (0x80070005)

Is anyone else using ahk2 experiencing this issue when trying to change window focus?

[sitiom]

Here's a minimum repro script:

#Requires AutoHotkey v2.0.2
#SingleInstance Force

Komorebi(cmd) {
    RunWait(format("komorebic.exe {}", cmd), , "Hide")
}

!h::
{
  Komorebi("focus left")
}

And it seems to work fine.

However, this doesn't work consistently, and it completely falls apart when generating trying to generate library functions for commands that require flags:

master/derive-ahk/src/lib.rs#L132

You also might want to consider using normal string concatenation instead. See https://github.com/lazuee/dotfiles/blob/1b9a5ab3de5c4b0b77527d36d8b58080fc35fd7a/config/komorebi/komorebic.lib.ahk

@LGUG2Z Can you reopen this issue? I'd really like to have AHKv2 support for library helpers.

[LGUG2Z]

Reopening this after some discussion on Discord

The steps moving forward:

• [ ] ~~The derive-ahk crate will be deprecated, both because of the difficulty in updating the syn dependency and because I'm not able to wrangle the raw Rust tokens into the syntax required for v2~~
• [x] @lazuee has done a great job of writing an AHKv2 library by hand, which if they have no objections, we'll bring into this repo
• [ ] ~~In the future new komorebic commands should have wrappers manually added to this file~~
• [x] The komorebic ahk-asc command will be updated to emit a file in the AHKv2 from the input YAML(s)
• [ ] A simpler wrapper library will also be made available at the project root for users who don't have a dependency on the previous AHKv1 library format
• [x] Readme section will be added explaining how to use these libraries with AHK

[sitiom]

Might as well bring back komorebi.sample.ahk for AHKv2

[NormTurtle]

so are we losing whkd ? again ???

[LGUG2Z]

so are we losing whkd ? again ???

Don't worry, this is not the case. This PR is just to add the same level of support for AHKv2 that users previously had with AHKv1.

[LGUG2Z]

This is in the master branch now and will be part of the upcoming 0.1.16 release. I'm planning on making an AHK quickstart video to go along with it as well. 🚀

[NormTurtle]

so what about win + keys?!

[sitiom]

so what about win + keys?!

You can use the Win key as a keybinding in AHK

[llinfeng]

Hi folks, I'm new to komorebi and have been using my decade-old AHK v1 script to manage the window-layout until now. I'd prefer to stay with AHK v1 for the time being.

What would be a good pointer for AHK v1 configuration? I tried to search around and only found this commit (acc119a) through this search, with keyboard "ahk1".

Will the ahk filies files associated with commit acc119a work for komorebi in its current state? There are a good number of them, including komorebi.generated.ahk, komorebi.sample.ahk, and komorebic.lib.ahk. In particular, will these old AHK v1 config still work for the current komorebi executable, which I installed using the following lines as suggested in the readme:

winget install LGUG2Z.komorebi
winget install LGUG2Z.whkd

Thx!

[LGUG2Z]

I would recommend using this as your starting point now: https://lgug2z.github.io/komorebi/common-workflows/autohotkey.html

Just rewrite this function to be compatible with AHKv1:

Komorebic(cmd) {
    RunWait(format("komorebic.exe {}", cmd), , "Hide")
}

Then you call it with the same arguments that you'd call the regular komorebic commands as listed here: https://lgug2z.github.io/komorebi/cli/quickstart.html

If you set the KOMOREBI_AHK_EXE variable to the path to your AHKv1 executable you should be good to go.

[llinfeng]

Update: for AHK 1, keeping the following function somewhere before calling Komorebic("CLI-arguments") suffices:

Komorebic(cmd) {
    RunWait, % "komorebic.exe " cmd,, Hide
}

[sitiom]

Perhaps it would be a better investment to switch to AHK v2 😅; it would only take a day to port all your scripts at best. You can check out https://github.com/mmikeww/AHK-v2-script-converter to help you out with it.

[llinfeng]

@sitiom Thank you for the pointer to the converter repo. It looks promising. I agree that I should switch to AHK v2 at some point.