emacs: lisp/bookmark.el comparison

comparison lisp/bookmark.el @ 91302:56a72e2bd635

Merge from emacs--devo--0 Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-306

author	Miles Bader <miles@gnu.org>
date	Sat, 29 Dec 2007 02:39:17 +0000
parents	14c4a6aac623 9ac481bc897b
children	606f2d163a64

comparison

equal deleted inserted replaced

-:7774e5860c70
+:56a72e2bd635
 (list (cons 'info-node node)))))
 (message "%S" (assq 'info-node (bookmark-get-bookmark-record bookmark)))
 (sit-for 4))
+(defun bookmark-get-handler (bookmark)
+(cdr (assq 'handler (bookmark-get-bookmark-record bookmark))))
 (defvar bookmark-history nil
 "The history list for bookmark functions.")
 menus, so `completing-read' never gets a chance to set `bookmark-history'."
 `(or
 (interactive-p)
 (setq bookmark-history (cons ,string bookmark-history))))
+(defvar bookmark-make-cell-function 'bookmark-make-cell-for-text-file
+"A function that should be called to create the bookmark
+record.  Modes may set this variable buffer-locally to enable
+bookmarking of non-text files like images or pdf documents.
+The function will be called with two arguments: ANNOTATION and
+INFO-NODE.  See `bookmark-make-cell-for-text-file' for a
+description.
+The returned record may contain a special cons (handler
+. some-function) which sets the handler function that should be
+used to open this bookmark instead of `bookmark-jump-noselect'.
+It should return a cons (BUFFER . POINT) indicating buffer
+showing the bookmarked location and the value of point in that
+buffer.  Like `bookmark-jump-noselect' the buffer shouldn't be
+selected by the handler.")
 (defun bookmark-make (name &optional annotation overwrite info-node)
 "Make a bookmark named NAME.
 Optional second arg ANNOTATION gives it an annotation.
 Optional third arg OVERWRITE means replace any existing bookmarks with
 (set-text-properties 0 (length stripped-name) nil stripped-name))
 (if (and (bookmark-get-bookmark stripped-name) (not overwrite))
 ;; already existing bookmark under that name and
 ;; no prefix arg means just overwrite old bookmark
 (setcdr (bookmark-get-bookmark stripped-name)
-(list (bookmark-make-cell annotation info-node)))
+(list (funcall bookmark-make-cell-function annotation info-node)))
 ;; otherwise just cons it onto the front (either the bookmark
 ;; doesn't exist already, or there is no prefix arg.  In either
 ;; case, we want the new bookmark consed onto the alist...)
 (setq bookmark-alist
 (cons
 (list stripped-name
-(bookmark-make-cell annotation info-node))
+(funcall bookmark-make-cell-function annotation info-node))
 bookmark-alist)))
 ;; Added by db
 (setq bookmark-current-bookmark stripped-name)
 (setq bookmark-alist-modification-count
 (1+ bookmark-alist-modification-count))
 (if (bookmark-time-to-save-p)
 (bookmark-save))))
-(defun bookmark-make-cell (annotation &optional info-node)
+(defun bookmark-make-cell-for-text-file (annotation &optional info-node)
 "Return the record part of a new bookmark, given ANNOTATION.
 Must be at the correct position in the buffer in which the bookmark is
 being set.  This might change someday.
 Optional second arg INFO-NODE means this bookmark is at info node
 INFO-NODE, so record this fact in the bookmark's entry."
 (bookmark-bmenu-surreptitiously-rebuild-list)
 (goto-char bookmark-current-point))))
 (defun bookmark-info-current-node ()
-"If in Info-mode, return current node name (a string), else nil."
+"If in `Info-mode', return current node name (a string), else nil."
 (if (eq major-mode 'Info-mode)
 Info-current-node))
 (defun bookmark-kill-line (&optional newline-too)
 "Mode for composing annotations for a bookmark.
 Wants BUF, POINT, PARG, and BOOKMARK.
 When you have finished composing, type \\[bookmark-send-annotation] to send
 the annotation.
-\\{bookmark-read-annotation-mode-map}
+\\{bookmark-read-annotation-mode-map}"
-"
 (interactive)
 (kill-all-local-variables)
 (make-local-variable 'bookmark-annotation-paragraph)
 (make-local-variable 'bookmark-annotation-name)
 (make-local-variable 'bookmark-annotation-buffer)
 (defun bookmark-edit-annotation-mode (bookmark)
 "Mode for editing the annotation of bookmark BOOKMARK.
 When you have finished composing, type \\[bookmark-send-annotation].
-\\{bookmark-edit-annotation-mode-map}
+\\{bookmark-edit-annotation-mode-map}"
-"
 (interactive)
 (kill-all-local-variables)
 (make-local-variable 'bookmark-annotation-name)
 (setq bookmark-annotation-name bookmark)
 (use-local-map bookmark-edit-annotation-mode-map)
 (list (bookmark-completing-read "Jump to bookmark"
 				   bookmark-current-bookmark)))
 (unless bookmark
 (error "No bookmark specified"))
 (bookmark-maybe-historicize-string bookmark)
-(let ((cell (bookmark-jump-noselect bookmark)))
+(let ((cell (bookmark-jump-internal bookmark)))
 (and cell
 (switch-to-buffer (car cell))
 (goto-char (cdr cell))
 	 (progn (run-hooks 'bookmark-after-jump-hook) t)
 	 (if bookmark-automatically-show-annotations
 bookmark-current-bookmark)))
 (if (> emacs-major-version 21)
 (list bkm) bkm)))
 (when bookmark
 (bookmark-maybe-historicize-string bookmark)
-(let ((cell (bookmark-jump-noselect bookmark)))
+(let ((cell (bookmark-jump-internal bookmark)))
 (and cell
 (switch-to-buffer-other-window (car cell))
 (goto-char (cdr cell))
 (if bookmark-automatically-show-annotations
 ;; if there is an annotation for this bookmark,
 Info-suffix-list)
 nil))
 ;; Last possibility: try VC
 (if (vc-backend file) file))))
+(defun bookmark-jump-internal (bookmark)
+"Call BOOKMARK's handler or `bookmark-jump-noselect' if it has none."
+(funcall (or (bookmark-get-handler bookmark)
+	       'bookmark-jump-noselect)
+	   bookmark))
 (defun bookmark-jump-noselect (str)
 ;; a leetle helper for bookmark-jump :-)
 ;; returns (BUFFER . POINT)
 (bookmark-maybe-load-default-file)
 this."
 (interactive (list (bookmark-completing-read "Insert bookmark contents")))
 (bookmark-maybe-historicize-string bookmark)
 (bookmark-maybe-load-default-file)
 (let ((orig-point (point))
-(str-to-insert
+	(str-to-insert
-(save-excursion
+	 (save-excursion
-(set-buffer (car (bookmark-jump-noselect bookmark)))
+	   (set-buffer (car (bookmark-jump-internal bookmark)))
-(buffer-string))))
+	   (buffer-string))))
 (insert str-to-insert)
 (push-mark)
 (goto-char orig-point)))
 (let ((bmrk (bookmark-bmenu-bookmark))
 (menu (current-buffer))
 (pop-up-windows t))
 (delete-other-windows)
 (switch-to-buffer (other-buffer))
-	(let* ((pair (bookmark-jump-noselect bmrk))
+	(let* ((pair (bookmark-jump-internal bmrk))
 (buff (car pair))
 (pos  (cdr pair)))
 (pop-to-buffer buff)
 (goto-char pos))
 (bury-buffer menu))))
 (defun bookmark-bmenu-other-window ()
 "Select this line's bookmark in other window, leaving bookmark menu visible."
 (interactive)
 (let ((bookmark (bookmark-bmenu-bookmark)))
 (if (bookmark-bmenu-check-position)
-	(let* ((pair (bookmark-jump-noselect bookmark))
+	(let* ((pair (bookmark-jump-internal bookmark))
 (buff (car pair))
 (pos  (cdr pair)))
 	  (switch-to-buffer-other-window buff)
 (goto-char pos)
 (set-window-point (get-buffer-window buff) pos)
 (let ((bookmark (bookmark-bmenu-bookmark))
 (pop-up-windows t)
 same-window-buffer-names
 same-window-regexps)
 (if (bookmark-bmenu-check-position)
-	(let* ((pair (bookmark-jump-noselect bookmark))
+	(let* ((pair (bookmark-jump-internal bookmark))
 (buff (car pair))
 (pos  (cdr pair)))
 	  (display-buffer buff)
 (let ((o-buffer (current-buffer)))
 ;; save-excursion won't do

Mercurial > emacs

comparison lisp/bookmark.el @ 91302:56a72e2bd635