agentty-gpui
Agentty 専用の UI フレームワーク。GPU で描画する Rust の UI で、macOS・Windows・Linux に対応し、20 個のクレートとして crates.io で公開しています。
agentty-gpui は Agentty 専用の UI フレームワークです。Zed の gpui をベースに作りました。
Agentty の画面を GPU で描くのに必要なものをすべて備えています。エレメントとレイアウト、ウィンドウとメニュー、キーボード・マウス入力、テキストシェーピングとフォント、画像と SVG、そして macOS・Windows・Linux のバックエンドとレンダラーです。Agentty に必要な修正や機能はこのリポジトリに直接入れ、ほかの Rust アプリも同じように使えるよう、20 個のクレートとして crates.io で公開しています。
- リポジトリ:github.com/empty-user77/agentty-gpui
- クレート:crates.io/crates/agentty-gpui
- API ドキュメント:docs.rs/agentty-gpui
- ライセンス:Apache License 2.0
はじめに#
2 つのクレートを追加します。フレームワーク本体の agentty-gpui と、動作中の OS のバックエンドを起動する agentty-gpui-platform です。ライブラリ名は gpui と gpui_platform なので、コードでは use gpui::... と書きます。
cargo add agentty-gpui --rename gpui
cargo add agentty-gpui-platform --rename gpui_platformfn main() {
gpui_platform::application().run(|cx: &mut gpui::App| {
// ウィンドウを開く、キーを割り当てる など
});
}プラットフォームごとに有効にするものがあります。
| プラットフォーム | 設定 |
|---|---|
| macOS | agentty-gpui-platform の runtime_shaders を有効にすると Metal シェーダーを起動時にコンパイルするので、Xcode の Metal ツールチェーンなしでビルドできます。無効にするとビルド時にコンパイルするため、ツールチェーンが必要です(xcodebuild -downloadComponent MetalToolchain)。 |
| Windows | 追加の設定はありません。既定の windows-manifest 機能がアプリのマニフェストを実行ファイルに埋め込みます。 |
| Linux | 両方のクレートで wayland と x11 の一方または両方を有効にします。 |
機能フラグ#
agentty-gpui の機能です。既定は font-kit、wayland、x11、windows-manifest です。
| 機能 | 内容 |
|---|---|
font-kit | システムフォントを探して読み込みます(既定) |
wayland、x11 | Linux のディスプレイサーバー対応(既定) |
windows-manifest | Windows のアプリマニフェストを実行ファイルに埋め込みます(既定) |
screen-capture | 画面キャプチャ |
inspector | 実行中の UI のエレメントを調べるインスペクター |
test-support | テスト用プラットフォームとヘルパー |
leak-detection | エンティティハンドルを追跡し、テストでリークを検出します。ビルド時に GPUI_LEAK_DETECTION を設定しても有効になります |
bench-support | ベンチマークとプロファイラー(bench は同じ機能の旧名) |
profiler | フレーム時間のヒストグラム |
stacker | 深い再帰でスタックを伸ばします |
hot-reload | 開発中のコードのホットリロード |
agentty-gpui-platform は同じ名前の機能を各バックエンドに渡します(font-kit、inspector、screen-capture、test-support、bench-support、wayland、x11、runtime_shaders)。既定は multithreaded です。
クレート#
すべて同じバージョンで公開され、ビルドではターゲットのクレートだけがコンパイルされます。リンク先は各クレートの crates.io のページです。
フレームワーク#
| クレート | ライブラリ名 | 内容 | 依存 |
|---|---|---|---|
| agentty-gpui | gpui | フレームワーク本体。エレメント、flexbox レイアウト(Taffy)、ウィンドウ、入力、アクションとキーバインド、テキスト、画像・SVG、非同期エグゼキューター | collections、http-client、macros、refineable、scheduler、shared-string、sum-tree、util、bench-metrics(任意) |
| agentty-gpui-platform | gpui_platform | 現在の OS のバックエンドを選んでアプリを起動します(gpui_platform::application()) | agentty-gpui、macos、windows、linux、wgpu(任意) |
| agentty-gpui-macros | gpui_macros | フレームワークの derive・属性マクロ | — |
プラットフォームバックエンドとレンダラー#
| クレート | ライブラリ名 | 内容 | 依存 |
|---|---|---|---|
| agentty-gpui-macos | gpui_macos | macOS バックエンド。AppKit のウィンドウとメニュー、入力、通知、画面キャプチャ(任意) | agentty-gpui、apple、collections、scheduler、util |
| agentty-gpui-apple | gpui_apple | Apple プラットフォーム共通の Metal レンダラーと Core Text のテキスト | agentty-gpui、collections、util |
| agentty-gpui-windows | gpui_windows | Windows バックエンド。Direct3D 11 レンダラー、DirectWrite のテキスト、DirectComposition | agentty-gpui、collections、scheduler、util |
| agentty-gpui-linux | gpui_linux | Linux バックエンド。Wayland と X11、キーボード配列(xkbcommon)、デスクトップポータル | agentty-gpui、collections、http-client、util、wgpu(任意) |
| agentty-gpui-wgpu | gpui_wgpu | Linux で使う wgpu レンダラー | agentty-gpui、collections、util |
基盤ライブラリ#
| クレート | ライブラリ名 | 内容 | 依存 |
|---|---|---|---|
| agentty-gpui-util | gpui_util | 小さな共通ヘルパー | — |
| agentty-gpui-shared-string | gpui_shared_string | コピーせずに共有する文字列 SharedString | — |
| agentty-gpui-collections | collections | ハッシュマップとハッシュセットの型 | util |
| agentty-gpui-sum-tree | sum_tree | リストとテキストの土台になる、並行処理に強い B 木 | ztracing |
| agentty-gpui-scheduler | scheduler | 非同期タスクのスケジューラー | — |
| agentty-gpui-refineable | refineable | スタイルを部分的に上書きできる Refineable トレイト | derive-refineable |
| agentty-gpui-derive-refineable | derive_refineable | その derive マクロ | — |
| agentty-gpui-http-client | http_client | HTTP クライアントのインターフェース。URL から画像を読み込むときに使います | — |
| agentty-gpui-zlog | zlog | ロギング | collections |
| agentty-gpui-ztracing | ztracing | トレーシング。Tracy プロファイラーとの連携(任意) | ztracing-macro、zlog(任意) |
| agentty-gpui-ztracing-macro | ztracing_macro | その属性マクロ | — |
| agentty-gpui-bench-metrics | bench_metrics | パフォーマンスカウンター | — |
iOS と Web のバックエンドは含めていません。Agentty は macOS、Windows、Linux 向けだからです。元の HTTP クライアントが必要な image と image_gallery のサンプルも外しています。
crates.io の依存関係#
crates.io のクレートは crates.io のクレートにしか依存できません。元のコードが Git やフォークから取る依存関係は、crates.io のリリースに置き換えています。
| クレート | 元の側にだけあるもの |
|---|---|
async-task | タスクの waker vtable の同一性の修正 |
calloop(Linux) | ループごとの idle コールバックを約 10ms に制限 |
khronos-egl(Linux) | 失敗した EGL 呼び出しが成功を返したときにパニックしない |
wgpu、naga(Linux) | より新しい API(QueueDescriptor、has_srgb_suffix) |
zed-font-kit、zed-scap、zed-xim | その後の小さな修正 |
oo7(Linux) | プロンプトストリームが終わったときのエラー |
windows-capture(Windows、screen-capture) | なし。zed-scap とビルドできる最後のリリースで Cargo.lock に固定しており、screen-capture を有効にする側も同じく固定する必要があります |
更新の仕方#
ブランチは 2 つです。
main:公開されるコード。Agentty のための変更はすべてここにあります。upstream:ベースにした元のコードをそのまま置いたブランチ。元のリリースごとに 1 コミットずつ積み、どのリリースかはzed/SNAPSHOT.mdに書いてあります。
新しい元のリリースを取り込む手順です。
scripts/sync-upstream.sh <タグ> # upstream に新しいスナップショット
git merge upstream # main にマージ。競合はここで変えたファイルだけ
python3 -I scripts/apply_agentty.pyマージ中にクレートのマニフェストが競合したら、元の側を取り(git checkout --theirs <ファイル>)、スクリプトを実行し直します。
テスト#
cargo nextest run --workspace --features agentty-gpui-apple/runtime_shaders
cargo test --workspace --doc --features agentty-gpui-apple/runtime_shaders- nextest を使います。いくつかのテストはプロセス全体の状態を読むので、
cargo testのように並べて実行すると失敗します。 - CI は
--profile ci(.config/nextest.toml)で、失敗したテストを 2 回まで再実行します。80ms のポーリングを計るベンチテストが、混んだランナーで間に合わないことがあるためです。 - Linux の CI は、wgpu レンダラーのテストに Mesa のソフトウェア Vulkan ドライバーを使います。
公開の手順#
scripts/apply_agentty.pyのVERSIONを上げ、スクリプトを実行し直してプッシュします。cargo publish --workspace --dry-runを含め、CI が通る必要があります。- GitHub Actions の Agentty ワークフローを実行します。このチェックアウトで Agentty を macOS、Windows、Linux でビルドしてテストします。
cargo publish --workspaceで依存順に公開します。- リリースのタグを付けます(
git tag v<バージョン> && git push origin v<バージョン>)。
問題の報告#
agentty-gpui のバグや変更の要望は agentty-gpui の Issues へ、Agentty のバグは Agentty の Issues へお願いします。OS ごとの Agentty の違いは プラットフォーム を参照してください。