Add get_pane_direction method

[alfa07]

It is useful for implementing custom navigation in lua. For example jumping between windows.

See also #3006 the PR it is split from and issue #3007 describing idea in more detail.

[wez]

The CI failures were fixed by 36519f0 ; please rebase!

[alfa07]

@wez looks like CI is broken?

[wez]

44f31c9 may encourage the freebsd CI to run. The rest of the workflows run in GH actions and need to manually approved by me for PRs from first-time-contributors

[alfa07]

freebsd fails again with

error: failed to run custom build command for `wayland-sys v0.29.5`

[jbeich]

wayland-sys failed due to missing dependencies: pkgconf + wayland. Caused by the following:

env PATH=$HOME/.cargo/bin:$PATH bash get-deps
Updating FreeBSD repository catalogue...
FreeBSD repository is up to date.
All repositories are up to date.
pkg: No packages available to install matching 'mesa-devel' have been found in the repositories

mesa-devel failed to build after GitHub hiccup (checksum mismatch as gzip compression ratio changed) but will re-appear in a few days (the next build starts on Saturday at 01:00 UTC and may take ~2 days). Also, mesa-devel shouldn't be used by CI as it doesn't provide any headers in order to co-exist with mesa-dri.

[alfa07]

hmm, does not look like macos failures are related to the PR either

[wez]

@jbeich oh, should https://github.com/wez/wezterm/blob/main/get-deps#L205 be switched out for something else? That script is used by both humans and CI, FWIW

[wez]

@alfa07 this is looking good, thanks! One thing left to do is add docs for this new method:

Create docs/config/lua/pane/get_pane_direction.md; you can base the new page off of docs/config/lua/pane/get_semantic_zones.md.

If you want to test the doc build, you need to install a couple of utilities:

cargo install --vers "^0.4" mdbook
cargo install mdbook-linkcheck
cargo install mdbook-mermaid
cargo install gelatyx --version "^0.2"

Then you can run the build like this:

./ci/build-docs.sh

and then open gh_pages/html/index.html in your browser.

[jbeich]

@wez, mesa-devel should be simply dropped but bsd_deps likely has more cruft. For example,

# List runtime dependencsies
$ pkg rquery %dn wezterm
xcb-util-image
xcb-util
libxkbcommon
libxcb
libX11
fontconfig
libssh2 # due to LIBSSH2_SYS_USE_PKG_CONFIG=1
wayland

# List build dependencies (also, omit docs and duplicates)
$ make -V BUILD_DEPENDS WITHOUT=DOCS -C/usr/ports/x11/wezterm |
  sed 'y/ /\n/' | sed '/\.pc/d; /^$/d; s,.*:[^/]*/,,'
rust
pkgconf

[alfa07]

@wez Do you think I need to change anything?

[wez]

Looks good, thank you!