1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later.
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 1997 Free Software Foundation
5 ;; Author: Karl Fogel <kfogel@red-bean.com>
6 ;; Maintainer: Karl Fogel <kfogel@red-bean.com>
8 ;; Keywords: bookmarks, placeholders, annotations
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; This package is for setting "bookmarks" in files. A bookmark
30 ;; associates a string with a location in a certain file. Thus, you
31 ;; can navigate your way to that location by providing the string.
32 ;; See the "User Variables" section for customizations.
34 ;; Thanks to David Bremner <bremner@cs.sfu.ca> for thinking of and
35 ;; then implementing the bookmark-current-bookmark idea. He even
36 ;; sent *patches*, bless his soul...
38 ;; Thanks to Gregory M. Saunders <saunders@cis.ohio-state.edu> for
39 ;; fixing and improving bookmark-time-to-save-p.
41 ;; Thanks go to Andrew V. Klein <avk@cig.mot.com> for the code that
42 ;; sorts the alist before presenting it to the user (in bookmark-bmenu-list
45 ;; And much thanks to David Hughes <djh@harston.cv.com> for many small
46 ;; suggestions and the code to implement them (like
47 ;; bookmark-bmenu-check-position, and some of the Lucid compatibility
50 ;; Kudos (whatever they are) go to Jim Blandy <jimb@red-bean.com>
51 ;; for his eminently sensible suggestion to separate bookmark-jump
52 ;; into bookmark-jump and bookmark-jump-noselect, which made many
53 ;; other things cleaner as well.
55 ;; Thanks to Roland McGrath for encouragement and help with defining
56 ;; autoloads on the menu-bar.
58 ;; Jonathan Stigelman <stig@hackvan.com> gave patches for default
59 ;; values in bookmark-jump and bookmark-set. Everybody please keep
60 ;; all the keystrokes they save thereby and send them to him at the
61 ;; end of each year :-) (No, seriously, thanks Jonathan!)
63 ;; Buckets of gratitude to John Grabowski <johng@media.mit.edu> for
64 ;; thinking up the annotations feature and implementing it so well.
66 ;; Based on info-bookmark.el, by Karl Fogel and Ken Olstad
69 ;; Thanks to Mikio Nakajima <PBC01764@niftyserve.or.jp> for many bugs
70 ;; reported and fixed.
72 ;; Thank you, Michael Kifer, for contributing the XEmacs support.
74 ;; Enough with the credits already, get on to the good stuff:
76 ;; FAVORITE CHINESE RESTAURANT:
77 ;; Boy, that's a tough one. Probably Hong Min, or maybe Emperor's
78 ;; Choice (both in Chicago's Chinatown). Well, both. How about you?
86 ;; If variable bookmark-use-annotations is non-nil, an annotation is
87 ;; queried for when setting a bookmark.
89 ;; The bookmark list is sorted lexically by default, but you can turn
90 ;; this off by setting bookmark-sort-flag to nil. If it is nil, then
91 ;; the list will be presented in the order it is recorded
92 ;; (chronologically), which is actually fairly useful as well.
96 (defgroup bookmark nil
97 "Setting, annotation and jumping to bookmarks."
101 (defcustom bookmark-use-annotations nil
102 "*If non-nil, saving a bookmark queries for an annotation in a buffer."
107 (defcustom bookmark-save-flag t
108 "*Controls when Emacs saves bookmarks to a file.
109 --> nil means never save bookmarks, except when `bookmark-save' is
110 explicitly called \(\\[bookmark-save]\).
111 --> t means save bookmarks when Emacs is killed.
112 --> Otherwise, it should be a number that is the frequency with which
113 the bookmark list is saved \(i.e.: the number of times which
114 Emacs' bookmark list may be modified before it is automatically
115 saved.\). If it is a number, Emacs will also automatically save
116 bookmarks when it is killed.
118 Therefore, the way to get it to save every time you make or delete a
119 bookmark is to set this variable to 1 \(or 0, which produces the same
122 To specify the file in which to save them, modify the variable
123 `bookmark-default-file', which is `~/.emacs.bmk' by default."
124 :type
'(choice (const nil
) (const t
) integer
)
128 (defconst bookmark-old-default-file
"~/.emacs-bkmrks"
129 "*The `.emacs.bmk' file used to be called this name.")
132 ;; defvarred to avoid a compilation warning:
133 (defvar bookmark-file nil
134 "Old name for `bookmark-default-file'.")
136 (defcustom bookmark-default-file
138 ;; In case user set `bookmark-file' in her .emacs:
140 (convert-standard-filename "~/.emacs.bmk"))
141 "*File in which to save bookmarks by default."
146 (defcustom bookmark-version-control
'nospecial
147 "*Whether or not to make numbered backups of the bookmark file.
148 It can have four values: t, nil, `never', and `nospecial'.
149 The first three have the same meaning that they do for the
150 variable `version-control', and the final value `nospecial' means just
151 use the value of `version-control'."
152 :type
'(choice (const t
) (const nil
) (const never
) (const nospecial
))
156 (defcustom bookmark-completion-ignore-case t
157 "*Non-nil means bookmark functions ignore case in completion."
162 (defcustom bookmark-sort-flag t
163 "*Non-nil means that bookmarks will be displayed sorted by bookmark name.
164 Otherwise they will be displayed in LIFO order (that is, most
165 recently set ones come first, oldest ones come last)."
170 (defcustom bookmark-automatically-show-annotations t
171 "*Nil means don't show annotations when jumping to a bookmark."
176 (defcustom bookmark-bmenu-file-column
30
177 "*Column at which to display filenames in a buffer listing bookmarks.
178 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
183 (defcustom bookmark-bmenu-toggle-filenames t
184 "*Non-nil means show filenames when listing bookmarks.
185 This may result in truncated bookmark names. To disable this, put the
186 following in your `.emacs' file:
188 \(setq bookmark-bmenu-toggle-filenames nil\)"
193 (defcustom bookmark-menu-length
70
194 "*Maximum length of a bookmark name displayed on a popup menu."
199 ;;; No user-serviceable parts beyond this point.
202 (defconst bookmark-xemacsp
203 (string-match "\\(Lucid\\|Xemacs\\)" emacs-version
))
206 ;; Added for lucid emacs compatibility, db
207 (or (fboundp 'defalias
) (fset 'defalias
'fset
))
209 ;; suggested for lucid compatibility by david hughes:
210 (or (fboundp 'frame-height
) (defalias 'frame-height
'screen-height
))
212 ;; This variable is probably obsolete now...
213 (or (boundp 'baud-rate
)
214 ;; some random value higher than 9600
215 (setq baud-rate
19200))
217 ;; XEmacs apparently call this `buffer-substring-without-properties',
219 (or (fboundp 'buffer-substring-no-properties
)
220 (if (fboundp 'buffer-substring-without-properties
)
221 (fset 'buffer-substring-no-properties
222 'buffer-substring-without-properties
)
223 (fset 'buffer-substring-no-properties
'buffer-substring
)))
228 ;; Set up these bindings dumping time *only*;
229 ;; if the user alters them, don't override the user when loading bookmark.el.
231 ;;;###autoload (define-key ctl-x-map "rb" 'bookmark-jump)
232 ;;;###autoload (define-key ctl-x-map "rm" 'bookmark-set)
233 ;;;###autoload (define-key ctl-x-map "rl" 'bookmark-bmenu-list)
236 (defvar bookmark-map nil
237 "Keymap containing bindings to bookmark functions.
238 It is not bound to any key by default: to bind it
239 so that you have a bookmark prefix, just use `global-set-key' and bind a
240 key of your choice to `bookmark-map'. All interactive bookmark
241 functions have a binding in this keymap.")
244 (define-prefix-command 'bookmark-map
)
246 ;; Read the help on all of these functions for details...
248 (define-key bookmark-map
"x" 'bookmark-set
)
250 (define-key bookmark-map
"m" 'bookmark-set
) ; "m" for "mark"
252 (define-key bookmark-map
"j" 'bookmark-jump
)
254 (define-key bookmark-map
"g" 'bookmark-jump
) ; "g" for "go"
256 (define-key bookmark-map
"i" 'bookmark-insert
)
258 (define-key bookmark-map
"e" 'edit-bookmarks
)
260 (define-key bookmark-map
"f" 'bookmark-insert-location
) ; "f" for "find"
262 (define-key bookmark-map
"r" 'bookmark-rename
)
264 (define-key bookmark-map
"d" 'bookmark-delete
)
266 (define-key bookmark-map
"l" 'bookmark-load
)
268 (define-key bookmark-map
"w" 'bookmark-write
)
270 (define-key bookmark-map
"s" 'bookmark-save
)
273 ;;; The annotation maps.
274 (defvar bookmark-read-annotation-mode-map
(copy-keymap text-mode-map
)
275 "Keymap for composing an annotation for a bookmark.")
277 (define-key bookmark-read-annotation-mode-map
"\C-c\C-c"
278 'bookmark-send-annotation
)
282 ;;; Core variables and data structures:
283 (defvar bookmark-alist
()
284 "Association list of bookmarks and their records.
285 You probably don't want to change the value of this alist yourself;
286 instead, let the various bookmark functions do it for you.
288 The format of the alist is
290 \(BOOKMARK1 BOOKMARK2 ...\)
292 where each BOOKMARK is of the form
296 \(front-context-string . FRONT-STR\)
297 \(rear-context-string . REAR-STR\)
300 \(annotation . ANNOTATION\)\)
302 So the cdr of each bookmark is an alist too.
303 `info-node' is optional, by the way.")
306 (defvar bookmarks-already-loaded nil
)
309 ;; just add the hook to make sure that people don't lose bookmarks
310 ;; when they kill Emacs, unless they don't want to save them.
312 (add-hook 'kill-emacs-hook
314 (lambda () (and (featurep 'bookmark
)
316 (bookmark-time-to-save-p t
)
319 ;; more stuff added by db.
321 (defvar bookmark-current-bookmark nil
322 "Name of bookmark most recently used in the current file.
323 It is buffer local, used to make moving a bookmark forward
324 through a file easier.")
326 (make-variable-buffer-local 'bookmark-current-bookmark
)
329 (defvar bookmark-alist-modification-count
0
330 "Number of modifications to bookmark list since it was last saved.")
333 (defvar bookmark-search-size
16
334 "Length of the context strings recorded on either side of a bookmark.")
337 (defvar bookmark-current-point
0)
338 (defvar bookmark-yank-point
0)
339 (defvar bookmark-current-buffer nil
)
345 ;; Only functions on this page and the next one (file formats) need to
346 ;; know anything about the format of bookmark-alist entries.
347 ;; Everyone else should go through them.
349 (defun bookmark-name-from-full-record (full-record)
350 "Return name of FULL-RECORD \(an alist element instead of a string\)."
354 (defun bookmark-all-names ()
355 "Return a list of all current bookmark names."
356 (bookmark-maybe-load-default-file)
358 (lambda (full-record)
359 (bookmark-name-from-full-record full-record
))
363 (defun bookmark-get-bookmark (bookmark)
364 "Return the full entry for BOOKMARK in bookmark-alist."
365 (assoc bookmark bookmark-alist
))
368 (defun bookmark-get-bookmark-record (bookmark)
369 "Return the guts of the entry for BOOKMARK in bookmark-alist.
370 That is, all information but the name."
371 (car (cdr (bookmark-get-bookmark bookmark
))))
374 (defun bookmark-set-name (bookmark newname
)
375 "Set BOOKMARK's name to NEWNAME."
377 (if (stringp bookmark
) (bookmark-get-bookmark bookmark
) bookmark
)
381 (defun bookmark-get-annotation (bookmark)
382 "Return the annotation of BOOKMARK, or nil if none."
383 (cdr (assq 'annotation
(bookmark-get-bookmark-record bookmark
))))
386 (defun bookmark-set-annotation (bookmark ann
)
387 "Set the annotation of BOOKMARK to ANN."
388 (let ((cell (assq 'annotation
(bookmark-get-bookmark-record bookmark
))))
391 (nconc (bookmark-get-bookmark-record bookmark
)
392 (list (cons 'annotation ann
))))))
395 (defun bookmark-get-filename (bookmark)
396 "Return the full filename of BOOKMARK."
397 (cdr (assq 'filename
(bookmark-get-bookmark-record bookmark
))))
400 (defun bookmark-set-filename (bookmark filename
)
401 "Set the full filename of BOOKMARK to FILENAME."
402 (let ((cell (assq 'filename
(bookmark-get-bookmark-record bookmark
))))
404 (setcdr cell filename
)
405 (nconc (bookmark-get-bookmark-record bookmark
)
406 (list (cons 'filename filename
))))))
409 (defun bookmark-get-position (bookmark)
410 "Return the position \(i.e.: point\) of BOOKMARK."
411 (cdr (assq 'position
(bookmark-get-bookmark-record bookmark
))))
414 (defun bookmark-set-position (bookmark position
)
415 "Set the position \(i.e.: point\) of BOOKMARK to POSITION."
416 (let ((cell (assq 'position
(bookmark-get-bookmark-record bookmark
))))
418 (setcdr cell position
)
419 (nconc (bookmark-get-bookmark-record bookmark
)
420 (list (cons 'position position
))))))
423 (defun bookmark-get-front-context-string (bookmark)
424 "Return the front-context-string of BOOKMARK."
425 (cdr (assq 'front-context-string
(bookmark-get-bookmark-record bookmark
))))
428 (defun bookmark-set-front-context-string (bookmark string
)
429 "Set the front-context-string of BOOKMARK to STRING."
430 (let ((cell (assq 'front-context-string
431 (bookmark-get-bookmark-record bookmark
))))
434 (nconc (bookmark-get-bookmark-record bookmark
)
435 (list (cons 'front-context-string string
))))))
438 (defun bookmark-get-rear-context-string (bookmark)
439 "Return the rear-context-string of BOOKMARK."
440 (cdr (assq 'rear-context-string
(bookmark-get-bookmark-record bookmark
))))
443 (defun bookmark-set-rear-context-string (bookmark string
)
444 "Set the rear-context-string of BOOKMARK to STRING."
445 (let ((cell (assq 'rear-context-string
446 (bookmark-get-bookmark-record bookmark
))))
449 (nconc (bookmark-get-bookmark-record bookmark
)
450 (list (cons 'rear-context-string string
))))))
453 (defun bookmark-get-info-node (bookmark)
454 "Get the info node associated with BOOKMARK."
455 (cdr (assq 'info-node
(bookmark-get-bookmark-record bookmark
))))
458 (defun bookmark-set-info-node (bookmark node
)
459 "Set the Info node of BOOKMARK to NODE."
460 (let ((cell (assq 'info-node
461 (bookmark-get-bookmark-record bookmark
))))
464 (nconc (bookmark-get-bookmark-record bookmark
)
465 (list (cons 'info-node node
)))))
467 (message "%S" (assq 'info-node
(bookmark-get-bookmark-record bookmark
)))
472 (defvar bookmark-history nil
473 "The history list for bookmark functions.")
476 (defun bookmark-completing-read (prompt &optional default
)
477 "Prompting with PROMPT, read a bookmark name in completion.
478 PROMPT will get a \": \" stuck on the end no matter what, so you
479 probably don't want to include one yourself.
480 Optional second arg DEFAULT is a string to return if the user enters
482 (bookmark-maybe-load-default-file) ; paranoia
483 (let* ((completion-ignore-case bookmark-completion-ignore-case
)
486 (concat prompt
(format " (%s): " default
))
487 (concat prompt
": ")))
489 (completing-read prompt
495 (if (string-equal "" str
)
500 (defmacro bookmark-maybe-historicize-string
(string)
501 "Put STRING into the bookmark prompt history, if caller non-interactive.
502 We need this because sometimes bookmark functions are invoked from
503 menus, so `completing-read' never gets a chance to set `bookmark-history'."
506 (setq bookmark-history
(cons (, string
) bookmark-history
)))))
509 (defun bookmark-make (name &optional annotation overwrite info-node
)
510 "Make a bookmark named NAME.
511 Optional second arg ANNOTATION gives it an annotation.
512 Optional third arg OVERWRITE means replace any existing bookmarks with
514 Optional fourth arg INFO-NODE means this bookmark is at info node
515 INFO-NODE, so record this fact in the bookmark's entry."
516 (bookmark-maybe-load-default-file)
517 (let ((stripped-name (copy-sequence name
)))
519 ;; XEmacs's `set-text-properties' doesn't work on
520 ;; free-standing strings, apparently.
521 (set-text-properties 0 (length stripped-name
) nil stripped-name
))
522 (if (and (bookmark-get-bookmark stripped-name
) (not overwrite
))
523 ;; already existing bookmark under that name and
524 ;; no prefix arg means just overwrite old bookmark
525 (setcdr (bookmark-get-bookmark stripped-name
)
526 (list (bookmark-make-cell annotation info-node
)))
528 ;; otherwise just cons it onto the front (either the bookmark
529 ;; doesn't exist already, or there is no prefix arg. In either
530 ;; case, we want the new bookmark consed onto the alist...)
535 (bookmark-make-cell annotation info-node
))
539 (setq bookmark-current-bookmark stripped-name
)
540 (setq bookmark-alist-modification-count
541 (1+ bookmark-alist-modification-count
))
542 (if (bookmark-time-to-save-p)
546 (defun bookmark-make-cell (annotation &optional info-node
)
547 "Return the record part of a new bookmark, given ANNOTATION.
548 Must be at the correct position in the buffer in which the bookmark is
549 being set. This might change someday.
550 Optional second arg INFO-NODE means this bookmark is at info node
551 INFO-NODE, so record this fact in the bookmark's entry."
553 (` ((filename .
(, (bookmark-buffer-file-name)))
554 (front-context-string
555 .
(, (if (>= (- (point-max) (point)) bookmark-search-size
)
556 (buffer-substring-no-properties
558 (+ (point) bookmark-search-size
))
561 .
(, (if (>= (- (point) (point-min)) bookmark-search-size
)
562 (buffer-substring-no-properties
564 (- (point) bookmark-search-size
))
566 (position .
(, (point)))
569 ;; Now fill in the optional parts:
571 ;; Take no chances with text properties
572 (set-text-properties 0 (length annotation
) nil annotation
)
573 (set-text-properties 0 (length info-node
) nil info-node
)
576 (nconc the-record
(list (cons 'annotation annotation
))))
578 (nconc the-record
(list (cons 'info-node info-node
))))
580 ;; Finally, return the completed record.
585 ;;; File format stuff
587 ;; The OLD format of the bookmark-alist was:
589 ;; ((bookmark-name (filename
595 ;; The NEW format of the bookmark-alist is:
597 ;; ((bookmark-name ((filename . FILENAME)
598 ;; (front-context-string . string-in-front)
599 ;; (rear-context-string . string-behind)
600 ;; (position . POINT)
601 ;; (annotation . annotation)
602 ;; (whatever . VALUE)
608 ;; I switched to using an internal as well as external alist because I
609 ;; felt that would be a more flexible framework in which to add
610 ;; features. It means that the order in which values appear doesn't
611 ;; matter, and it means that arbitrary values can be added without
612 ;; risk of interfering with existing ones.
614 ;; BOOKMARK-NAME is the string the user gives the bookmark and
615 ;; accesses it by from then on.
617 ;; FILENAME is the location of the file in which the bookmark is set.
619 ;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
620 ;; context in front of the point at which the bookmark is set.
622 ;; STRING-BEHIND is the same thing, but after the point.
624 ;; The context strings exist so that modifications to a file don't
625 ;; necessarily cause a bookmark's position to be invalidated.
626 ;; bookmark-jump will search for STRING-BEHIND and STRING-IN-FRONT in
627 ;; case the file has changed since the bookmark was set. It will
628 ;; attempt to place the user before the changes, if there were any.
629 ;; ANNOTATION is the annotation for the bookmark; it may not exist
630 ;; (for backward compatibility), be nil (no annotation), or be a
634 (defconst bookmark-file-format-version
1
635 "The current version of the format used by bookmark files.
636 You should never need to change this.")
639 (defconst bookmark-end-of-version-stamp-marker
640 "-*- End Of Bookmark File Format Version Stamp -*-\n"
641 "This string marks the end of the version stamp in a bookmark file.")
644 (defun bookmark-alist-from-buffer ()
645 "Return a bookmark-alist (in any format) from the current buffer.
646 The buffer must of course contain bookmark format information.
647 Does not care from where in the buffer it is called, and does not
650 (goto-char (point-min))
651 (if (search-forward bookmark-end-of-version-stamp-marker nil t
)
652 (read (current-buffer))
653 ;; Else we're dealing with format version 0
654 (if (search-forward "(" nil t
)
657 (read (current-buffer)))
658 ;; Else no hope of getting information here.
659 (error "Not bookmark format")))))
662 (defun bookmark-upgrade-version-0-alist (old-list)
663 "Upgrade a version 0 alist OLD-LIST to the current version."
666 (let* ((name (car bookmark
))
667 (record (car (cdr bookmark
)))
668 (filename (nth 0 record
))
669 (front-str (nth 1 record
))
670 (rear-str (nth 2 record
))
671 (position (nth 3 record
))
672 (ann (nth 4 record
)))
675 (` ((filename .
(, filename
))
676 (front-context-string .
(, (or front-str
"")))
677 (rear-context-string .
(, (or rear-str
"")))
678 (position .
(, position
))
679 (annotation .
(, ann
)))))))
683 (defun bookmark-upgrade-file-format-from-0 ()
684 "Upgrade a bookmark file of format 0 (the original format) to format 1.
685 This expects to be called from point-min in a bookmark file."
686 (message "Upgrading bookmark format from 0 to %d..."
687 bookmark-file-format-version
)
688 (let* ((old-list (bookmark-alist-from-buffer))
689 (new-list (bookmark-upgrade-version-0-alist old-list
)))
690 (delete-region (point-min) (point-max))
691 (bookmark-insert-file-format-version-stamp)
692 (pp new-list
(current-buffer))
694 (goto-char (point-min))
695 (message "Upgrading bookmark format from 0 to %d...done"
696 bookmark-file-format-version
)
700 (defun bookmark-grok-file-format-version ()
701 "Return an integer which is the file-format version of this bookmark file.
702 This expects to be called from point-min in a bookmark file."
703 (if (looking-at "^;;;;")
706 (re-search-forward "[0-9]")
708 (read (current-buffer))))
709 ;; Else this is format version 0, the original one, which didn't
710 ;; even have version stamps.
714 (defun bookmark-maybe-upgrade-file-format ()
715 "Check the file-format version of this bookmark file.
716 If the version is not up-to-date, upgrade it automatically.
717 This expects to be called from point-min in a bookmark file."
718 (let ((version (bookmark-grok-file-format-version)))
720 ((= version bookmark-file-format-version
)
721 ) ; home free -- version is current
723 (bookmark-upgrade-file-format-from-0))
725 (error "Bookmark file format version strangeness")))))
728 (defun bookmark-insert-file-format-version-stamp ()
729 "Insert text indicating current version of bookmark file format."
731 (format ";;;; Emacs Bookmark Format Version %d ;;;;\n"
732 bookmark-file-format-version
))
733 (insert ";;; This format is meant to be slightly human-readable;\n"
734 ";;; nevertheless, you probably don't want to edit it.\n"
736 bookmark-end-of-version-stamp-marker
))
739 ;;; end file-format stuff
745 (defun bookmark-set (&optional name parg
)
746 "Set a bookmark named NAME inside a file.
747 If name is nil, then the user will be prompted.
748 With prefix arg, will not overwrite a bookmark that has the same name
749 as NAME if such a bookmark already exists, but instead will \"push\"
750 the new bookmark onto the bookmark alist. Thus the most recently set
751 bookmark with name NAME would be the one in effect at any given time,
752 but the others are still there, should you decide to delete the most
755 To yank words from the text of the buffer and use them as part of the
756 bookmark name, type C-w while setting a bookmark. Successive C-w's
757 yank successive words.
759 Typing C-u inserts the name of the last bookmark used in the buffer
760 \(as an aid in using a single bookmark name to track your progress
761 through a large file\). If no bookmark was used, then C-u inserts the
762 name of the file being visited.
764 Use \\[bookmark-delete] to remove bookmarks \(you give it a name,
765 and it removes only the first instance of a bookmark with that name from
766 the list of bookmarks.\)"
767 (interactive (list nil current-prefix-arg
))
769 (bookmark-buffer-file-name)
770 (error "Buffer not visiting a file or directory"))
772 (bookmark-maybe-load-default-file)
774 (setq bookmark-current-point
(point))
775 (setq bookmark-yank-point
(point))
776 (setq bookmark-current-buffer
(current-buffer))
778 (let* ((default (or bookmark-current-bookmark
779 (bookmark-buffer-name)))
782 (read-from-minibuffer
783 (format "Set bookmark (%s): " default
)
785 (let ((now-map (copy-keymap minibuffer-local-map
)))
786 (define-key now-map
"\C-w" 'bookmark-yank-word
)
787 (define-key now-map
"\C-u" 'bookmark-insert-current-bookmark
)
790 (and (string-equal str
"") (setq str default
))
791 ;; Ask for an annotation buffer for this bookmark
792 (if bookmark-use-annotations
793 (bookmark-read-annotation parg str
)
794 (bookmark-make str annotation parg
(bookmark-info-current-node))
795 (setq bookmark-current-bookmark str
)
796 (bookmark-bmenu-surreptitiously-rebuild-list)
797 (goto-char bookmark-current-point
))))
800 (defun bookmark-info-current-node ()
801 "If in Info-mode, return current node name (a string), else nil."
802 (if (eq major-mode
'Info-mode
)
806 (defun bookmark-kill-line (&optional newline-too
)
807 "Kill from point to end of line.
808 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
809 Does not affect the kill-ring."
810 (let ((eol (save-excursion (end-of-line) (point))))
811 (delete-region (point) eol
)
812 (if (and newline-too
(looking-at "\n"))
816 ;; Defvars to avoid compilation warnings:
817 (defvar bookmark-annotation-paragraph nil
)
818 (defvar bookmark-annotation-name nil
)
819 (defvar bookmark-annotation-buffer nil
)
820 (defvar bookmark-annotation-file nil
)
821 (defvar bookmark-annotation-point nil
)
824 (defun bookmark-send-annotation ()
825 "Use buffer contents as the annotation for a bookmark.
826 Exclude lines that begin with `#'.
827 Store the annotation text in the bookmark list with
828 the bookmark (and file, and point) specified in buffer local variables."
830 (if (not (eq major-mode
'bookmark-read-annotation-mode
))
831 (error "Not in bookmark-read-annotation-mode"))
832 (goto-char (point-min))
833 (while (< (point) (point-max))
834 (if (looking-at "^#")
835 (bookmark-kill-line t
)
837 (let ((annotation (buffer-string))
838 (parg bookmark-annotation-paragraph
)
839 (bookmark bookmark-annotation-name
)
840 (pt bookmark-annotation-point
)
841 (buf bookmark-annotation-buffer
))
842 ;; for bookmark-make-cell to work, we need to be
843 ;; in the relevant buffer, at the relevant point.
844 ;; Actually, bookmark-make-cell should probably be re-written,
845 ;; to avoid this need. Should I handle the error if a buffer is
846 ;; killed between "C-x r m" and a "C-c C-c" in the annotation buffer?
850 (bookmark-make bookmark annotation parg
(bookmark-info-current-node))
851 (setq bookmark-current-bookmark bookmark
))
852 (bookmark-bmenu-surreptitiously-rebuild-list)
853 (goto-char bookmark-current-point
))
854 (kill-buffer (current-buffer)))
857 (defun bookmark-default-annotation-text (bookmark)
858 (concat "# Type the annotation for bookmark '" bookmark
"' here.\n"
859 "# All lines which start with a '#' will be deleted.\n"
860 "# Type C-c C-c when done.\n#\n"
861 "# Author: " (user-full-name) " <" (user-login-name) "@"
863 "# Date: " (current-time-string) "\n"))
866 (defvar bookmark-read-annotation-text-func
'bookmark-default-annotation-text
867 "Function to return default text to use for a bookmark annotation.
868 It takes the name of the bookmark, as a string, as an arg.")
870 (defun bookmark-read-annotation-mode (buf point parg bookmark
)
871 "Mode for composing annotations for a bookmark.
872 Wants BUF POINT PARG and BOOKMARK.
873 When you have finished composing, type \\[bookmark-send-annotation] to send
876 \\{bookmark-read-annotation-mode-map}
879 (kill-all-local-variables)
880 (make-local-variable 'bookmark-annotation-paragraph
)
881 (make-local-variable 'bookmark-annotation-name
)
882 (make-local-variable 'bookmark-annotation-buffer
)
883 (make-local-variable 'bookmark-annotation-file
)
884 (make-local-variable 'bookmark-annotation-point
)
885 (setq bookmark-annotation-paragraph parg
)
886 (setq bookmark-annotation-name bookmark
)
887 (setq bookmark-annotation-buffer buf
)
888 (setq bookmark-annotation-file
(buffer-file-name buf
))
889 (setq bookmark-annotation-point point
)
890 (use-local-map bookmark-read-annotation-mode-map
)
891 (setq major-mode
'bookmark-read-annotation-mode
)
892 (insert (funcall bookmark-read-annotation-text-func bookmark
))
893 (run-hooks 'text-mode-hook
))
896 (defun bookmark-read-annotation (parg bookmark
)
897 "Pop up a buffer for entering a bookmark annotation.
898 Text surrounding the bookmark is PARG; the bookmark name is BOOKMARK."
899 (let ((buf (current-buffer))
901 (pop-to-buffer (generate-new-buffer-name "*Bookmark Annotation Compose*"))
902 (bookmark-read-annotation-mode buf point parg bookmark
)))
905 (defvar bookmark-edit-annotation-mode-map
(copy-keymap text-mode-map
)
906 "Keymap for editing an annotation of a bookmark.")
909 (define-key bookmark-edit-annotation-mode-map
"\C-c\C-c"
910 'bookmark-send-edited-annotation
)
913 (defun bookmark-edit-annotation-mode (bookmark)
914 "Mode for editing the annotation of bookmark BOOKMARK.
915 When you have finished composing, type \\[bookmark-send-annotation].
917 \\{bookmark-edit-annotation-mode-map}
920 (kill-all-local-variables)
921 (make-local-variable 'bookmark-annotation-name
)
922 (setq bookmark-annotation-name bookmark
)
923 (use-local-map bookmark-edit-annotation-mode-map
)
924 (setq major-mode
'bookmark-edit-annotation-mode
)
925 (insert (funcall bookmark-read-annotation-text-func bookmark
))
926 (let ((annotation (bookmark-get-annotation bookmark
)))
927 (if (and annotation
(not (string-equal annotation
"")))
928 (insert annotation
)))
929 (run-hooks 'text-mode-hook
))
932 (defun bookmark-send-edited-annotation ()
933 "Use buffer contents (minus beginning with `#' as annotation for a bookmark."
935 (if (not (eq major-mode
'bookmark-edit-annotation-mode
))
936 (error "Not in bookmark-edit-annotation-mode"))
937 (goto-char (point-min))
938 (while (< (point) (point-max))
939 (if (looking-at "^#")
940 (bookmark-kill-line t
)
942 (let ((annotation (buffer-string))
943 (bookmark bookmark-annotation-name
))
944 (bookmark-set-annotation bookmark annotation
)
945 (bookmark-bmenu-surreptitiously-rebuild-list)
946 (goto-char bookmark-current-point
))
947 (kill-buffer (current-buffer)))
950 (defun bookmark-edit-annotation (bookmark)
951 "Pop up a buffer for editing bookmark BOOKMARK's annotation."
952 (let ((buf (current-buffer))
954 (pop-to-buffer (generate-new-buffer-name "*Bookmark Annotation Compose*"))
955 (bookmark-edit-annotation-mode bookmark
)))
958 (defun bookmark-insert-current-bookmark ()
959 "Insert this buffer's value of bookmark-current-bookmark.
960 Default to file name if it's nil."
964 (set-buffer bookmark-current-buffer
)
965 bookmark-current-bookmark
)))
966 (if str
(insert str
) (bookmark-insert-buffer-name))))
969 (defun bookmark-insert-buffer-name ()
970 "Insert the current file name into the bookmark name being set.
971 The directory part of the file name is not used."
975 (set-buffer bookmark-current-buffer
)
976 (bookmark-buffer-name))))
980 (defun bookmark-buffer-name ()
981 "Return the name of the current buffer's file, non-directory.
982 In Info, return the current node."
985 ((string-equal mode-name
"Info") Info-current-node
)
987 (buffer-file-name (file-name-nondirectory buffer-file-name
))
988 ;; Or are we a directory?
989 ((and (boundp 'dired-directory
) dired-directory
)
990 (let* ((dirname (if (stringp dired-directory
)
992 (car dired-directory
)))
993 (idx (1- (length dirname
))))
994 ;; Strip the trailing slash.
995 (if (= ?
/ (aref dirname idx
))
996 (file-name-nondirectory (substring dirname
0 idx
))
997 ;; Else return the current-buffer
998 (buffer-name (current-buffer)))))
999 ;; If all else fails, use the buffer's name.
1001 (buffer-name (current-buffer)))))
1004 (defun bookmark-yank-word ()
1006 ;; get the next word from the buffer and append it to the name of
1007 ;; the bookmark currently being set.
1008 (let ((string (save-excursion
1009 (set-buffer bookmark-current-buffer
)
1010 (goto-char bookmark-yank-point
)
1011 (buffer-substring-no-properties
1015 (setq bookmark-yank-point
(point)))))))
1019 (defun bookmark-buffer-file-name ()
1020 "Return the current buffer's file in a way useful for bookmarks.
1021 For example, if this is a Info buffer, return the Info file's name."
1022 (if (eq major-mode
'Info-mode
)
1026 (if (and (boundp 'dired-directory
) dired-directory
)
1027 (if (stringp dired-directory
)
1029 (car dired-directory
))))))
1032 (defun bookmark-maybe-load-default-file ()
1033 (and (not bookmarks-already-loaded
)
1034 (null bookmark-alist
)
1037 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
1039 (file-exists-p (expand-file-name bookmark-old-default-file
))
1040 (not (file-exists-p (expand-file-name bookmark-default-file
)))
1041 (rename-file (expand-file-name bookmark-old-default-file
)
1042 (expand-file-name bookmark-default-file
)))
1043 ;; return t so the `and' will continue...
1046 (file-readable-p (expand-file-name bookmark-default-file
))
1047 (bookmark-load bookmark-default-file t t
)
1048 (setq bookmarks-already-loaded t
)))
1051 (defun bookmark-maybe-sort-alist ()
1052 ;;Return the bookmark-alist for display. If the bookmark-sort-flag
1053 ;;is non-nil, then return a sorted copy of the alist.
1054 (if bookmark-sort-flag
1055 (setq bookmark-alist
1056 (sort (copy-alist bookmark-alist
)
1058 (lambda (x y
) (string-lessp (car x
) (car y
))))))))
1062 (defun bookmark-jump (bookmark)
1063 "Jump to bookmark BOOKMARK (a point in some file).
1064 You may have a problem using this function if the value of variable
1065 `bookmark-alist' is nil. If that happens, you need to load in some
1066 bookmarks. See help on function `bookmark-load' for more about
1069 If the file pointed to by BOOKMARK no longer exists, you will be asked
1070 if you wish to give the bookmark a new location, and bookmark-jump
1071 will then jump to the new location, as well as recording it in place
1072 of the old one in the permanent bookmark record."
1074 (bookmark-completing-read "Jump to bookmark" bookmark-current-bookmark
))
1075 (bookmark-maybe-historicize-string bookmark
)
1076 (let ((cell (bookmark-jump-noselect bookmark
)))
1078 (switch-to-buffer (car cell
))
1079 (goto-char (cdr cell
))
1080 (if bookmark-automatically-show-annotations
1081 ;; if there is an annotation for this bookmark,
1082 ;; show it in a buffer.
1083 (bookmark-show-annotation bookmark
)))))
1086 (defun bookmark-jump-noselect (str)
1087 ;; a leetle helper for bookmark-jump :-)
1088 ;; returns (BUFFER . POINT)
1089 (bookmark-maybe-load-default-file)
1090 (let* ((file (expand-file-name (bookmark-get-filename str
)))
1091 (forward-str (bookmark-get-front-context-string str
))
1092 (behind-str (bookmark-get-rear-context-string str
))
1093 (place (bookmark-get-position str
))
1094 (info-node (bookmark-get-info-node str
))
1098 (file-exists-p file
)
1099 ;; else try some common compression extensions
1100 ;; and Emacs better handle it right!
1101 ;; Sigh: I think it may *not* be handled at the moment. What
1102 ;; to do about this?
1105 (let ((altname (concat file
".Z")))
1106 (and (file-exists-p altname
)
1108 (let ((altname (concat file
".gz")))
1109 (and (file-exists-p altname
)
1111 (let ((altname (concat file
".z")))
1112 (and (file-exists-p altname
)
1116 ;; Info nodes must be visited with care.
1119 (Info-find-node file info-node
))
1120 ;; Else no Info. Can do an ordinary find-file:
1121 (set-buffer (find-file-noselect file
))
1124 ;; Go searching forward first. Then, if forward-str exists and
1125 ;; was found in the file, we can search backward for behind-str.
1126 ;; Rationale is that if text was inserted between the two in the
1127 ;; file, it's better to be put before it so you can read it,
1128 ;; rather than after and remain perhaps unaware of the changes.
1130 (if (search-forward forward-str
(point-max) t
)
1131 (goto-char (match-beginning 0))))
1133 (if (search-backward behind-str
(point-min) t
)
1134 (goto-char (match-end 0))))
1136 (setq bookmark-current-bookmark str
)
1137 (cons (current-buffer) (point)))
1138 ;; Else unable to find the marked file, so ask if user wants to
1139 ;; relocate the bookmark, else remind them to consider deletion.
1141 (if (y-or-n-p (concat (file-name-nondirectory orig-file
)
1142 " nonexistent. Relocate \""
1146 (bookmark-relocate str
)
1147 ;; gasp! It's a recursive function call in Emacs Lisp!
1148 (bookmark-jump-noselect str
))
1150 "Bookmark not relocated; consider removing it \(%s\)." str
)
1155 (defun bookmark-relocate (bookmark)
1156 "Relocate BOOKMARK to another file (reading file name with minibuffer).
1157 This makes an already existing bookmark point to that file, instead of
1158 the one it used to point at. Useful when a file has been renamed
1159 after a bookmark was set in it."
1160 (interactive (bookmark-completing-read "Bookmark to relocate"))
1161 (bookmark-maybe-historicize-string bookmark
)
1162 (bookmark-maybe-load-default-file)
1163 (let* ((bmrk-filename (bookmark-get-filename bookmark
))
1164 (newloc (expand-file-name
1166 (format "Relocate %s to: " bookmark
)
1167 (file-name-directory bmrk-filename
)))))
1168 (bookmark-set-filename bookmark newloc
)
1169 (bookmark-bmenu-surreptitiously-rebuild-list)))
1173 (defun bookmark-insert-location (bookmark &optional no-history
)
1174 "Insert the name of the file associated with BOOKMARK.
1175 Optional second arg NO-HISTORY means don't record this in the
1176 minibuffer history list `bookmark-history'."
1177 (interactive (bookmark-completing-read "Insert bookmark location"))
1178 (or no-history
(bookmark-maybe-historicize-string bookmark
))
1179 (let ((start (point)))
1181 (insert (bookmark-location bookmark
)) ; *Return this line*
1183 (put-text-property start
1184 (save-excursion (re-search-backward
1187 'mouse-face
'highlight
)))))
1190 (defalias 'bookmark-locate
'bookmark-insert-location
)
1192 (defun bookmark-location (bookmark)
1193 "Return the name of the file associated with BOOKMARK."
1194 (bookmark-maybe-load-default-file)
1195 (bookmark-get-filename bookmark
))
1199 (defun bookmark-rename (old &optional new
)
1200 "Change the name of OLD bookmark to NEW name.
1201 If called from keyboard, prompt for OLD and NEW. If called from
1202 menubar, select OLD from a menu and prompt for NEW.
1204 If called from Lisp, prompt for NEW if only OLD was passed as an
1205 argument. If called with two strings, then no prompting is done. You
1206 must pass at least OLD when calling from Lisp.
1208 While you are entering the new name, consecutive C-w's insert
1209 consecutive words from the text of the buffer into the new bookmark
1211 (interactive (bookmark-completing-read "Old bookmark name"))
1212 (bookmark-maybe-historicize-string old
)
1213 (bookmark-maybe-load-default-file)
1215 (setq bookmark-current-point
(point))
1216 (setq bookmark-yank-point
(point))
1217 (setq bookmark-current-buffer
(current-buffer))
1219 (or new
; use second arg, if non-nil
1220 (read-from-minibuffer
1223 (let ((now-map (copy-keymap minibuffer-local-map
)))
1224 (define-key now-map
"\C-w" 'bookmark-yank-word
)
1227 'bookmark-history
))))
1228 (bookmark-set-name old newname
)
1229 (setq bookmark-current-bookmark newname
)
1230 (bookmark-bmenu-surreptitiously-rebuild-list)
1231 (setq bookmark-alist-modification-count
1232 (1+ bookmark-alist-modification-count
))
1233 (if (bookmark-time-to-save-p)
1238 (defun bookmark-insert (bookmark)
1239 "Insert the text of the file pointed to by bookmark BOOKMARK.
1240 You may have a problem using this function if the value of variable
1241 `bookmark-alist' is nil. If that happens, you need to load in some
1242 bookmarks. See help on function `bookmark-load' for more about
1244 (interactive (bookmark-completing-read "Insert bookmark contents"))
1245 (bookmark-maybe-historicize-string bookmark
)
1246 (bookmark-maybe-load-default-file)
1247 (let ((orig-point (point))
1250 (set-buffer (car (bookmark-jump-noselect bookmark
)))
1252 (insert str-to-insert
)
1254 (goto-char orig-point
)))
1258 (defun bookmark-delete (bookmark &optional batch
)
1259 "Delete BOOKMARK from the bookmark list.
1260 Removes only the first instance of a bookmark with that name. If
1261 there are one or more other bookmarks with the same name, they will
1262 not be deleted. Defaults to the \"current\" bookmark \(that is, the
1263 one most recently used in this file, if any\).
1264 Optional second arg BATCH means don't update the bookmark list buffer,
1265 probably because we were called from there."
1267 (bookmark-completing-read "Delete bookmark" bookmark-current-bookmark
))
1268 (bookmark-maybe-historicize-string bookmark
)
1269 (bookmark-maybe-load-default-file)
1270 (let ((will-go (bookmark-get-bookmark bookmark
)))
1271 (setq bookmark-alist
(delq will-go bookmark-alist
))
1272 ;; Added by db, nil bookmark-current-bookmark if the last
1273 ;; occurrence has been deleted
1274 (or (bookmark-get-bookmark bookmark-current-bookmark
)
1275 (setq bookmark-current-bookmark nil
)))
1276 ;; Don't rebuild the list
1279 (bookmark-bmenu-surreptitiously-rebuild-list)
1280 (setq bookmark-alist-modification-count
1281 (1+ bookmark-alist-modification-count
))
1282 (if (bookmark-time-to-save-p)
1286 (defun bookmark-time-to-save-p (&optional last-time
)
1287 ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu>
1288 ;; finds out whether it's time to save bookmarks to a file, by
1289 ;; examining the value of variable bookmark-save-flag, and maybe
1290 ;; bookmark-alist-modification-count. Returns t if they should be
1291 ;; saved, nil otherwise. if last-time is non-nil, then this is
1292 ;; being called when emacs is killed.
1294 (and (> bookmark-alist-modification-count
0)
1295 bookmark-save-flag
))
1296 ((numberp bookmark-save-flag
)
1297 (>= bookmark-alist-modification-count bookmark-save-flag
))
1303 (defun bookmark-write ()
1304 "Write bookmarks to a file (reading the file name with the minibuffer).
1305 Don't use this in Lisp programs; use `bookmark-save' instead."
1307 (bookmark-maybe-load-default-file)
1312 (defun bookmark-save (&optional parg file
)
1313 "Save currently defined bookmarks.
1314 Saves by default in the file defined by the variable
1315 `bookmark-default-file'. With a prefix arg, save it in file FILE
1316 \(second argument\).
1318 If you are calling this from Lisp, the two arguments are PREFIX-ARG
1319 and FILE, and if you just want it to write to the default file, then
1320 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1321 instead. If you pass in one argument, and it is non-nil, then the
1322 user will be interactively queried for a file to save in.
1324 When you want to load in the bookmarks from a file, use
1325 \`bookmark-load\', \\[bookmark-load]. That function will prompt you
1326 for a file, defaulting to the file defined by variable
1327 `bookmark-default-file'."
1329 (bookmark-maybe-load-default-file)
1331 ((and (null parg
) (null file
))
1332 ;;whether interactive or not, write to default file
1333 (bookmark-write-file bookmark-default-file
))
1334 ((and (null parg
) file
)
1335 ;;whether interactive or not, write to given file
1336 (bookmark-write-file file
))
1337 ((and parg
(not file
))
1338 ;;have been called interactively w/ prefix arg
1339 (let ((file (read-file-name "File to save bookmarks in: ")))
1340 (bookmark-write-file file
)))
1341 (t ; someone called us with prefix-arg *and* a file, so just write to file
1342 (bookmark-write-file file
)))
1343 ;; signal that we have synced the bookmark file by setting this to
1344 ;; 0. If there was an error at any point before, it will not get
1345 ;; set, which is what we want.
1346 (setq bookmark-alist-modification-count
0))
1350 (defun bookmark-write-file (file)
1352 (save-window-excursion
1353 (if (>= baud-rate
9600)
1354 (message "Saving bookmarks to file %s..." file
))
1355 (set-buffer (let ((enable-local-variables nil
))
1356 (find-file-noselect file
)))
1357 (goto-char (point-min))
1358 (delete-region (point-min) (point-max))
1359 (bookmark-insert-file-format-version-stamp)
1360 (pp bookmark-alist
(current-buffer))
1361 (let ((version-control
1363 ((null bookmark-version-control
) nil
)
1364 ((eq 'never bookmark-version-control
) 'never
)
1365 ((eq 'nospecial bookmark-version-control
) version-control
)
1369 (kill-buffer (current-buffer))
1370 (if (>= baud-rate
9600)
1371 (message "Saving bookmarks to file %s...done" file
))
1375 (defun bookmark-import-new-list (new-list)
1376 ;; Walk over the new list, adding each individual bookmark
1377 ;; carefully. "Carefully" means checking against the existing
1378 ;; bookmark-alist and renaming the new bookmarks with <N> extensions
1380 (let ((lst new-list
)
1381 (names (bookmark-all-names)))
1383 (let* ((full-record (car lst
)))
1384 (bookmark-maybe-rename full-record names
)
1385 (setq bookmark-alist
(nconc bookmark-alist
(list full-record
)))
1386 (setq names
(cons (bookmark-name-from-full-record full-record
) names
))
1387 (setq lst
(cdr lst
))))))
1390 (defun bookmark-maybe-rename (full-record names
)
1391 ;; just a helper for bookmark-import-new-list; it is only for
1392 ;; readability that this is not inlined.
1394 ;; Once this has found a free name, it sets full-record to that
1396 (let ((found-name (bookmark-name-from-full-record full-record
)))
1397 (if (member found-name names
)
1398 ;; We've got a conflict, so generate a new name
1400 (new-name found-name
))
1401 (while (member new-name names
)
1402 (setq new-name
(concat found-name
(format "<%d>" count
)))
1403 (setq count
(1+ count
)))
1404 (bookmark-set-name full-record new-name
)))))
1408 (defun bookmark-load (file &optional overwrite no-msg
)
1409 "Load bookmarks from FILE (which must be in bookmark format).
1410 Appends loaded bookmarks to the front of the list of bookmarks. If
1411 optional second argument OVERWRITE is non-nil, existing bookmarks are
1412 destroyed. Optional third arg NO-MSG means don't display any messages
1415 If you load a file that doesn't contain a proper bookmark alist, you
1416 will corrupt Emacs's bookmark list. Generally, you should only load
1417 in files that were created with the bookmark functions in the first
1418 place. Your own personal bookmark file, `~/.emacs.bmk', is
1419 maintained automatically by Emacs; you shouldn't need to load it
1422 If you load a file containing bookmarks with the same names as
1423 bookmarks already present in your Emacs, the new bookmarks will get
1424 unique numeric suffixes \"<2>\", \"<3>\", ... following the same
1425 method buffers use to resolve name collisions."
1427 (list (read-file-name
1428 (format "Load bookmarks from: (%s) "
1429 bookmark-default-file
)
1430 ;;Default might not be used often,
1431 ;;but there's no better default, and
1432 ;;I guess it's better than none at all.
1433 "~/" bookmark-default-file
'confirm
)))
1434 (setq file
(expand-file-name file
))
1435 (if (file-readable-p file
)
1437 (save-window-excursion
1438 (if (and (null no-msg
) (>= baud-rate
9600))
1439 (message "Loading bookmarks from %s..." file
))
1440 (set-buffer (let ((enable-local-variables nil
))
1441 (find-file-noselect file
)))
1442 (goto-char (point-min))
1443 (bookmark-maybe-upgrade-file-format)
1444 (let ((blist (bookmark-alist-from-buffer)))
1449 (setq bookmark-alist blist
)
1450 (setq bookmark-alist-modification-count
0))
1452 (bookmark-import-new-list blist
)
1453 (setq bookmark-alist-modification-count
1454 (1+ bookmark-alist-modification-count
)))
1456 (expand-file-name bookmark-default-file
)
1458 (setq bookmarks-already-loaded t
))
1459 (bookmark-bmenu-surreptitiously-rebuild-list))
1460 (error "Invalid bookmark list in %s" file
)))
1461 (kill-buffer (current-buffer)))
1462 (if (and (null no-msg
) (>= baud-rate
9600))
1463 (message "Loading bookmarks from %s...done" file
)))
1464 (error "Cannot read bookmark file %s" file
)))
1468 ;;; Code supporting the dired-like bookmark menu. Prefix is
1469 ;;; "bookmark-bmenu" for "buffer-menu":
1472 (defvar bookmark-bmenu-bookmark-column nil
)
1475 (defvar bookmark-bmenu-hidden-bookmarks
())
1478 (defvar bookmark-bmenu-mode-map nil
)
1481 (if bookmark-bmenu-mode-map
1483 (setq bookmark-bmenu-mode-map
(make-keymap))
1484 (suppress-keymap bookmark-bmenu-mode-map t
)
1485 (define-key bookmark-bmenu-mode-map
"q" 'bookmark-bmenu-quit
)
1486 (define-key bookmark-bmenu-mode-map
"v" 'bookmark-bmenu-select
)
1487 (define-key bookmark-bmenu-mode-map
"w" 'bookmark-bmenu-locate
)
1488 (define-key bookmark-bmenu-mode-map
"2" 'bookmark-bmenu-2-window
)
1489 (define-key bookmark-bmenu-mode-map
"1" 'bookmark-bmenu-1-window
)
1490 (define-key bookmark-bmenu-mode-map
"j" 'bookmark-bmenu-this-window
)
1491 (define-key bookmark-bmenu-mode-map
"\C-c\C-c" 'bookmark-bmenu-this-window
)
1492 (define-key bookmark-bmenu-mode-map
"f" 'bookmark-bmenu-this-window
)
1493 (define-key bookmark-bmenu-mode-map
"o" 'bookmark-bmenu-other-window
)
1494 (define-key bookmark-bmenu-mode-map
"\C-o"
1495 'bookmark-bmenu-switch-other-window
)
1496 (define-key bookmark-bmenu-mode-map
"s" 'bookmark-bmenu-save
)
1497 (define-key bookmark-bmenu-mode-map
"k" 'bookmark-bmenu-delete
)
1498 (define-key bookmark-bmenu-mode-map
"\C-d" 'bookmark-bmenu-delete-backwards
)
1499 (define-key bookmark-bmenu-mode-map
"x" 'bookmark-bmenu-execute-deletions
)
1500 (define-key bookmark-bmenu-mode-map
"d" 'bookmark-bmenu-delete
)
1501 (define-key bookmark-bmenu-mode-map
" " 'next-line
)
1502 (define-key bookmark-bmenu-mode-map
"n" 'next-line
)
1503 (define-key bookmark-bmenu-mode-map
"p" 'previous-line
)
1504 (define-key bookmark-bmenu-mode-map
"\177" 'bookmark-bmenu-backup-unmark
)
1505 (define-key bookmark-bmenu-mode-map
"?" 'describe-mode
)
1506 (define-key bookmark-bmenu-mode-map
"u" 'bookmark-bmenu-unmark
)
1507 (define-key bookmark-bmenu-mode-map
"m" 'bookmark-bmenu-mark
)
1508 (define-key bookmark-bmenu-mode-map
"l" 'bookmark-bmenu-load
)
1509 (define-key bookmark-bmenu-mode-map
"r" 'bookmark-bmenu-rename
)
1510 (define-key bookmark-bmenu-mode-map
"t" 'bookmark-bmenu-toggle-filenames
)
1511 (define-key bookmark-bmenu-mode-map
"a" 'bookmark-bmenu-show-annotation
)
1512 (define-key bookmark-bmenu-mode-map
"A" 'bookmark-bmenu-show-all-annotations
)
1513 (define-key bookmark-bmenu-mode-map
"e" 'bookmark-bmenu-edit-annotation
)
1514 (define-key bookmark-bmenu-mode-map
[mouse-2
]
1515 'bookmark-bmenu-other-window-with-mouse
))
1519 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1521 (put 'bookmark-bmenu-mode
'mode-class
'special
)
1524 ;; todo: need to display whether or not bookmark exists as a buffer in
1528 ;; FLAGS BOOKMARK [ LOCATION ]
1531 (defun bookmark-bmenu-surreptitiously-rebuild-list ()
1532 "Rebuild the Bookmark List if it exists.
1533 Don't affect the buffer ring order."
1534 (if (get-buffer "*Bookmark List*")
1536 (save-window-excursion
1537 (bookmark-bmenu-list)))))
1541 (defun bookmark-bmenu-list ()
1542 "Display a list of existing bookmarks.
1543 The list is displayed in a buffer named `*Bookmark List*'.
1544 The leftmost column displays a D if the bookmark is flagged for
1545 deletion, or > if it is flagged for displaying."
1547 (bookmark-maybe-load-default-file)
1549 (switch-to-buffer (get-buffer-create "*Bookmark List*"))
1550 (set-buffer (get-buffer-create "*Bookmark List*")))
1551 (let ((buffer-read-only nil
))
1552 (delete-region (point-max) (point-min))
1553 (goto-char (point-min)) ;sure are playing it safe...
1554 (insert "% Bookmark\n- --------\n")
1555 (bookmark-maybe-sort-alist)
1557 (lambda (full-record)
1558 ;; if a bookmark has an annotation, prepend a "*"
1559 ;; in the list of bookmarks.
1560 (let ((annotation (bookmark-get-annotation
1561 (bookmark-name-from-full-record full-record
))))
1562 (if (and annotation
(not (string-equal annotation
"")))
1565 (let ((start (point)))
1566 (insert (bookmark-name-from-full-record full-record
))
1568 (put-text-property start
1569 (save-excursion (re-search-backward
1572 'mouse-face
'highlight
))
1576 (goto-char (point-min))
1578 (bookmark-bmenu-mode)
1579 (if bookmark-bmenu-toggle-filenames
1580 (bookmark-bmenu-toggle-filenames t
)))
1583 (defalias 'list-bookmarks
'bookmark-bmenu-list
)
1585 (defalias 'edit-bookmarks
'bookmark-bmenu-list
)
1589 (defun bookmark-bmenu-mode ()
1590 "Major mode for editing a list of bookmarks.
1591 Each line describes one of the bookmarks in Emacs.
1592 Letters do not insert themselves; instead, they are commands.
1593 Bookmark names preceded by a \"*\" have annotations.
1594 \\<bookmark-bmenu-mode-map>
1595 \\[bookmark-bmenu-mark] -- mark bookmark to be displayed.
1596 \\[bookmark-bmenu-select] -- select bookmark of line point is on.
1597 Also show bookmarks marked using m in other windows.
1598 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1599 \\[bookmark-bmenu-locate] -- display (in minibuffer) location of this bookmark.
1600 \\[bookmark-bmenu-1-window] -- select this bookmark in full-frame window.
1601 \\[bookmark-bmenu-2-window] -- select this bookmark in one window,
1602 together with bookmark selected before this one in another window.
1603 \\[bookmark-bmenu-this-window] -- select this bookmark in place of the bookmark menu buffer.
1604 \\[bookmark-bmenu-other-window] -- select this bookmark in another window,
1605 so the bookmark menu bookmark remains visible in its window.
1606 \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark.
1607 \\[bookmark-bmenu-rename] -- rename this bookmark \(prompts for new name\).
1608 \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down.
1609 \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up.
1610 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1611 \\[bookmark-bmenu-save] -- save the current bookmark list in the default file.
1612 With a prefix arg, prompts for a file to save in.
1613 \\[bookmark-bmenu-load] -- load in a file of bookmarks (prompts for file.)
1614 \\[bookmark-bmenu-unmark] -- remove all kinds of marks from current line.
1615 With prefix argument, also move up one line.
1616 \\[bookmark-bmenu-backup-unmark] -- back up a line and remove marks.
1617 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1619 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1620 \\[bookmark-bmenu-edit-annotation] -- edit the annotation for the current bookmark."
1621 (kill-all-local-variables)
1622 (use-local-map bookmark-bmenu-mode-map
)
1623 (setq truncate-lines t
)
1624 (setq buffer-read-only t
)
1625 (setq major-mode
'bookmark-bmenu-mode
)
1626 (setq mode-name
"Bookmark Menu")
1627 (run-hooks 'bookmark-bmenu-mode-hook
))
1630 (defun bookmark-bmenu-toggle-filenames (&optional show
)
1631 "Toggle whether filenames are shown in the bookmark list.
1632 Optional argument SHOW means show them unconditionally."
1636 (setq bookmark-bmenu-toggle-filenames nil
)
1637 (bookmark-bmenu-show-filenames)
1638 (setq bookmark-bmenu-toggle-filenames t
))
1639 (bookmark-bmenu-toggle-filenames
1640 (bookmark-bmenu-hide-filenames)
1641 (setq bookmark-bmenu-toggle-filenames nil
))
1643 (bookmark-bmenu-show-filenames)
1644 (setq bookmark-bmenu-toggle-filenames t
))))
1647 (defun bookmark-bmenu-show-filenames (&optional force
)
1648 (if (and (not force
) bookmark-bmenu-toggle-filenames
)
1649 nil
;already shown, so do nothing
1651 (save-window-excursion
1652 (goto-char (point-min))
1654 (setq bookmark-bmenu-hidden-bookmarks
())
1655 (let ((buffer-read-only nil
))
1656 (while (< (point) (point-max))
1657 (let ((bmrk (bookmark-bmenu-bookmark)))
1658 (setq bookmark-bmenu-hidden-bookmarks
1659 (cons bmrk bookmark-bmenu-hidden-bookmarks
))
1660 (let ((start (save-excursion (end-of-line) (point))))
1661 (move-to-column bookmark-bmenu-file-column t
)
1662 ;; Strip off `mouse-face' from the white spaces region.
1664 (remove-text-properties start
(point)
1666 (delete-region (point) (progn (end-of-line) (point)))
1668 ;; Pass the NO-HISTORY arg:
1669 (bookmark-insert-location bmrk t
)
1670 (forward-line 1))))))))
1673 (defun bookmark-bmenu-hide-filenames (&optional force
)
1674 (if (and (not force
) bookmark-bmenu-toggle-filenames
)
1675 ;; nothing to hide if above is nil
1677 (save-window-excursion
1678 (goto-char (point-min))
1680 (setq bookmark-bmenu-hidden-bookmarks
1681 (nreverse bookmark-bmenu-hidden-bookmarks
))
1683 (goto-char (point-min))
1684 (search-forward "Bookmark")
1686 (setq bookmark-bmenu-bookmark-column
(current-column)))
1688 (let ((buffer-read-only nil
))
1689 (while bookmark-bmenu-hidden-bookmarks
1690 (move-to-column bookmark-bmenu-bookmark-column t
)
1691 (bookmark-kill-line)
1692 (let ((start (point)))
1693 (insert (car bookmark-bmenu-hidden-bookmarks
))
1695 (put-text-property start
1696 (save-excursion (re-search-backward
1699 'mouse-face
'highlight
)))
1700 (setq bookmark-bmenu-hidden-bookmarks
1701 (cdr bookmark-bmenu-hidden-bookmarks
))
1702 (forward-line 1))))))))
1705 (defun bookmark-bmenu-check-position ()
1706 ;; Returns non-nil if on a line with a bookmark.
1707 ;; (The actual value returned is bookmark-alist).
1708 ;; Else reposition and try again, else return nil.
1709 (cond ((< (count-lines (point-min) (point)) 2)
1710 (goto-char (point-min))
1713 ((and (bolp) (eobp))
1714 (beginning-of-line 0)
1720 (defun bookmark-bmenu-bookmark ()
1721 ;; return a string which is bookmark of this line.
1722 (if (bookmark-bmenu-check-position)
1724 (save-window-excursion
1725 (goto-char (point-min))
1726 (search-forward "Bookmark")
1728 (setq bookmark-bmenu-bookmark-column
(current-column)))))
1729 (if bookmark-bmenu-toggle-filenames
1730 (bookmark-bmenu-hide-filenames))
1732 (save-window-excursion
1734 (forward-char bookmark-bmenu-bookmark-column
)
1736 (buffer-substring-no-properties (point)
1740 ;; well, this is certainly crystal-clear:
1741 (if bookmark-bmenu-toggle-filenames
1742 (bookmark-bmenu-toggle-filenames t
))))))
1745 (defun bookmark-show-annotation (bookmark)
1746 "Display the annotation for bookmark named BOOKMARK in a buffer,
1747 if an annotation exists."
1748 (let ((annotation (bookmark-get-annotation bookmark
)))
1749 (if (and annotation
(not (string-equal annotation
"")))
1751 (let ((old-buf (current-buffer)))
1752 (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t
)
1753 (delete-region (point-min) (point-max))
1754 ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n"))
1756 (goto-char (point-min))
1757 (pop-to-buffer old-buf
))))))
1760 (defun bookmark-show-all-annotations ()
1761 "Display the annotations for all bookmarks in a buffer."
1762 (let ((old-buf (current-buffer)))
1763 (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t
)
1764 (delete-region (point-min) (point-max))
1766 (lambda (full-record)
1767 (let* ((name (bookmark-name-from-full-record full-record
))
1768 (ann (bookmark-get-annotation name
)))
1769 (insert (concat name
":\n"))
1770 (if (and ann
(not (string-equal ann
"")))
1771 ;; insert the annotation, indented by 4 spaces.
1773 (save-excursion (insert ann
))
1774 (while (< (point) (point-max))
1775 (beginning-of-line) ; paranoia
1780 (goto-char (point-min))
1781 (pop-to-buffer old-buf
)))
1784 (defun bookmark-bmenu-mark ()
1785 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1788 (if (bookmark-bmenu-check-position)
1789 (let ((buffer-read-only nil
))
1793 (bookmark-bmenu-check-position))))
1796 (defun bookmark-bmenu-select ()
1797 "Select this line's bookmark; also display bookmarks marked with `>'.
1798 You can mark bookmarks with the \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-mark] command."
1800 (if (bookmark-bmenu-check-position)
1801 (let ((bmrk (bookmark-bmenu-bookmark))
1802 (menu (current-buffer))
1805 (goto-char (point-min))
1806 (while (re-search-forward "^>" nil t
)
1807 (setq tem
(bookmark-bmenu-bookmark))
1808 (let ((buffer-read-only nil
))
1811 (or (string-equal tem bmrk
)
1813 (setq others
(cons tem others
))))
1814 (setq others
(nreverse others
)
1815 tem
(/ (1- (frame-height)) (1+ (length others
))))
1816 (delete-other-windows)
1817 (bookmark-jump bmrk
)
1821 (split-window nil tem
)
1823 (bookmark-jump (car others
))
1824 (setq others
(cdr others
)))
1825 (other-window 1)))))
1828 (defun bookmark-bmenu-save (parg)
1829 "Save the current list into a bookmark file.
1830 With a prefix arg, prompts for a file to save them in."
1833 (save-window-excursion
1834 (bookmark-save parg
))))
1837 (defun bookmark-bmenu-load ()
1838 "Load the bookmark file and rebuild the bookmark menu-buffer."
1840 (if (bookmark-bmenu-check-position)
1842 (save-window-excursion
1843 ;; This will call `bookmark-bmenu-list'
1844 (call-interactively 'bookmark-load
)))))
1847 (defun bookmark-bmenu-1-window ()
1848 "Select this line's bookmark, alone, in full frame."
1850 (if (bookmark-bmenu-check-position)
1852 (bookmark-jump (bookmark-bmenu-bookmark))
1853 (bury-buffer (other-buffer))
1854 (delete-other-windows))))
1857 (defun bookmark-bmenu-2-window ()
1858 "Select this line's bookmark, with previous buffer in second window."
1860 (if (bookmark-bmenu-check-position)
1861 (let ((bmrk (bookmark-bmenu-bookmark))
1862 (menu (current-buffer))
1864 (delete-other-windows)
1865 (switch-to-buffer (other-buffer))
1866 (let* ((pair (bookmark-jump-noselect bmrk
))
1869 (pop-to-buffer buff
)
1871 (bury-buffer menu
))))
1874 (defun bookmark-bmenu-this-window ()
1875 "Select this line's bookmark in this window."
1877 (if (bookmark-bmenu-check-position)
1878 (bookmark-jump (bookmark-bmenu-bookmark))))
1881 (defun bookmark-bmenu-other-window ()
1882 "Select this line's bookmark in other window, leaving bookmark menu visible."
1884 (let ((bookmark (bookmark-bmenu-bookmark)))
1885 (if (bookmark-bmenu-check-position)
1886 (let* ((pair (bookmark-jump-noselect bookmark
))
1889 (switch-to-buffer-other-window buff
)
1891 (set-window-point (get-buffer-window buff
) pos
)
1892 (bookmark-show-annotation bookmark
)))))
1895 (defun bookmark-bmenu-switch-other-window ()
1896 "Make the other window select this line's bookmark.
1897 The current window remains selected."
1899 (let ((bookmark (bookmark-bmenu-bookmark)))
1900 (if (bookmark-bmenu-check-position)
1901 (let* ((pair (bookmark-jump-noselect bookmark
))
1904 (display-buffer buff
)
1905 (let ((o-buffer (current-buffer)))
1906 ;; save-excursion won't do
1909 (set-window-point (get-buffer-window buff
) pos
)
1910 (set-buffer o-buffer
))
1911 (bookmark-show-annotation bookmark
)))))
1913 (defun bookmark-bmenu-other-window-with-mouse (event)
1914 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1917 (set-buffer (window-buffer (posn-window (event-end event
))))
1919 (goto-char (posn-point (event-end event
)))
1920 (bookmark-bmenu-other-window))))
1923 (defun bookmark-bmenu-show-annotation ()
1924 "Show the annotation for the current bookmark in another window."
1926 (let ((bookmark (bookmark-bmenu-bookmark)))
1927 (if (bookmark-bmenu-check-position)
1928 (bookmark-show-annotation bookmark
))))
1931 (defun bookmark-bmenu-show-all-annotations ()
1932 "Show the annotation for all bookmarks in another window."
1934 (bookmark-show-all-annotations))
1937 (defun bookmark-bmenu-edit-annotation ()
1938 "Edit the annotation for the current bookmark in another window."
1940 (let ((bookmark (bookmark-bmenu-bookmark)))
1941 (if (bookmark-bmenu-check-position)
1942 (bookmark-edit-annotation bookmark
))))
1945 (defun bookmark-bmenu-quit ()
1946 "Quit the bookmark menu."
1948 (let ((buffer (current-buffer)))
1949 (switch-to-buffer (other-buffer))
1950 (bury-buffer buffer
)))
1953 (defun bookmark-bmenu-unmark (&optional backup
)
1954 "Cancel all requested operations on bookmark on this line and move down.
1955 Optional BACKUP means move up."
1958 (if (bookmark-bmenu-check-position)
1960 (let ((buffer-read-only nil
))
1962 ;; any flags to reset according to circumstances? How about a
1963 ;; flag indicating whether this bookmark is being visited?
1964 ;; well, we don't have this now, so maybe later.
1966 (forward-line (if backup -
1 1))
1967 (bookmark-bmenu-check-position))))
1970 (defun bookmark-bmenu-backup-unmark ()
1971 "Move up and cancel all requested operations on bookmark on line above."
1974 (if (bookmark-bmenu-check-position)
1976 (bookmark-bmenu-unmark)
1978 (bookmark-bmenu-check-position))))
1981 (defun bookmark-bmenu-delete ()
1982 "Mark bookmark on this line to be deleted.
1983 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1986 (if (bookmark-bmenu-check-position)
1987 (let ((buffer-read-only nil
))
1991 (bookmark-bmenu-check-position))))
1994 (defun bookmark-bmenu-delete-backwards ()
1995 "Mark bookmark on this line to be deleted, then move up one line.
1996 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1998 (bookmark-bmenu-delete)
2000 (if (bookmark-bmenu-check-position)
2002 (bookmark-bmenu-check-position))
2005 (defun bookmark-bmenu-execute-deletions ()
2006 "Delete bookmarks marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands."
2008 (message "Deleting bookmarks...")
2009 (let ((hide-em bookmark-bmenu-toggle-filenames
)
2011 (o-str (save-excursion
2013 (if (looking-at "^D")
2017 (progn (end-of-line) (point))))))
2018 (o-col (current-column)))
2019 (if hide-em
(bookmark-bmenu-hide-filenames))
2020 (setq bookmark-bmenu-toggle-filenames nil
)
2021 (goto-char (point-min))
2023 (while (re-search-forward "^D" (point-max) t
)
2024 (bookmark-delete (bookmark-bmenu-bookmark) t
)) ; pass BATCH arg
2025 (bookmark-bmenu-list)
2026 (setq bookmark-bmenu-toggle-filenames hide-em
)
2027 (if bookmark-bmenu-toggle-filenames
2028 (bookmark-bmenu-toggle-filenames t
))
2031 (goto-char (point-min))
2032 (search-forward o-str
)
2034 (forward-char o-col
))
2035 (goto-char o-point
))
2037 (setq bookmark-alist-modification-count
2038 (1+ bookmark-alist-modification-count
))
2039 (if (bookmark-time-to-save-p)
2041 (message "Deleting bookmarks...done")
2045 (defun bookmark-bmenu-rename ()
2046 "Rename bookmark on current line. Prompts for a new name."
2048 (if (bookmark-bmenu-check-position)
2049 (let ((bmrk (bookmark-bmenu-bookmark))
2050 (thispoint (point)))
2051 (bookmark-rename bmrk
)
2052 (bookmark-bmenu-list)
2053 (goto-char thispoint
))))
2056 (defun bookmark-bmenu-locate ()
2057 "Display location of this bookmark. Displays in the minibuffer."
2059 (if (bookmark-bmenu-check-position)
2060 (let ((bmrk (bookmark-bmenu-bookmark)))
2061 (message (bookmark-location bmrk
)))))
2065 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2067 (defun bookmark-menu-build-paned-menu (name entries
)
2068 "Build a multi-paned menu named NAME from the strings in ENTRIES.
2069 That is, ENTRIES is a list of strings which appear as the choices
2070 in the menu. The number of panes depends on the number of entries.
2071 The visible entries are truncated to `bookmark-menu-length', but the
2072 strings returned are not."
2073 (let* ((f-height (/ (frame-height) 2))
2075 (let (temp-pane-list
2080 (while (and (< count f-height
) entries
)
2081 (let ((str (car entries
)))
2084 (if (> (length str
) bookmark-menu-length
)
2085 (substring str
0 bookmark-menu-length
)
2089 (setq entries
(cdr entries
))
2090 (setq count
(1+ count
))))
2091 (setq iter
(1+ iter
))
2096 (format "-*- %s (%d) -*-" name iter
)
2099 (nreverse temp-pane-list
))))
2102 (cons (concat "-*- " name
" -*-") pane-list
)))
2105 (defun bookmark-menu-popup-paned-menu (event name entries
)
2106 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2107 That is, ENTRIES is a list of strings which appear as the choices
2109 The number of panes depends on the number of entries."
2111 (x-popup-menu event
(bookmark-menu-build-paned-menu name entries
)))
2114 (defun bookmark-menu-popup-paned-bookmark-menu (event name
)
2115 "Pop up menu of bookmarks, return chosen bookmark.
2116 Pop up at EVENT, menu's name is NAME.
2117 The number of panes depends on the number of bookmarks."
2118 (bookmark-menu-popup-paned-menu event name
(bookmark-all-names)))
2121 (defun bookmark-popup-menu-and-apply-function (func-sym menu-label event
)
2122 ;; help function for making menus that need to apply a bookmark
2123 ;; function to a string.
2124 (let* ((choice (bookmark-menu-popup-paned-bookmark-menu
2126 (if choice
(apply func-sym
(list choice
)))))
2130 (defun bookmark-menu-insert (event)
2131 "Insert the text of the file pointed to by bookmark BOOKMARK.
2132 You may have a problem using this function if the value of variable
2133 `bookmark-alist' is nil. If that happens, you need to load in some
2134 bookmarks. See help on function `bookmark-load' for more about
2137 Warning: this function only takes an EVENT as argument. Use the
2138 corresponding bookmark function from Lisp \(the one without the
2139 \"-menu-\" in its name\)."
2141 (bookmark-popup-menu-and-apply-function
2142 'bookmark-insert
"Insert Bookmark Contents" event
))
2146 (defun bookmark-menu-jump (event)
2147 "Jump to bookmark BOOKMARK (a point in some file).
2148 You may have a problem using this function if the value of variable
2149 `bookmark-alist' is nil. If that happens, you need to load in some
2150 bookmarks. See help on function `bookmark-load' for more about
2153 Warning: this function only takes an EVENT as argument. Use the
2154 corresponding bookmark function from Lisp \(the one without the
2155 \"-menu-\" in its name\)."
2157 (bookmark-popup-menu-and-apply-function
2158 'bookmark-jump
"Jump to Bookmark" event
))
2162 (defun bookmark-menu-locate (event)
2163 "Insert the name of the file associated with BOOKMARK.
2164 \(This is not the same as the contents of that file\).
2166 Warning: this function only takes an EVENT as argument. Use the
2167 corresponding bookmark function from Lisp \(the one without the
2168 \"-menu-\" in its name\)."
2170 (bookmark-popup-menu-and-apply-function
2171 'bookmark-insert-location
"Insert Bookmark Location" event
))
2175 (defun bookmark-menu-rename (event)
2176 "Change the name of OLD-BOOKMARK to NEWNAME.
2177 If called from keyboard, prompts for OLD-BOOKMARK and NEWNAME.
2178 If called from menubar, OLD-BOOKMARK is selected from a menu, and
2179 prompts for NEWNAME.
2180 If called from Lisp, prompts for NEWNAME if only OLD-BOOKMARK was
2181 passed as an argument. If called with two strings, then no prompting
2182 is done. You must pass at least OLD-BOOKMARK when calling from Lisp.
2184 While you are entering the new name, consecutive C-w's insert
2185 consecutive words from the text of the buffer into the new bookmark
2188 Warning: this function only takes an EVENT as argument. Use the
2189 corresponding bookmark function from Lisp \(the one without the
2190 \"-menu-\" in its name\)."
2192 (bookmark-popup-menu-and-apply-function
2193 'bookmark-rename
"Rename Bookmark" event
))
2197 (defun bookmark-menu-delete (event)
2198 "Delete the bookmark named NAME from the bookmark list.
2199 Removes only the first instance of a bookmark with that name. If
2200 there are one or more other bookmarks with the same name, they will
2201 not be deleted. Defaults to the \"current\" bookmark \(that is, the
2202 one most recently used in this file, if any\).
2204 Warning: this function only takes an EVENT as argument. Use the
2205 corresponding bookmark function from Lisp \(the one without the
2206 \"-menu-\" in its name\)."
2208 (bookmark-popup-menu-and-apply-function
2209 'bookmark-delete
"Delete Bookmark" event
))
2212 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2213 ;; following works, and for explaining what to do to make it work.
2215 ;; We MUST autoload EACH form used to set up this variable's value, so
2216 ;; that the whole job is done in loaddefs.el.
2218 ;; Emacs menubar stuff.
2221 (defvar menu-bar-bookmark-map
(make-sparse-keymap "Bookmark functions"))
2224 (defalias 'menu-bar-bookmark-map
(symbol-value 'menu-bar-bookmark-map
))
2226 ;; make bookmarks appear toward the right side of the menu.
2227 (if (boundp 'menu-bar-final-items
)
2228 (if menu-bar-final-items
2229 (setq menu-bar-final-items
2230 (cons 'bookmark menu-bar-final-items
)))
2231 (setq menu-bar-final-items
'(bookmark)))
2234 (define-key menu-bar-bookmark-map
[load]
2235 '("Load a Bookmark File..." . bookmark-load))
2238 (define-key menu-bar-bookmark-map [write]
2239 '("Save Bookmarks As..." . bookmark-write))
2242 (define-key menu-bar-bookmark-map [save]
2243 '("Save Bookmarks" . bookmark-save))
2246 (define-key menu-bar-bookmark-map [edit]
2247 '("Edit Bookmark List" . bookmark-bmenu-list))
2250 (define-key menu-bar-bookmark-map [delete]
2251 '("Delete Bookmark" . bookmark-menu-delete))
2254 (define-key menu-bar-bookmark-map [rename]
2255 '("Rename Bookmark" . bookmark-menu-rename))
2258 (define-key menu-bar-bookmark-map [locate]
2259 '("Insert Location" . bookmark-menu-locate))
2262 (define-key menu-bar-bookmark-map [insert]
2263 '("Insert Contents" . bookmark-menu-insert))
2266 (define-key menu-bar-bookmark-map [set]
2267 '("Set Bookmark" . bookmark-set))
2270 (define-key menu-bar-bookmark-map [jump]
2271 '("Jump to Bookmark" . bookmark-menu-jump))
2273 ;;;; end bookmark menu stuff ;;;;
2277 (defvar bookmark-load-hook nil
2278 "Hook to run at the end of loading bookmark.")
2280 (run-hooks 'bookmark-load-hook)
2284 ;;; bookmark.el ends here