Skip to content

feature: Add going to exact location on jumping back and forward #53

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
pkradiator wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feature: Add going to exact location on jumping back and forward #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions devdocs.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ already installed, reinstall it."

(defun devdocs--revert-buffer (&rest _args)
"Refresh DevDocs buffer."
(devdocs--render (pop devdocs--stack)))
(devdocs--render (pop devdocs--stack) t))

(defun devdocs-goto-target ()
"Go to the original position in a DevDocs buffer."
Expand All @@ -366,8 +366,9 @@ already installed, reinstall it."
(interactive)
(unless (cadr devdocs--stack)
(user-error "No previous entry"))
(setcar devdocs--stack (cons (cons 'saved-point (point)) (car devdocs--stack)))

@astoff astoff Jun 16, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean (push `(saved-point . ,(point)) (car devdocs--stack))?

Also, we can name that property just point.

@astoff astoff Jun 17, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or better, actually: (setf (alist-get 'saved-point (car devdocs--stack)) (point)).

(push (pop devdocs--stack) devdocs--forward-stack)
(devdocs--render (pop devdocs--stack)))
(devdocs--render (pop devdocs--stack) t))

(defun devdocs-go-forward ()
"Go to the next entry in this DevDocs buffer."
Expand Down Expand Up @@ -538,12 +539,13 @@ Interactively, read a page name with completion."
(url-expander-remove-relative-links ;; undocumented function!
(concat (file-name-directory base) path))))))

(defun devdocs--render (entry)
(defun devdocs--render (entry &optional skip-save)
"Render a DevDocs documentation entry, returning a buffer.

ENTRY is an alist like those in the entry index of the document,
possibly with an additional ENTRY.fragment which overrides the
fragment part of ENTRY.path."
fragment part of ENTRY.path. If SKIP-SAVE is non-nil, do not
save the current point into the outgoing stack entry."
(with-current-buffer (get-buffer-create "*devdocs*")
(unless (eq major-mode 'devdocs-mode)
(devdocs-mode))
Expand All @@ -559,6 +561,10 @@ fragment part of ENTRY.path."
.doc.slug
(url-hexify-string (devdocs--path-file .path)))
devdocs-data-dir)))
(unless skip-save
(when devdocs--stack
(setcar devdocs--stack
(cons (cons 'saved-point (point)) (car devdocs--stack)))))
(erase-buffer)
;; TODO: cl-progv here for shr settings?
(shr-insert-document
Expand All @@ -571,7 +577,9 @@ fragment part of ENTRY.path."
(setq-local list-buffers-directory (format-mode-line devdocs-header-line
nil nil
(current-buffer)))
(devdocs-goto-target)
(if .saved-point
(goto-char (min .saved-point (point-max)))

@astoff astoff Jun 16, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, good catch. But also (point-min) might not be 1. So we should save (- (point) (point-mix)) and jump to (min (point-max) (+ saved-point (point-mix))).

(So really we should rather call saved-point position or something.)

(devdocs-goto-target))
(current-buffer))))

(defun devdocs--internal-url-p (url)
Expand Down