1//! # Welcome to GPUI!
  2//!
  3//! GPUI is a hybrid immediate and retained mode, GPU accelerated, UI framework
  4//! for Rust, designed to support a wide variety of applications.
  5//!
  6//! ## Getting Started
  7//!
  8//! GPUI is still in active development as we work on the Zed code editor and isn't yet on crates.io.
  9//! You'll also need to use the latest version of stable rust. Add the following to your Cargo.toml:
 10//!
 11//! ```
 12//! gpui = { git = "https://github.com/zed-industries/zed" }
 13//! ```
 14//!
 15//! Everything in GPUI starts with an [`App`]. You can create one with [`App::new`], and
 16//! kick off your application by passing a callback to [`App::run`]. Inside this callback,
 17//! you can create a new window with [`AppContext::open_window`], and register your first root
 18//! view. See [gpui.rs](https://www.gpui.rs/) for a complete example.
 19//!
 20//! ## The Big Picture
 21//!
 22//! GPUI offers three different [registers](https://en.wikipedia.org/wiki/Register_(sociolinguistics)) depending on your needs:
 23//!
 24//! - State management and communication with Models. Whenever you need to store application state
 25//!   that communicates between different parts of your application, you'll want to use GPUI's
 26//!   models. Models are owned by GPUI and are only accessible through an owned smart pointer
 27//!   similar to an [`Rc`]. See the [`app::model_context`] module for more information.
 28//!
 29//! - High level, declarative UI with Views. All UI in GPUI starts with a View. A view is simply
 30//!   a model that can be rendered, via the [`Render`] trait. At the start of each frame, GPUI
 31//!   will call this render method on the root view of a given window. Views build a tree of
 32//!   `elements`, lay them out and style them with a tailwind-style API, and then give them to
 33//!   GPUI to turn into pixels. See the [`elements::Div`] element for an all purpose swiss-army
 34//!   knife for UI.
 35//!
 36//! - Low level, imperative UI with Elements. Elements are the building blocks of UI in GPUI, and they
 37//!   provide a nice wrapper around an imperative API that provides as much flexibility and control as
 38//!   you need. Elements have total control over how they and their child elements are rendered and
 39//!   can be used for making efficient views into large lists, implement custom layouting for a code editor,
 40//!   and anything else you can think of. See the [`element`] module for more information.
 41//!
 42//!  Each of these registers has one or more corresponding contexts that can be accessed from all GPUI services.
 43//!  This context is your main interface to GPUI, and is used extensively throughout the framework.
 44//!
 45//! ## Other Resources
 46//!
 47//! In addition to the systems above, GPUI provides a range of smaller services that are useful for building
 48//! complex applications:
 49//!
 50//! - Actions are user-defined structs that are used for converting keystrokes into logical operations in your UI.
 51//!   Use this for implementing keyboard shortcuts, such as cmd-q. See the [`action`] module for more information.
 52//! - Platform services, such as `quit the app` or `open a URL` are available as methods on the [`app::AppContext`].
 53//! - An async executor that is integrated with the platform's event loop. See the [`executor`] module for more information.,
 54//! - The [gpui::test] macro provides a convenient way to write tests for your GPUI applications. Tests also have their
 55//!   own kind of context, a [`TestAppContext`] which provides ways of simulating common platform input. See [`app::test_context`]
 56//!   and [`test`] modules for more details.
 57//!
 58//! Currently, the best way to learn about these APIs is to read the Zed source code, ask us about it at a fireside hack, or drop
 59//! a question in the [Zed Discord](https://zed.dev/community-links). We're working on improving the documentation, creating more examples,
 60//! and will be publishing more guides to GPUI on our [blog](https://zed.dev/blog).
 61
 62#![deny(missing_docs)]
 63#![allow(clippy::type_complexity)] // Not useful, GPUI makes heavy use of callbacks
 64#![allow(clippy::collapsible_else_if)] // False positives in platform specific code
 65#![allow(unused_mut)] // False positives in platform specific code
 66
 67#[macro_use]
 68mod action;
 69mod app;
 70
 71mod arena;
 72mod asset_cache;
 73mod assets;
 74mod bounds_tree;
 75mod color;
 76mod element;
 77mod elements;
 78mod executor;
 79mod geometry;
 80mod global;
 81mod input;
 82mod interactive;
 83mod key_dispatch;
 84mod keymap;
 85mod platform;
 86pub mod prelude;
 87mod scene;
 88mod shared_string;
 89mod shared_uri;
 90mod style;
 91mod styled;
 92mod subscription;
 93mod svg_renderer;
 94mod taffy;
 95#[cfg(any(test, feature = "test-support"))]
 96pub mod test;
 97mod text_system;
 98mod util;
 99mod view;
100mod window;
101
102/// Do not touch, here be dragons for use by gpui_macros and such.
103#[doc(hidden)]
104pub mod private {
105    pub use anyhow;
106    pub use linkme;
107    pub use schemars;
108    pub use serde;
109    pub use serde_derive;
110    pub use serde_json;
111}
112
113mod seal {
114    /// A mechanism for restricting implementations of a trait to only those in GPUI.
115    /// See: https://predr.ag/blog/definitive-guide-to-sealed-traits-in-rust/
116    pub trait Sealed {}
117}
118
119pub use action::*;
120pub use anyhow::Result;
121pub use app::*;
122pub(crate) use arena::*;
123pub use asset_cache::*;
124pub use assets::*;
125pub use color::*;
126pub use ctor::ctor;
127pub use element::*;
128pub use elements::*;
129pub use executor::*;
130pub use geometry::*;
131pub use global::*;
132pub use gpui_macros::{register_action, test, IntoElement, Render};
133pub use http_client;
134pub use input::*;
135pub use interactive::*;
136use key_dispatch::*;
137pub use keymap::*;
138pub use platform::*;
139pub use refineable::*;
140pub use scene::*;
141use seal::Sealed;
142pub use shared_string::*;
143pub use shared_uri::*;
144pub use smol::Timer;
145pub use style::*;
146pub use styled::*;
147pub use subscription::*;
148use svg_renderer::*;
149pub use taffy::{AvailableSpace, LayoutId};
150#[cfg(any(test, feature = "test-support"))]
151pub use test::*;
152pub use text_system::*;
153pub use util::arc_cow::ArcCow;
154pub use view::*;
155pub use window::*;
156
157use std::{any::Any, borrow::BorrowMut};
158use taffy::TaffyLayoutEngine;
159
160/// The context trait, allows the different contexts in GPUI to be used
161/// interchangeably for certain operations.
162pub trait Context {
163    /// The result type for this context, used for async contexts that
164    /// can't hold a direct reference to the application context.
165    type Result<T>;
166
167    /// Create a new model in the app context.
168    fn new_model<T: 'static>(
169        &mut self,
170        build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
171    ) -> Self::Result<Model<T>>;
172
173    /// Reserve a slot for a model to be inserted later.
174    /// The returned [Reservation] allows you to obtain the [EntityId] for the future model.
175    fn reserve_model<T: 'static>(&mut self) -> Self::Result<Reservation<T>>;
176
177    /// Insert a new model in the app context based on a [Reservation] previously obtained from [`reserve_model`].
178    ///
179    /// [`reserve_model`]: Self::reserve_model
180    fn insert_model<T: 'static>(
181        &mut self,
182        reservation: Reservation<T>,
183        build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
184    ) -> Self::Result<Model<T>>;
185
186    /// Update a model in the app context.
187    fn update_model<T, R>(
188        &mut self,
189        handle: &Model<T>,
190        update: impl FnOnce(&mut T, &mut ModelContext<'_, T>) -> R,
191    ) -> Self::Result<R>
192    where
193        T: 'static;
194
195    /// Read a model from the app context.
196    fn read_model<T, R>(
197        &self,
198        handle: &Model<T>,
199        read: impl FnOnce(&T, &AppContext) -> R,
200    ) -> Self::Result<R>
201    where
202        T: 'static;
203
204    /// Update a window for the given handle.
205    fn update_window<T, F>(&mut self, window: AnyWindowHandle, f: F) -> Result<T>
206    where
207        F: FnOnce(AnyView, &mut WindowContext) -> T;
208
209    /// Read a window off of the application context.
210    fn read_window<T, R>(
211        &self,
212        window: &WindowHandle<T>,
213        read: impl FnOnce(View<T>, &AppContext) -> R,
214    ) -> Result<R>
215    where
216        T: 'static;
217}
218
219/// Returned by [Context::reserve_model] to later be passed to [Context::insert_model].
220/// Allows you to obtain the [EntityId] for a model before it is created.
221pub struct Reservation<T>(pub(crate) Slot<T>);
222
223impl<T: 'static> Reservation<T> {
224    /// Returns the [EntityId] that will be associated with the model once it is inserted.
225    pub fn entity_id(&self) -> EntityId {
226        self.0.entity_id()
227    }
228}
229
230/// This trait is used for the different visual contexts in GPUI that
231/// require a window to be present.
232pub trait VisualContext: Context {
233    /// Construct a new view in the window referenced by this context.
234    fn new_view<V>(
235        &mut self,
236        build_view: impl FnOnce(&mut ViewContext<V>) -> V,
237    ) -> Self::Result<View<V>>
238    where
239        V: 'static + Render;
240
241    /// Update a view with the given callback
242    fn update_view<V: 'static, R>(
243        &mut self,
244        view: &View<V>,
245        update: impl FnOnce(&mut V, &mut ViewContext<V>) -> R,
246    ) -> Self::Result<R>;
247
248    /// Replace the root view of a window with a new view.
249    fn replace_root_view<V>(
250        &mut self,
251        build_view: impl FnOnce(&mut ViewContext<V>) -> V,
252    ) -> Self::Result<View<V>>
253    where
254        V: 'static + Render;
255
256    /// Focus a view in the window, if it implements the [`FocusableView`] trait.
257    fn focus_view<V>(&mut self, view: &View<V>) -> Self::Result<()>
258    where
259        V: FocusableView;
260
261    /// Dismiss a view in the window, if it implements the [`ManagedView`] trait.
262    fn dismiss_view<V>(&mut self, view: &View<V>) -> Self::Result<()>
263    where
264        V: ManagedView;
265}
266
267/// A trait that allows models and views to be interchangeable in certain operations
268pub trait Entity<T>: Sealed {
269    /// The weak reference type for this entity.
270    type Weak: 'static;
271
272    /// The ID for this entity
273    fn entity_id(&self) -> EntityId;
274
275    /// Downgrade this entity to a weak reference.
276    fn downgrade(&self) -> Self::Weak;
277
278    /// Upgrade this entity from a weak reference.
279    fn upgrade_from(weak: &Self::Weak) -> Option<Self>
280    where
281        Self: Sized;
282}
283
284/// A trait for tying together the types of a GPUI entity and the events it can
285/// emit.
286pub trait EventEmitter<E: Any>: 'static {}
287
288/// A helper trait for auto-implementing certain methods on contexts that
289/// can be used interchangeably.
290pub trait BorrowAppContext {
291    /// Set a global value on the context.
292    fn set_global<T: Global>(&mut self, global: T);
293    /// Updates the global state of the given type.
294    fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
295    where
296        G: Global;
297    /// Updates the global state of the given type, creating a default if it didn't exist before.
298    fn update_default_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
299    where
300        G: Global + Default;
301}
302
303impl<C> BorrowAppContext for C
304where
305    C: BorrowMut<AppContext>,
306{
307    fn set_global<G: Global>(&mut self, global: G) {
308        self.borrow_mut().set_global(global)
309    }
310
311    #[track_caller]
312    fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
313    where
314        G: Global,
315    {
316        let mut global = self.borrow_mut().lease_global::<G>();
317        let result = f(&mut global, self);
318        self.borrow_mut().end_global_lease(global);
319        result
320    }
321
322    fn update_default_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
323    where
324        G: Global + Default,
325    {
326        self.borrow_mut().default_global::<G>();
327        self.update_global(f)
328    }
329}
330
331/// A flatten equivalent for anyhow `Result`s.
332pub trait Flatten<T> {
333    /// Convert this type into a simple `Result<T>`.
334    fn flatten(self) -> Result<T>;
335}
336
337impl<T> Flatten<T> for Result<Result<T>> {
338    fn flatten(self) -> Result<T> {
339        self?
340    }
341}
342
343impl<T> Flatten<T> for Result<T> {
344    fn flatten(self) -> Result<T> {
345        self
346    }
347}
348
349/// Information about the GPU GPUI is running on.
350#[derive(Default, Debug)]
351pub struct GpuSpecs {
352    /// Whether the GPU is really a fake (like `llvmpipe`) running on the CPU.
353    pub is_software_emulated: bool,
354    /// The name of the device, as reported by Vulkan.
355    pub device_name: String,
356    /// The name of the driver, as reported by Vulkan.
357    pub driver_name: String,
358    /// Further information about the driver, as reported by Vulkan.
359    pub driver_info: String,
360}