History manager (#26369)
While working on implementing `add_recent_documents` for Windows, I found that the process is significantly more complex compared to macOS. On macOS, simply registering the `add_recent_documents` function is enough, as the system handles everything automatically. On Windows, however, there are two cases to consider: - **Files opened by the app**: These appear in the "Recent" section (as shown in the screenshot, "test.txt") and are managed automatically by Windows (by setting windows registry), similar to macOS.  - **Folders opened by the app**: This is more complicated because Windows does not handle it automatically, requiring the application to track opened folders manually. To address this, this PR introduces a `History Manager` along with `HistoryManagerEvent::Update` and `HistoryManagerEvent::Delete` events to simplify the process of managing recently opened folders. https://github.com/user-attachments/assets/a2581c15-7653-4faf-96b0-7c48ab1dcc8d Release Notes: - N/A --------- Co-authored-by: Mikayla Maki <mikayla@zed.dev>
This commit is contained in:
parent
5734ffbb18
commit
a5fe6d1e61
14 changed files with 482 additions and 66 deletions
129
crates/workspace/src/history_manager.rs
Normal file
129
crates/workspace/src/history_manager.rs
Normal file
|
@ -0,0 +1,129 @@
|
|||
use std::path::PathBuf;
|
||||
|
||||
use gpui::{AppContext, Entity, Global, MenuItem};
|
||||
use smallvec::SmallVec;
|
||||
use ui::App;
|
||||
use util::{ResultExt, paths::PathExt};
|
||||
|
||||
use crate::{NewWindow, SerializedWorkspaceLocation, WORKSPACE_DB, WorkspaceId};
|
||||
|
||||
pub fn init(cx: &mut App) {
|
||||
let manager = cx.new(|_| HistoryManager::new());
|
||||
HistoryManager::set_global(manager.clone(), cx);
|
||||
HistoryManager::init(manager, cx);
|
||||
}
|
||||
|
||||
pub struct HistoryManager {
|
||||
/// The history of workspaces that have been opened in the past, in reverse order.
|
||||
/// The most recent workspace is at the end of the vector.
|
||||
history: Vec<HistoryManagerEntry>,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct HistoryManagerEntry {
|
||||
pub id: WorkspaceId,
|
||||
pub path: SmallVec<[PathBuf; 2]>,
|
||||
}
|
||||
|
||||
struct GlobalHistoryManager(Entity<HistoryManager>);
|
||||
|
||||
impl Global for GlobalHistoryManager {}
|
||||
|
||||
impl HistoryManager {
|
||||
fn new() -> Self {
|
||||
Self {
|
||||
history: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
fn init(this: Entity<HistoryManager>, cx: &App) {
|
||||
cx.spawn(async move |cx| {
|
||||
let recent_folders = WORKSPACE_DB
|
||||
.recent_workspaces_on_disk()
|
||||
.await
|
||||
.unwrap_or_default()
|
||||
.into_iter()
|
||||
.rev()
|
||||
.map(|(id, location)| HistoryManagerEntry::new(id, &location))
|
||||
.collect::<Vec<_>>();
|
||||
this.update(cx, |this, cx| {
|
||||
this.history = recent_folders;
|
||||
this.update_jump_list(cx);
|
||||
})
|
||||
})
|
||||
.detach();
|
||||
}
|
||||
|
||||
pub fn global(cx: &App) -> Option<Entity<Self>> {
|
||||
cx.try_global::<GlobalHistoryManager>()
|
||||
.map(|model| model.0.clone())
|
||||
}
|
||||
|
||||
fn set_global(history_manager: Entity<Self>, cx: &mut App) {
|
||||
cx.set_global(GlobalHistoryManager(history_manager));
|
||||
}
|
||||
|
||||
pub fn update_history(&mut self, id: WorkspaceId, entry: HistoryManagerEntry, cx: &App) {
|
||||
if let Some(pos) = self.history.iter().position(|e| e.id == id) {
|
||||
self.history.remove(pos);
|
||||
}
|
||||
self.history.push(entry);
|
||||
self.update_jump_list(cx);
|
||||
}
|
||||
|
||||
pub fn delete_history(&mut self, id: WorkspaceId, cx: &App) {
|
||||
let Some(pos) = self.history.iter().position(|e| e.id == id) else {
|
||||
return;
|
||||
};
|
||||
self.history.remove(pos);
|
||||
self.update_jump_list(cx);
|
||||
}
|
||||
|
||||
fn update_jump_list(&mut self, cx: &App) {
|
||||
let menus = vec![MenuItem::action("New Window", NewWindow)];
|
||||
let entries = self
|
||||
.history
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|entry| entry.path.clone())
|
||||
.collect::<Vec<_>>();
|
||||
let user_removed = cx.update_jump_list(menus, entries);
|
||||
self.remove_user_removed_workspaces(user_removed, cx);
|
||||
}
|
||||
|
||||
pub fn remove_user_removed_workspaces(
|
||||
&mut self,
|
||||
user_removed: Vec<SmallVec<[PathBuf; 2]>>,
|
||||
cx: &App,
|
||||
) {
|
||||
if user_removed.is_empty() {
|
||||
return;
|
||||
}
|
||||
let mut deleted_ids = Vec::new();
|
||||
for idx in (0..self.history.len()).rev() {
|
||||
if let Some(entry) = self.history.get(idx) {
|
||||
if user_removed.contains(&entry.path) {
|
||||
deleted_ids.push(entry.id);
|
||||
self.history.remove(idx);
|
||||
}
|
||||
}
|
||||
}
|
||||
cx.spawn(async move |_| {
|
||||
for id in deleted_ids.iter() {
|
||||
WORKSPACE_DB.delete_workspace_by_id(*id).await.log_err();
|
||||
}
|
||||
})
|
||||
.detach();
|
||||
}
|
||||
}
|
||||
|
||||
impl HistoryManagerEntry {
|
||||
pub fn new(id: WorkspaceId, location: &SerializedWorkspaceLocation) -> Self {
|
||||
let path = location
|
||||
.sorted_paths()
|
||||
.iter()
|
||||
.map(|path| path.compact())
|
||||
.collect::<SmallVec<[PathBuf; 2]>>();
|
||||
Self { id, path }
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue