gpui/
gpui.rs

1#![doc = include_str!("../README.md")]
2#![warn(missing_docs)]
3#![allow(clippy::type_complexity)] // Not useful, GPUI makes heavy use of callbacks
4#![allow(clippy::collapsible_else_if)] // False positives in platform specific code
5#![allow(unused_mut)] // False positives in platform specific code
6
7extern crate self as gpui;
8#[macro_use]
9mod action;
10mod app;
11
12mod arena;
13mod asset_cache;
14mod assets;
15mod bounds_tree;
16mod color;
17/// The default colors used by GPUI.
18pub mod colors;
19#[cfg(feature = "profiler")]
20mod debug_overlay;
21mod element;
22mod elements;
23mod executor;
24mod platform_scheduler;
25pub(crate) use platform_scheduler::PlatformScheduler;
26mod geometry;
27mod gestures;
28mod global;
29mod input;
30mod inspector;
31mod interactive;
32mod key_dispatch;
33mod keymap;
34mod path_builder;
35mod platform;
36pub mod prelude;
37/// Profiling utilities for task, frame, and thread performance tracking.
38pub mod profiler;
39#[cfg(any(
40    test,
41    target_os = "windows",
42    target_os = "linux",
43    target_family = "wasm",
44    feature = "test-support",
45    feature = "bench-support"
46))]
47#[expect(missing_docs)]
48pub mod queue;
49mod scene;
50mod shared_uri;
51mod spring;
52mod style;
53mod styled;
54mod subscription;
55mod svg_renderer;
56mod tab_stop;
57mod taffy;
58#[cfg(any(test, feature = "test-support"))]
59pub mod test;
60mod text_system;
61mod util;
62mod view;
63mod window;
64
65#[cfg(any(test, feature = "test-support"))]
66pub use proptest;
67
68#[cfg(doc)]
69pub mod _accessibility;
70#[cfg(doc)]
71pub mod _ownership_and_data_flow;
72
73/// Do not touch, here be dragons for use by gpui_macros and such.
74#[doc(hidden)]
75pub mod private {
76    pub use anyhow;
77    pub use inventory;
78    pub use schemars;
79    pub use serde;
80    pub use serde_json;
81}
82
83mod seal {
84    /// A mechanism for restricting implementations of a trait to only those in GPUI.
85    /// See: <https://predr.ag/blog/definitive-guide-to-sealed-traits-in-rust/>
86    pub trait Sealed {}
87}
88
89pub use accesskit;
90pub use accesskit::Action as AccessibleAction;
91pub use accesskit::{Orientation, Role, Toggled};
92pub use action::*;
93pub use anyhow::Result;
94pub use app::*;
95pub(crate) use arena::*;
96pub use asset_cache::*;
97pub use assets::*;
98pub use color::*;
99pub use ctor::ctor;
100#[cfg(feature = "profiler")]
101pub use debug_overlay::*;
102pub use element::*;
103pub use elements::*;
104pub use executor::*;
105pub use geometry::*;
106pub use gestures::*;
107pub use global::*;
108pub use gpui_macros::{
109    AppContext, IntoElement, Render, VisualContext, bench, property_test, register_action, test,
110};
111pub use spring::*;
112
113/// Defines a Criterion benchmark group for benchmarks annotated with [`gpui::bench`].
114///
115/// This mirrors `criterion::criterion_group!`, but the group measures with the
116/// `gpui::BenchMeasurement` configured by `BENCH_MEASUREMENT` (see
117/// `BenchMeasurement::from_env`). By default Criterion analyzes wall time
118/// while retired instructions, cycles, IPC, context switches, and the other
119/// counters this machine supports are printed per iteration in the GPUI bench
120/// report. `BENCH_MEASUREMENT=instructions` makes Criterion analyze
121/// process-wide instructions instead, `foreground-instructions` the benchmark
122/// thread's alone, and `wall-time` disables all counters. A
123/// `config = ...` expression may set any other Criterion option; its
124/// measurement is replaced. To measure with something else, call
125/// `criterion::criterion_group!` directly with
126/// `config = criterion::Criterion::default().with_measurement(gpui::BenchMeasurement::new(...))`.
127///
128/// [`gpui::bench`]: crate::bench
129#[macro_export]
130macro_rules! bench_group {
131    (name = $name:ident; config = $config:expr; targets = $($target:path),+ $(,)?) => {
132        criterion::criterion_group! {
133            name = $name;
134            config = ($config).with_measurement($crate::BenchMeasurement::from_env_or_exit());
135            targets = $($target),+
136        }
137    };
138    ($name:ident, $($target:path),+ $(,)?) => {
139        $crate::bench_group! {
140            name = $name;
141            config = criterion::Criterion::default();
142            targets = $($target),+
143        }
144    };
145}
146
147/// Defines the entry point for GPUI Criterion benchmark groups.
148///
149/// This mirrors `criterion::criterion_main!` so GPUI benchmark files can keep the
150/// same shape as ordinary Criterion benchmarks.
151#[macro_export]
152macro_rules! bench_main {
153    ($($tokens:tt)*) => {
154        criterion::criterion_main!($($tokens)*);
155    };
156}
157pub use gpui_shared_string::*;
158pub use gpui_util::arc_cow::ArcCow;
159pub use http_client;
160pub use input::*;
161pub use inspector::*;
162pub use interactive::*;
163use key_dispatch::*;
164pub use keymap::*;
165pub use path_builder::*;
166pub use platform::*;
167pub use profiler::*;
168#[cfg(any(target_os = "windows", target_os = "linux", target_family = "wasm"))]
169pub use queue::{PriorityQueueReceiver, PriorityQueueSender};
170pub use refineable::*;
171pub use scene::*;
172pub use shared_uri::*;
173use std::{any::Any, future::Future};
174pub use style::*;
175pub use styled::*;
176pub use subscription::*;
177pub use svg_renderer::*;
178pub(crate) use tab_stop::*;
179use taffy::TaffyLayoutEngine;
180pub use taffy::{AvailableSpace, LayoutId};
181#[cfg(any(test, feature = "test-support"))]
182pub use test::*;
183pub use text_system::*;
184pub use util::{FutureExt, Timeout};
185pub use view::*;
186pub use window::*;
187
188#[cfg(not(target_family = "wasm"))]
189pub use pollster::block_on;
190
191/// The context trait, allows the different contexts in GPUI to be used
192/// interchangeably for certain operations.
193pub trait AppContext {
194    /// Create a new entity in the app context.
195    #[expect(
196        clippy::wrong_self_convention,
197        reason = "`App::new` is an ubiquitous function for creating entities"
198    )]
199    fn new<T: 'static>(&mut self, build_entity: impl FnOnce(&mut Context<T>) -> T) -> Entity<T>;
200
201    /// Reserve a slot for a entity to be inserted later.
202    /// The returned [Reservation] allows you to obtain the [EntityId] for the future entity.
203    fn reserve_entity<T: 'static>(&mut self) -> Reservation<T>;
204
205    /// Insert a new entity in the app context based on a [Reservation] previously obtained from [`reserve_entity`].
206    ///
207    /// [`reserve_entity`]: Self::reserve_entity
208    fn insert_entity<T: 'static>(
209        &mut self,
210        reservation: Reservation<T>,
211        build_entity: impl FnOnce(&mut Context<T>) -> T,
212    ) -> Entity<T>;
213
214    /// Update a entity in the app context.
215    fn update_entity<T, R>(
216        &mut self,
217        handle: &Entity<T>,
218        update: impl FnOnce(&mut T, &mut Context<T>) -> R,
219    ) -> R
220    where
221        T: 'static;
222
223    /// Update a entity in the app context.
224    fn as_mut<'a, T>(&'a mut self, handle: &Entity<T>) -> GpuiBorrow<'a, T>
225    where
226        T: 'static;
227
228    /// Read a entity from the app context.
229    fn read_entity<T, R>(&self, handle: &Entity<T>, read: impl FnOnce(&T, &App) -> R) -> R
230    where
231        T: 'static;
232
233    /// Update a window for the given handle.
234    fn update_window<T, F>(&mut self, window: AnyWindowHandle, f: F) -> Result<T>
235    where
236        F: FnOnce(AnyView, &mut Window, &mut App) -> T;
237
238    /// Run `f` against the entity's *current* window — the most recently
239    /// rendered window that referenced the entity. Returns `None` if the
240    /// entity has no current window or that window is unavailable. See
241    /// [`App::with_window`] for the underlying lookup.
242    fn with_window<R>(
243        &mut self,
244        entity_id: EntityId,
245        f: impl FnOnce(&mut Window, &mut App) -> R,
246    ) -> Option<R>;
247
248    /// Read a window off of the application context.
249    fn read_window<T, R>(
250        &self,
251        window: &WindowHandle<T>,
252        read: impl FnOnce(Entity<T>, &App) -> R,
253    ) -> Result<R>
254    where
255        T: 'static;
256
257    /// Spawn a future on a background thread
258    fn background_spawn<R>(&self, future: impl Future<Output = R> + Send + 'static) -> Task<R>
259    where
260        R: Send + 'static;
261
262    /// Read a global from this app context
263    fn read_global<G, R>(&self, callback: impl FnOnce(&G, &App) -> R) -> R
264    where
265        G: Global;
266}
267
268/// Returned by [Context::reserve_entity] to later be passed to [Context::insert_entity].
269/// Allows you to obtain the [EntityId] for a entity before it is created.
270pub struct Reservation<T>(pub(crate) Slot<T>);
271
272impl<T: 'static> Reservation<T> {
273    /// Returns the [EntityId] that will be associated with the entity once it is inserted.
274    pub fn entity_id(&self) -> EntityId {
275        self.0.entity_id()
276    }
277}
278
279/// This trait is used for the different visual contexts in GPUI that
280/// require a window to be present.
281pub trait VisualContext: AppContext {
282    /// The result type for window operations.
283    type Result<T>;
284
285    /// Returns the handle of the window associated with this context.
286    fn window_handle(&self) -> AnyWindowHandle;
287
288    /// Update a view with the given callback
289    fn update_window_entity<T: 'static, R>(
290        &mut self,
291        entity: &Entity<T>,
292        update: impl FnOnce(&mut T, &mut Window, &mut Context<T>) -> R,
293    ) -> Self::Result<R>;
294
295    /// Create a new entity, with access to `Window`.
296    fn new_window_entity<T: 'static>(
297        &mut self,
298        build_entity: impl FnOnce(&mut Window, &mut Context<T>) -> T,
299    ) -> Self::Result<Entity<T>>;
300
301    /// Replace the root view of a window with a new view.
302    fn replace_root_view<V>(
303        &mut self,
304        build_view: impl FnOnce(&mut Window, &mut Context<V>) -> V,
305    ) -> Self::Result<Entity<V>>
306    where
307        V: 'static + Render;
308
309    /// Focus a entity in the window, if it implements the [`Focusable`] trait.
310    fn focus<V>(&mut self, entity: &Entity<V>) -> Self::Result<()>
311    where
312        V: Focusable;
313}
314
315/// A trait for tying together the types of a GPUI entity and the events it can
316/// emit.
317pub trait EventEmitter<E: Any>: 'static {}
318
319/// A helper trait for auto-implementing certain methods on contexts that
320/// can be used interchangeably.
321pub trait BorrowAppContext {
322    /// Set a global value on the context.
323    fn set_global<T: Global>(&mut self, global: T);
324    /// Updates the global state of the given type.
325    fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
326    where
327        G: Global;
328    /// Updates the global state of the given type, creating a default if it didn't exist before.
329    fn update_default_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
330    where
331        G: Global + Default;
332}
333
334impl<C> BorrowAppContext for C
335where
336    C: std::borrow::BorrowMut<App>,
337{
338    fn set_global<G: Global>(&mut self, global: G) {
339        self.borrow_mut().set_global(global)
340    }
341
342    #[track_caller]
343    fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
344    where
345        G: Global,
346    {
347        let mut global = self.borrow_mut().lease_global::<G>();
348        let result = f(&mut global, self);
349        self.borrow_mut().end_global_lease(global);
350        result
351    }
352
353    fn update_default_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
354    where
355        G: Global + Default,
356    {
357        self.borrow_mut().default_global::<G>();
358        self.update_global(f)
359    }
360}
361
362/// Information about the GPU GPUI is running on.
363#[derive(Default, Debug, serde::Serialize, serde::Deserialize, Clone)]
364pub struct GpuSpecs {
365    /// Whether the GPU is really a fake (like `llvmpipe`) running on the CPU.
366    pub is_software_emulated: bool,
367    /// The name of the device, as reported by Vulkan.
368    pub device_name: String,
369    /// The name of the driver, as reported by Vulkan.
370    pub driver_name: String,
371    /// Further information about the driver, as reported by Vulkan.
372    pub driver_info: String,
373}
gpui/gpui.rs

gpui/
gpui.rs
