Skip to content

[WIP] implements deferred perspective loading #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
titibandit wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[WIP] implements deferred perspective loading #190

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d648acb
implements `persp-state-defer-loading`
Aug 9, 2022
325374b
typo defered -> deferred
Sep 12, 2022
0621a1d
persp-get-buffer-names respects deferred perspectives
Oct 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 64 additions & 30 deletions perspective.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,15 @@ won't be killed upon state save if persp-purge-initial-persp-on-save is t"
:group 'perspective-mode
:type '(repeat regexp))

(defcustom persp-state-defer-loading nil
"When non-nil, will defer the loading of the files when using `persp-state-load`.

Useful when the state contains a high number of files, or when files are slow to load
(e.g. files opened using SSH). The files will then be openend upon switching to their
perspective."
:group 'perspective-mode
:type 'boolean)


;;; --- implementation

Expand Down Expand Up @@ -196,7 +205,8 @@ After BODY is evaluated, frame parameters are reset to their original values."
(cl-defstruct (perspective
(:conc-name persp-)
(:constructor make-persp-internal))
name buffers killed local-variables
name buffers files killed local-variables
(deferred nil)
(last-switch-time (current-time))
(created-time (current-time))
(window-configuration (current-window-configuration))
Expand Down Expand Up @@ -551,14 +561,14 @@ will need to be changed again after calling `make-persp'."
(with-current-perspective
(setf (persp-local-variables persp) (persp-local-variables (persp-curr))))
(puthash (persp-name persp) persp (perspectives-hash))
(with-perspective (persp-name persp)
,(when args
,(when args
`(with-perspective (persp-name persp)
;; Body form given
`(save-excursion ,@args))
(save-excursion ,@args)
;; If the `current-buffer' changes while in `save-excursion',
;; that change isn't kept when getting out, since the current
;; buffer is saved before executing BODY and restored after.
(run-hooks 'persp-created-hook))
(run-hooks 'persp-created-hook)))
persp)))

(defun persp-save ()
Expand Down Expand Up @@ -654,7 +664,7 @@ window-side creating perspectives."
The new perspective will start with only an `initial-major-mode'
buffer called \"*scratch* (NAME)\"."
(or (gethash name (perspectives-hash))
(make-persp :name name
(make-persp :name name :deferred nil
(switch-to-buffer (persp-get-scratch-buffer name))
(persp-reset-windows))))

Expand Down Expand Up @@ -815,8 +825,16 @@ If NORECORD is non-nil, do not update the
(set-frame-parameter nil 'persp--curr persp)
(persp-reset-windows)
(persp-set-local-variables (persp-local-variables persp))
(setf (persp-buffers persp) (persp-reactivate-buffers (persp-buffers persp)))
(set-window-configuration (persp-window-configuration persp))
(if (persp-deferred persp)
(progn ;; deferred - open the files
(cl-loop for file in (persp-files persp) do
(when (file-exists-p file)
(find-file file)))
(window-state-put (persp-window-configuration persp) (frame-root-window) 'safe)
(setf (persp-deferred persp) nil))
;; not deferred - files are already open
(setf (persp-buffers persp) (persp-reactivate-buffers (persp-buffers persp)))
(set-window-configuration (persp-window-configuration persp)))
(when (marker-position (persp-point-marker persp))
(goto-char (persp-point-marker persp)))
(persp-update-modestring)
Expand Down Expand Up @@ -1227,11 +1245,16 @@ See also `persp-get-buffers' to get all buffers."
(let ((name (if (stringp persp-or-name)
persp-or-name
(persp-name (or persp-or-name (persp-curr)))))
(persp (if (perspective-p persp-or-name)
persp-or-name
(persp-new persp-or-name)))
buffers)
(with-selected-frame (or frame (selected-frame))
(when (member name (persp-names))
(with-perspective name
(setq buffers (persp-current-buffer-names)))))
(if (persp-deferred persp)
(setq buffers (mapcar 'buffer-name (persp-buffers persp)))
(with-perspective name
(setq buffers (persp-current-buffer-names))))))
buffers))

(defun persp-read-buffer (prompt &optional def require-match predicate)
Expand Down Expand Up @@ -1819,7 +1842,6 @@ PERSP-SET-IDO-BUFFERS)."
;; }

(cl-defstruct persp--state-complete
files
frames)

;; Keep around old version to maintain backwards compatibility.
Expand All @@ -1834,7 +1856,8 @@ PERSP-SET-IDO-BUFFERS)."

(cl-defstruct persp--state-single
buffers
windows)
windows
files)

(defun persp--state-complete-v2 (state-complete)
"Apply this function to persp--state-complete structs to be guaranteed a
Expand All @@ -1851,7 +1874,6 @@ maintaining backwards compatibility."
:merge-list nil)))
state-frames)))
(make-persp--state-complete
:files (persp--state-complete-files state-complete)
:frames state-frames-v2)))

(defun persp--state-interesting-buffer-p (buffer)
Expand Down Expand Up @@ -1933,13 +1955,20 @@ to the perspective's *scratch* buffer."
(cl-loop for buffer in (persp-current-buffers)
if (persp--state-interesting-buffer-p buffer)
collect (buffer-name buffer)))
(files
(cl-loop for buffer in (persp-current-buffers)
if (persp--state-interesting-buffer-p buffer)
collect (or (buffer-file-name buffer)
(with-current-buffer buffer ; dired special case
default-directory))))
(windows
(cl-loop for entry in (window-state-get (frame-root-window) t)
collect (persp--state-window-state-massage entry persp buffers))))
(puthash persp
(make-persp--state-single
:buffers buffers
:windows windows)
:windows windows
:files files)
persps-in-frame)))))
(make-persp--state-frame-v2
:persps persps-in-frame
Expand Down Expand Up @@ -2015,7 +2044,6 @@ visible in a perspective as windows, they will be saved as
;; actually save
(persp-save)
(let ((state-complete (make-persp--state-complete
:files (persp--state-file-data)
:frames (persp--state-frame-data))))
;; create or overwrite target-file:
(with-temp-file target-file (prin1 state-complete (current-buffer))))
Expand Down Expand Up @@ -2049,11 +2077,12 @@ restored."
(with-temp-buffer
(insert-file-contents file)
(buffer-string))))))
(unless persp-state-defer-loading
;; open all files in a temporary perspective to avoid polluting "main"
(persp-switch tmp-persp-name)
(cl-loop for file in (persp--state-complete-files state-complete) do
(when (file-exists-p file)
(find-file file)))
(persp-switch tmp-persp-name)
(cl-loop for file in (persp--state-complete-files state-complete) do
(when (file-exists-p file)
(find-file file))))
;; iterate over the frames
(cl-loop for frame in (persp--state-complete-frames state-complete) do
(cl-incf frame-count)
Expand All @@ -2067,17 +2096,22 @@ restored."
;; iterate over the perspectives in the frame in the appropriate order
(cl-loop for persp in frame-persp-order do
(let ((state-single (gethash persp frame-persp-table)))
(persp-switch persp)
(set-frame-parameter nil 'persp-merge-list frame-persp-merge-list)
(cl-loop for buffer in (persp--state-single-buffers state-single) do
(persp-add-buffer buffer))
;; XXX: split-window-horizontally is necessary for
;; window-state-put to succeed? Something goes haywire with root
;; windows without it.
(split-window-horizontally)
(window-state-put (persp--state-single-windows state-single)
(frame-root-window emacs-frame)
'safe))))))
(if persp-state-defer-loading
(make-persp :name persp :deferred t
:files (persp--state-single-files state-single)
:window-configuration (persp--state-single-windows state-single))
;; open the files directly
(persp-switch persp)
(cl-loop for buffer in (persp--state-single-buffers state-single) do
(persp-add-buffer buffer))
;; XXX: split-window-horizontally is necessary for
;; window-state-put to succeed? Something goes haywire with root
;; windows without it.
(split-window-horizontally)
(window-state-put (persp--state-single-windows state-single)
(frame-root-window emacs-frame)
'safe))
(set-frame-parameter nil 'persp-merge-list frame-persp-merge-list))))))
;; cleanup
(persp-kill tmp-persp-name))
;; after hook
Expand Down