1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later
3 ;; Copyright (C) 1993-1997, 2001-2012 Free Software Foundation, Inc.
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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
27 ;; This package is for setting "bookmarks" in files. A bookmark
28 ;; associates a string with a location in a certain file. Thus, you
29 ;; can navigate your way to that location by providing the string.
30 ;; See the "User Variables" section for customizations.
36 (eval-when-compile (require 'cl-lib
))
40 ;; If variable bookmark-use-annotations is non-nil, an annotation is
41 ;; queried for when setting a bookmark.
43 ;; The bookmark list is sorted lexically by default, but you can turn
44 ;; this off by setting bookmark-sort-flag to nil. If it is nil, then
45 ;; the list will be presented in the order it is recorded
46 ;; (chronologically), which is actually fairly useful as well.
50 (defgroup bookmark nil
51 "Setting, annotation and jumping to bookmarks."
55 (defcustom bookmark-use-annotations nil
56 "If non-nil, saving a bookmark queries for an annotation in a buffer."
61 (defcustom bookmark-save-flag t
62 "Controls when Emacs saves bookmarks to a file.
63 --> nil means never save bookmarks, except when `bookmark-save' is
64 explicitly called (\\[bookmark-save]).
65 --> t means save bookmarks when Emacs is killed.
66 --> Otherwise, it should be a number that is the frequency with which
67 the bookmark list is saved (i.e.: the number of times which
68 Emacs's bookmark list may be modified before it is automatically
69 saved.). If it is a number, Emacs will also automatically save
70 bookmarks when it is killed.
72 Therefore, the way to get it to save every time you make or delete a
73 bookmark is to set this variable to 1 (or 0, which produces the same
76 To specify the file in which to save them, modify the variable
77 `bookmark-default-file', which is `~/.emacs.bmk' by default."
78 :type
'(choice (const nil
) integer
(other t
))
82 (defconst bookmark-old-default-file
"~/.emacs-bkmrks"
83 "The `.emacs.bmk' file used to be called this name.")
86 ;; defvared to avoid a compilation warning:
87 (defvar bookmark-file nil
88 "Old name for `bookmark-default-file'.")
90 (defcustom bookmark-default-file
92 ;; In case user set `bookmark-file' in her .emacs:
94 (locate-user-emacs-file "bookmarks" ".emacs.bmk"))
95 "File in which to save bookmarks by default."
100 (defcustom bookmark-version-control
'nospecial
101 "Whether or not to make numbered backups of the bookmark file.
102 It can have four values: t, nil, `never', and `nospecial'.
103 The first three have the same meaning that they do for the
104 variable `version-control', and the final value `nospecial' means just
105 use the value of `version-control'."
106 :type
'(choice (const nil
) (const never
) (const nospecial
)
111 (defcustom bookmark-completion-ignore-case t
112 "Non-nil means bookmark functions ignore case in completion."
117 (defcustom bookmark-sort-flag t
118 "Non-nil means that bookmarks will be displayed sorted by bookmark name.
119 Otherwise they will be displayed in LIFO order (that is, most
120 recently set ones come first, oldest ones come last)."
125 (defcustom bookmark-automatically-show-annotations t
126 "Non-nil means show annotations when jumping to a bookmark."
131 (defconst bookmark-bmenu-header-height
2
132 "Number of lines used for the *Bookmark List* header.")
134 (defconst bookmark-bmenu-marks-width
2
135 "Number of columns (chars) used for the *Bookmark List* marks column,
136 including the annotations column.")
138 (defcustom bookmark-bmenu-file-column
30
139 "Column at which to display filenames in a buffer listing bookmarks.
140 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
145 (defcustom bookmark-bmenu-toggle-filenames t
146 "Non-nil means show filenames when listing bookmarks.
147 A non-nil value may result in truncated bookmark names."
152 (defcustom bookmark-menu-length
70
153 "Maximum length of a bookmark name displayed on a popup menu."
157 ;; FIXME: Is it really worth a customization option?
158 (defcustom bookmark-search-delay
0.2
159 "Time before `bookmark-bmenu-search' updates the display."
163 (defface bookmark-menu-heading
164 '((t (:inherit font-lock-type-face
)))
165 "Face used to highlight the heading in bookmark menu buffers."
170 ;;; No user-serviceable parts beyond this point.
172 ;; Added for lucid emacs compatibility, db
173 (or (fboundp 'defalias
) (fset 'defalias
'fset
))
175 ;; suggested for lucid compatibility by david hughes:
176 (or (fboundp 'frame-height
) (defalias 'frame-height
'screen-height
))
181 ;; Set up these bindings dumping time *only*;
182 ;; if the user alters them, don't override the user when loading bookmark.el.
184 ;;;###autoload (define-key ctl-x-r-map "b" 'bookmark-jump)
185 ;;;###autoload (define-key ctl-x-r-map "m" 'bookmark-set)
186 ;;;###autoload (define-key ctl-x-r-map "l" 'bookmark-bmenu-list)
190 (let ((map (make-sparse-keymap)))
191 ;; Read the help on all of these functions for details...
192 (define-key map
"x" 'bookmark-set
)
193 (define-key map
"m" 'bookmark-set
) ;"m"ark
194 (define-key map
"j" 'bookmark-jump
)
195 (define-key map
"g" 'bookmark-jump
) ;"g"o
196 (define-key map
"o" 'bookmark-jump-other-window
)
197 (define-key map
"i" 'bookmark-insert
)
198 (define-key map
"e" 'edit-bookmarks
)
199 (define-key map
"f" 'bookmark-insert-location
) ;"f"ind
200 (define-key map
"r" 'bookmark-rename
)
201 (define-key map
"d" 'bookmark-delete
)
202 (define-key map
"l" 'bookmark-load
)
203 (define-key map
"w" 'bookmark-write
)
204 (define-key map
"s" 'bookmark-save
)
206 "Keymap containing bindings to bookmark functions.
207 It is not bound to any key by default: to bind it
208 so that you have a bookmark prefix, just use `global-set-key' and bind a
209 key of your choice to `bookmark-map'. All interactive bookmark
210 functions have a binding in this keymap.")
212 ;;;###autoload (fset 'bookmark-map bookmark-map)
215 ;;; Core variables and data structures:
216 (defvar bookmark-alist
()
217 "Association list of bookmarks and their records.
218 Bookmark functions update the value automatically.
219 You probably do NOT want to change the value yourself.
221 The value is an alist with entries of the form
223 (BOOKMARK-NAME . PARAM-ALIST)
225 or the deprecated form (BOOKMARK-NAME PARAM-ALIST).
227 BOOKMARK-NAME is the name you gave to the bookmark when creating it.
229 PARAM-ALIST is an alist of bookmark information. The order of the
230 entries in PARAM-ALIST is not important. The possible entries are
231 described below. An entry with a key but null value means the entry
234 (filename . FILENAME)
236 (front-context-string . STR-AFTER-POS)
237 (rear-context-string . STR-BEFORE-POS)
239 (annotation . ANNOTATION)
241 FILENAME names the bookmarked file.
242 POS is the bookmarked buffer position (position in the file).
243 STR-AFTER-POS is buffer text that immediately follows POS.
244 STR-BEFORE-POS is buffer text that immediately precedes POS.
245 ANNOTATION is a string that describes the bookmark.
246 See options `bookmark-use-annotations' and
247 `bookmark-automatically-show-annotations'.
248 HANDLER is a function that provides the bookmark-jump behavior for a
249 specific kind of bookmark. This is the case for Info bookmarks,
250 for instance. HANDLER must accept a bookmark as argument.")
252 (defvar bookmarks-already-loaded nil
253 "Non-nil if and only if bookmarks have been loaded from `bookmark-default-file'.")
256 ;; more stuff added by db.
258 (defvar bookmark-current-bookmark nil
259 "Name of bookmark most recently used in the current file.
260 It is buffer local, used to make moving a bookmark forward
261 through a file easier.")
263 (make-variable-buffer-local 'bookmark-current-bookmark
)
266 (defvar bookmark-alist-modification-count
0
267 "Number of modifications to bookmark list since it was last saved.")
270 (defvar bookmark-search-size
16
271 "Length of the context strings recorded on either side of a bookmark.")
274 (defvar bookmark-current-buffer nil
275 "The buffer in which a bookmark is currently being set or renamed.
276 Functions that insert strings into the minibuffer use this to know
277 the source buffer for that information; see `bookmark-yank-word'
281 (defvar bookmark-yank-point
0
282 "The next point from which to pull source text for `bookmark-yank-word'.
283 This point is in `bookmark-current-buffer'.")
286 (defvar bookmark-quit-flag nil
287 "Non nil make `bookmark-bmenu-search' quit immediately.")
289 ;; Helper functions and macros.
291 (defmacro with-buffer-modified-unmodified
(&rest body
)
292 "Run BODY while preserving the buffer's `buffer-modified-p' state."
293 (let ((was-modified (make-symbol "was-modified")))
294 `(let ((,was-modified
(buffer-modified-p)))
297 (set-buffer-modified-p ,was-modified
)))))
299 ;; Only functions below, in this page and the next one (file formats),
300 ;; need to know anything about the format of bookmark-alist entries.
301 ;; Everyone else should go through them.
303 (defun bookmark-name-from-full-record (bookmark-record)
304 "Return the name of BOOKMARK-RECORD. BOOKMARK-RECORD is, e.g.,
305 one element from `bookmark-alist'."
306 (car bookmark-record
))
309 (defun bookmark-all-names ()
310 "Return a list of all current bookmark names."
311 (bookmark-maybe-load-default-file)
312 (mapcar 'bookmark-name-from-full-record bookmark-alist
))
315 (defun bookmark-get-bookmark (bookmark-name-or-record &optional noerror
)
316 "Return the bookmark record corresponding to BOOKMARK-NAME-OR-RECORD.
317 If BOOKMARK-NAME-OR-RECORD is a string, look for the corresponding
318 bookmark record in `bookmark-alist'; return it if found, otherwise
319 error. Else if BOOKMARK-NAME-OR-RECORD is already a bookmark record,
322 ((consp bookmark-name-or-record
) bookmark-name-or-record
)
323 ((stringp bookmark-name-or-record
)
324 (or (assoc-string bookmark-name-or-record bookmark-alist
325 bookmark-completion-ignore-case
)
326 (unless noerror
(error "Invalid bookmark %s"
327 bookmark-name-or-record
))))))
330 (defun bookmark-get-bookmark-record (bookmark-name-or-record)
331 "Return the record portion of the entry for BOOKMARK-NAME-OR-RECORD in
332 `bookmark-alist' (that is, all information but the name)."
333 (let ((alist (cdr (bookmark-get-bookmark bookmark-name-or-record
))))
334 ;; The bookmark objects can either look like (NAME ALIST) or
335 ;; (NAME . ALIST), so we have to distinguish the two here.
336 (if (and (null (cdr alist
)) (consp (caar alist
)))
340 (defun bookmark-set-name (bookmark-name-or-record newname
)
341 "Set BOOKMARK-NAME-OR-RECORD's name to NEWNAME."
342 (setcar (bookmark-get-bookmark bookmark-name-or-record
) newname
))
344 (defun bookmark-prop-get (bookmark-name-or-record prop
)
345 "Return the property PROP of BOOKMARK-NAME-OR-RECORD, or nil if none."
346 (cdr (assq prop
(bookmark-get-bookmark-record bookmark-name-or-record
))))
348 (defun bookmark-prop-set (bookmark-name-or-record prop val
)
349 "Set the property PROP of BOOKMARK-NAME-OR-RECORD to VAL."
351 prop
(bookmark-get-bookmark-record bookmark-name-or-record
))))
354 (nconc (bookmark-get-bookmark-record bookmark-name-or-record
)
355 (list (cons prop val
))))))
357 (defun bookmark-get-annotation (bookmark-name-or-record)
358 "Return the annotation of BOOKMARK-NAME-OR-RECORD, or nil if none."
359 (bookmark-prop-get bookmark-name-or-record
'annotation
))
361 (defun bookmark-set-annotation (bookmark-name-or-record ann
)
362 "Set the annotation of BOOKMARK-NAME-OR-RECORD to ANN."
363 (bookmark-prop-set bookmark-name-or-record
'annotation ann
))
366 (defun bookmark-get-filename (bookmark-name-or-record)
367 "Return the full filename of BOOKMARK-NAME-OR-RECORD, or nil if none."
368 (bookmark-prop-get bookmark-name-or-record
'filename
))
371 (defun bookmark-set-filename (bookmark-name-or-record filename
)
372 "Set the full filename of BOOKMARK-NAME-OR-RECORD to FILENAME."
373 (bookmark-prop-set bookmark-name-or-record
'filename filename
))
376 (defun bookmark-get-position (bookmark-name-or-record)
377 "Return the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD, or nil if none."
378 (bookmark-prop-get bookmark-name-or-record
'position
))
381 (defun bookmark-set-position (bookmark-name-or-record position
)
382 "Set the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD to POSITION."
383 (bookmark-prop-set bookmark-name-or-record
'position position
))
386 (defun bookmark-get-front-context-string (bookmark-name-or-record)
387 "Return the front-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
388 (bookmark-prop-get bookmark-name-or-record
'front-context-string
))
391 (defun bookmark-set-front-context-string (bookmark-name-or-record string
)
392 "Set the front-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
393 (bookmark-prop-set bookmark-name-or-record
'front-context-string string
))
396 (defun bookmark-get-rear-context-string (bookmark-name-or-record)
397 "Return the rear-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
398 (bookmark-prop-get bookmark-name-or-record
'rear-context-string
))
401 (defun bookmark-set-rear-context-string (bookmark-name-or-record string
)
402 "Set the rear-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
403 (bookmark-prop-set bookmark-name-or-record
'rear-context-string string
))
406 (defun bookmark-get-handler (bookmark-name-or-record)
407 "Return the handler function for BOOKMARK-NAME-OR-RECORD, or nil if none."
408 (bookmark-prop-get bookmark-name-or-record
'handler
))
410 (defvar bookmark-history nil
411 "The history list for bookmark functions.")
414 (defun bookmark-completing-read (prompt &optional default
)
415 "Prompting with PROMPT, read a bookmark name in completion.
416 PROMPT will get a \": \" stuck on the end no matter what, so you
417 probably don't want to include one yourself.
418 Optional second arg DEFAULT is a string to return if the user enters
420 (bookmark-maybe-load-default-file) ; paranoia
421 (if (listp last-nonmenu-event
)
422 (bookmark-menu-popup-paned-menu t prompt
423 (if bookmark-sort-flag
424 (sort (bookmark-all-names)
426 (bookmark-all-names)))
427 (let* ((completion-ignore-case bookmark-completion-ignore-case
)
429 (prompt (concat prompt
(if default
430 (format " (%s): " default
)
433 (completing-read prompt
439 (if (string-equal "" str
) default str
))))
442 (defmacro bookmark-maybe-historicize-string
(string)
443 "Put STRING into the bookmark prompt history, if caller non-interactive.
444 We need this because sometimes bookmark functions are invoked from
445 menus, so `completing-read' never gets a chance to set `bookmark-history'."
447 (called-interactively-p 'interactive
)
448 (setq bookmark-history
(cons ,string bookmark-history
))))
450 (defvar bookmark-make-record-function
'bookmark-make-record-default
451 "A function that should be called to create a bookmark record.
452 Modes may set this variable buffer-locally to enable bookmarking of
453 locations that should be treated specially, such as Info nodes,
454 news posts, images, pdf documents, etc.
456 The function will be called with no arguments.
457 It should signal a user error if it is unable to construct a record for
458 the current location.
460 The returned record should be a cons cell of the form (NAME . ALIST)
461 where ALIST is as described in `bookmark-alist' and may typically contain
462 a special cons (handler . HANDLER-FUNC) which specifies the handler function
463 that should be used instead of `bookmark-default-handler' to open this
464 bookmark. See the documentation for `bookmark-alist' for more.
466 NAME is a suggested name for the constructed bookmark. It can be nil
467 in which case a default heuristic will be used. The function can also
468 equivalently just return ALIST without NAME.")
470 (defun bookmark-make-record ()
471 "Return a new bookmark record (NAME . ALIST) for the current location."
472 (let ((record (funcall bookmark-make-record-function
)))
476 (delq nil
(delete-dups (append (bookmark-prop-get record
'defaults
)
477 (list bookmark-current-bookmark
478 (bookmark-buffer-name))))))
479 ;; Set up default name.
480 (if (stringp (car record
))
481 ;; The function already provided a default name.
483 (if (car record
) (push nil record
))
484 (setcar record
(or bookmark-current-bookmark
(bookmark-buffer-name)))
487 (defun bookmark-store (name alist no-overwrite
)
488 "Store the bookmark NAME with data ALIST.
489 If NO-OVERWRITE is non-nil and another bookmark of the same name already
490 exists in `bookmark-alist', record the new bookmark without throwing away the
492 (bookmark-maybe-load-default-file)
493 (let ((stripped-name (copy-sequence name
)))
494 (or (featurep 'xemacs
)
495 ;; XEmacs's `set-text-properties' doesn't work on
496 ;; free-standing strings, apparently.
497 (set-text-properties 0 (length stripped-name
) nil stripped-name
))
498 (if (and (not no-overwrite
)
499 (bookmark-get-bookmark stripped-name
'noerror
))
500 ;; already existing bookmark under that name and
501 ;; no prefix arg means just overwrite old bookmark
502 ;; Use the new (NAME . ALIST) format.
503 (setcdr (bookmark-get-bookmark stripped-name
) alist
)
505 ;; otherwise just cons it onto the front (either the bookmark
506 ;; doesn't exist already, or there is no prefix arg. In either
507 ;; case, we want the new bookmark consed onto the alist...)
509 (push (cons stripped-name alist
) bookmark-alist
))
512 (setq bookmark-current-bookmark stripped-name
)
513 (setq bookmark-alist-modification-count
514 (1+ bookmark-alist-modification-count
))
515 (if (bookmark-time-to-save-p)
518 (setq bookmark-current-bookmark stripped-name
)
519 (bookmark-bmenu-surreptitiously-rebuild-list)))
521 (defun bookmark-make-record-default (&optional no-file no-context posn
)
522 "Return the record describing the location of a new bookmark.
523 Point should be at the buffer in which the bookmark is being set,
524 and normally should be at the position where the bookmark is desired,
525 but see the optional arguments for other possibilities.
527 If NO-FILE is non-nil, then only return the subset of the
528 record that pertains to the location within the buffer, leaving off
529 the part that records the filename.
531 If NO-CONTEXT is non-nil, do not include the front- and rear-context
532 strings in the record -- the position is enough.
534 If POSN is non-nil, record POSN as the point instead of `(point)'."
535 `(,@(unless no-file
`((filename .
,(bookmark-buffer-file-name))))
536 ,@(unless no-context
`((front-context-string
537 .
,(if (>= (- (point-max) (point))
538 bookmark-search-size
)
539 (buffer-substring-no-properties
541 (+ (point) bookmark-search-size
))
543 ,@(unless no-context
`((rear-context-string
544 .
,(if (>= (- (point) (point-min))
545 bookmark-search-size
)
546 (buffer-substring-no-properties
548 (- (point) bookmark-search-size
))
550 (position .
,(or posn
(point)))))
553 ;;; File format stuff
555 ;; *IMPORTANT NOTICE* If you are thinking about modifying (redefining)
556 ;; the bookmark file format -- please don't. The current format
557 ;; should be extensible enough. If you feel the need to change it,
558 ;; please discuss it with other Emacs developers first.
560 ;; The format of `bookmark-alist' has changed twice in its lifetime.
561 ;; This comment describes the three formats, FIRST, SECOND, and
564 ;; The FIRST format was used prior to Emacs 20:
566 ;; ((BOOKMARK-NAME (FILENAME
572 ;; The SECOND format was introduced in Emacs 20:
574 ;; ((BOOKMARK-NAME ((filename . FILENAME)
576 ;; (front-context-string . STR-AFTER-POS)
577 ;; (rear-context-string . STR-BEFORE-POS)
578 ;; (annotation . ANNOTATION)
579 ;; (whatever . VALUE)
584 ;; The CURRENT format was introduced in Emacs 22:
586 ;; ((BOOKMARK-NAME (filename . FILENAME)
588 ;; (front-context-string . STR-AFTER-POS)
589 ;; (rear-context-string . STR-BEFORE-POS)
590 ;; (annotation . ANNOTATION)
591 ;; (whatever . VALUE)
596 ;; Both FIRST and SECOND have the same level of nesting: the cadr of a
597 ;; bookmark record is a list of entry information. FIRST and SECOND
598 ;; differ in the form of the record information: FIRST uses a list of
599 ;; atoms, and SECOND uses an alist. In the FIRST format, the order of
600 ;; the list elements matters. In the SECOND format, the order of the
601 ;; alist elements is unimportant. The SECOND format facilitates the
602 ;; addition of new kinds of elements, to support new kinds of
603 ;; bookmarks or code evolution.
605 ;; The CURRENT format removes a level of nesting wrt FIRST and SECOND,
606 ;; saving one cons cell per bookmark: the cadr of a bookmark record is
607 ;; no longer a cons. Why that change was made remains a mystery --
608 ;; just be aware of it. (Be aware too that this explanatory comment
609 ;; was incorrect in Emacs 22 and Emacs 23.1.)
611 ;; To deal with the change from FIRST format to SECOND, conversion
612 ;; code was added, and it is still in use. See
613 ;; `bookmark-maybe-upgrade-file-format'.
615 ;; No conversion from SECOND to CURRENT is done. Instead, the code
616 ;; handles both formats OK. It must continue to do so.
618 ;; See the doc string of `bookmark-alist' for information about the
619 ;; elements that define a bookmark (e.g. `filename').
622 (defconst bookmark-file-format-version
1
623 "The current version of the format used by bookmark files.
624 You should never need to change this.")
627 (defconst bookmark-end-of-version-stamp-marker
628 "-*- End Of Bookmark File Format Version Stamp -*-\n"
629 "This string marks the end of the version stamp in a bookmark file.")
632 (defun bookmark-alist-from-buffer ()
633 "Return a `bookmark-alist' (in any format) from the current buffer.
634 The buffer must of course contain bookmark format information.
635 Does not care from where in the buffer it is called, and does not
638 (goto-char (point-min))
639 (if (search-forward bookmark-end-of-version-stamp-marker nil t
)
640 (read (current-buffer))
641 ;; Else we're dealing with format version 0
642 (if (search-forward "(" nil t
)
645 (read (current-buffer)))
646 ;; Else no hope of getting information here.
647 (error "Not bookmark format")))))
650 (defun bookmark-upgrade-version-0-alist (old-list)
651 "Upgrade a version 0 alist OLD-LIST to the current version."
654 (let* ((name (car bookmark
))
655 (record (car (cdr bookmark
)))
656 (filename (nth 0 record
))
657 (front-str (nth 1 record
))
658 (rear-str (nth 2 record
))
659 (position (nth 3 record
))
660 (ann (nth 4 record
)))
663 `((filename .
,filename
)
664 (front-context-string .
,(or front-str
""))
665 (rear-context-string .
,(or rear-str
""))
666 (position .
,position
)
667 (annotation .
,ann
)))))
671 (defun bookmark-upgrade-file-format-from-0 ()
672 "Upgrade a bookmark file of format 0 (the original format) to format 1.
673 This expects to be called from `point-min' in a bookmark file."
674 (message "Upgrading bookmark format from 0 to %d..."
675 bookmark-file-format-version
)
676 (let* ((old-list (bookmark-alist-from-buffer))
677 (new-list (bookmark-upgrade-version-0-alist old-list
)))
678 (delete-region (point-min) (point-max))
679 (bookmark-insert-file-format-version-stamp)
680 (pp new-list
(current-buffer))
682 (goto-char (point-min))
683 (message "Upgrading bookmark format from 0 to %d...done"
684 bookmark-file-format-version
)
688 (defun bookmark-grok-file-format-version ()
689 "Return an integer which is the file-format version of this bookmark file.
690 This expects to be called from `point-min' in a bookmark file."
691 (if (looking-at "^;;;;")
694 (re-search-forward "[0-9]")
696 (read (current-buffer))))
697 ;; Else this is format version 0, the original one, which didn't
698 ;; even have version stamps.
702 (defun bookmark-maybe-upgrade-file-format ()
703 "Check the file-format version of this bookmark file.
704 If the version is not up-to-date, upgrade it automatically.
705 This expects to be called from `point-min' in a bookmark file."
706 (let ((version (bookmark-grok-file-format-version)))
708 ((= version bookmark-file-format-version
)
709 ) ; home free -- version is current
711 (bookmark-upgrade-file-format-from-0))
713 (error "Bookmark file format version strangeness")))))
716 (defun bookmark-insert-file-format-version-stamp ()
717 "Insert text indicating current version of bookmark file format."
719 (format ";;;; Emacs Bookmark Format Version %d ;;;;\n"
720 bookmark-file-format-version
))
721 (insert ";;; This format is meant to be slightly human-readable;\n"
722 ";;; nevertheless, you probably don't want to edit it.\n"
724 bookmark-end-of-version-stamp-marker
))
727 ;;; end file-format stuff
732 (defun bookmark-maybe-message (fmt &rest args
)
733 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
734 (if (>= baud-rate
9600)
735 (apply 'message fmt args
)))
740 (defvar bookmark-minibuffer-read-name-map
741 (let ((map (make-sparse-keymap)))
742 (set-keymap-parent map minibuffer-local-map
)
743 (define-key map
"\C-w" 'bookmark-yank-word
)
747 (defun bookmark-set (&optional name no-overwrite
)
748 "Set a bookmark named NAME at the current location.
749 If name is nil, then prompt the user.
751 With a prefix arg (non-nil NO-OVERWRITE), do not overwrite any
752 existing bookmark that has the same name as NAME, but instead push the
753 new bookmark onto the bookmark alist. The most recently set bookmark
754 with name NAME is thus the one in effect at any given time, but the
755 others are still there, should the user decide to delete the most
758 To yank words from the text of the buffer and use them as part of the
759 bookmark name, type C-w while setting a bookmark. Successive C-w's
760 yank successive words.
762 Typing C-u inserts (at the bookmark name prompt) the name of the last
763 bookmark used in the document where the new bookmark is being set;
764 this helps you use a single bookmark name to track progress through a
765 large document. If there is no prior bookmark for this document, then
766 C-u inserts an appropriate name based on the buffer or file.
768 Use \\[bookmark-delete] to remove bookmarks (you give it a name and
769 it removes only the first instance of a bookmark with that name from
770 the list of bookmarks.)"
771 (interactive (list nil current-prefix-arg
))
773 (let* ((record (bookmark-make-record))
774 ;; `defaults' is a transient element of the
775 ;; extensible format described above in the section
776 ;; `File format stuff'. Bookmark record functions
777 ;; can use it to specify a list of default values
778 ;; accessible via M-n while reading a bookmark name.
779 (defaults (bookmark-prop-get record
'defaults
))
780 (default (if (consp defaults
) (car defaults
) defaults
)))
783 ;; Don't store default values in the record.
784 (setq record
(assq-delete-all 'defaults record
))
785 ;; When no defaults in the record, use its first element.
786 (setq defaults
(car record
) default defaults
))
788 (bookmark-maybe-load-default-file)
789 ;; Don't set `bookmark-yank-point' and `bookmark-current-buffer'
790 ;; if they have been already set in another buffer. (e.g gnus-art).
791 (unless (and bookmark-yank-point
792 bookmark-current-buffer
)
793 (setq bookmark-yank-point
(point))
794 (setq bookmark-current-buffer
(current-buffer)))
798 (read-from-minibuffer
799 (format "Set bookmark (%s): " default
)
801 bookmark-minibuffer-read-name-map
803 (and (string-equal str
"") (setq str default
))
804 (bookmark-store str
(cdr record
) no-overwrite
)
806 ;; Ask for an annotation buffer for this bookmark
807 (when bookmark-use-annotations
808 (bookmark-edit-annotation str
))))
809 (setq bookmark-yank-point nil
)
810 (setq bookmark-current-buffer nil
)))
813 (defun bookmark-kill-line (&optional newline-too
)
814 "Kill from point to end of line.
815 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
816 Does not affect the kill ring."
817 (let ((eol (line-end-position)))
818 (delete-region (point) eol
)
819 (if (and newline-too
(looking-at "\n"))
823 ;; Defvars to avoid compilation warnings:
824 (defvar bookmark-annotation-name nil
825 "Variable holding the name of the bookmark.
826 This is used in `bookmark-edit-annotation' to record the bookmark
827 whose annotation is being edited.")
830 (defun bookmark-default-annotation-text (bookmark-name)
831 "Return default annotation text for BOOKMARK-NAME.
832 The default annotation text is simply some text explaining how to use
834 (concat "# Type the annotation for bookmark '" bookmark-name
"' here.\n"
835 "# All lines which start with a '#' will be deleted.\n"
836 "# Type C-c C-c when done.\n#\n"
837 "# Author: " (user-full-name) " <" (user-login-name) "@"
839 "# Date: " (current-time-string) "\n"))
842 (define-obsolete-variable-alias 'bookmark-read-annotation-text-func
843 'bookmark-edit-annotation-text-func
"23.1")
844 (defvar bookmark-edit-annotation-text-func
'bookmark-default-annotation-text
845 "Function to return default text to use for a bookmark annotation.
846 It takes one argument, the name of the bookmark, as a string.")
848 (defvar bookmark-edit-annotation-mode-map
849 (let ((map (make-sparse-keymap)))
850 (set-keymap-parent map text-mode-map
)
851 (define-key map
"\C-c\C-c" 'bookmark-send-edited-annotation
)
853 "Keymap for editing an annotation of a bookmark.")
856 (defun bookmark-edit-annotation-mode (bookmark-name-or-record)
857 "Mode for editing the annotation of bookmark BOOKMARK-NAME-OR-RECORD.
858 When you have finished composing, type \\[bookmark-send-annotation].
860 \\{bookmark-edit-annotation-mode-map}"
862 (kill-all-local-variables)
863 (make-local-variable 'bookmark-annotation-name
)
864 (setq bookmark-annotation-name bookmark-name-or-record
)
865 (use-local-map bookmark-edit-annotation-mode-map
)
866 (setq major-mode
'bookmark-edit-annotation-mode
867 mode-name
"Edit Bookmark Annotation")
868 (insert (funcall bookmark-edit-annotation-text-func bookmark-name-or-record
))
869 (let ((annotation (bookmark-get-annotation bookmark-name-or-record
)))
870 (if (and annotation
(not (string-equal annotation
"")))
871 (insert annotation
)))
872 (run-mode-hooks 'text-mode-hook
))
875 (defun bookmark-send-edited-annotation ()
876 "Use buffer contents as annotation for a bookmark.
877 Lines beginning with `#' are ignored."
879 (if (not (eq major-mode
'bookmark-edit-annotation-mode
))
880 (error "Not in bookmark-edit-annotation-mode"))
881 (goto-char (point-min))
882 (while (< (point) (point-max))
883 (if (looking-at "^#")
884 (bookmark-kill-line t
)
886 ;; Take no chances with text properties.
887 (let ((annotation (buffer-substring-no-properties (point-min) (point-max)))
888 (bookmark-name bookmark-annotation-name
))
889 (bookmark-set-annotation bookmark-name annotation
)
890 (setq bookmark-alist-modification-count
891 (1+ bookmark-alist-modification-count
))
892 (bookmark-bmenu-surreptitiously-rebuild-list))
893 (kill-buffer (current-buffer)))
896 (defun bookmark-edit-annotation (bookmark-name-or-record)
897 "Pop up a buffer for editing bookmark BOOKMARK-NAME-OR-RECORD's annotation."
898 (pop-to-buffer (generate-new-buffer-name "*Bookmark Annotation Compose*"))
899 (bookmark-edit-annotation-mode bookmark-name-or-record
))
902 (defun bookmark-buffer-name ()
903 "Return the name of the current buffer in a form usable as a bookmark name.
904 If the buffer is associated with a file or directory, use that name."
907 (buffer-file-name (file-name-nondirectory buffer-file-name
))
908 ;; Or are we a directory?
909 ((and (boundp 'dired-directory
) dired-directory
)
910 (let* ((dirname (if (stringp dired-directory
)
912 (car dired-directory
)))
913 (idx (1- (length dirname
))))
914 ;; Strip the trailing slash.
915 (if (= ?
/ (aref dirname idx
))
916 (file-name-nondirectory (substring dirname
0 idx
))
917 ;; Else return the current-buffer
918 (buffer-name (current-buffer)))))
919 ;; If all else fails, use the buffer's name.
921 (buffer-name (current-buffer)))))
924 (defun bookmark-yank-word ()
925 "Get the next word from buffer `bookmark-current-buffer' and append
926 it to the name of the bookmark currently being set, advancing
927 `bookmark-yank-point' by one word."
929 (let ((string (with-current-buffer bookmark-current-buffer
930 (goto-char bookmark-yank-point
)
931 (buffer-substring-no-properties
935 (setq bookmark-yank-point
(point)))))))
938 (defun bookmark-buffer-file-name ()
939 "Return the current buffer's file in a way useful for bookmarks."
940 ;; Abbreviate the path, both so it's shorter and so it's more
941 ;; portable. E.g., the user's home dir might be a different
942 ;; path on different machines, but "~/" will still reach it.
943 (abbreviate-file-name
945 (buffer-file-name buffer-file-name
)
946 ((and (boundp 'dired-directory
) dired-directory
)
947 (if (stringp dired-directory
)
949 (car dired-directory
)))
950 (t (error "Buffer not visiting a file or directory")))))
953 (defun bookmark-maybe-load-default-file ()
954 "If bookmarks have not been loaded from the default place, load them."
955 (and (not bookmarks-already-loaded
)
956 (null bookmark-alist
)
959 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
961 (file-exists-p bookmark-old-default-file
)
962 (not (file-exists-p bookmark-default-file
))
963 (rename-file bookmark-old-default-file
964 bookmark-default-file
))
965 ;; return t so the `and' will continue...
968 (file-readable-p bookmark-default-file
)
969 (bookmark-load bookmark-default-file t t
)
970 (setq bookmarks-already-loaded t
)))
973 (defun bookmark-maybe-sort-alist ()
974 "Return `bookmark-alist' for display.
975 If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist."
976 (if bookmark-sort-flag
977 (sort (copy-alist bookmark-alist
)
979 (lambda (x y
) (string-lessp (car x
) (car y
)))))
983 (defvar bookmark-after-jump-hook nil
984 "Hook run after `bookmark-jump' jumps to a bookmark.
985 Useful for example to unhide text in `outline-mode'.")
987 (defun bookmark--jump-via (bookmark-name-or-record display-function
)
988 "Handle BOOKMARK-NAME-OR-RECORD, then call DISPLAY-FUNCTION with
989 current buffer as argument.
991 After calling DISPLAY-FUNCTION, set window point to the point specified
992 by BOOKMARK-NAME-OR-RECORD, if necessary, run `bookmark-after-jump-hook',
993 and then show any annotations for this bookmark."
994 (bookmark-handle-bookmark bookmark-name-or-record
)
996 (funcall display-function
(current-buffer)))
997 (let ((win (get-buffer-window (current-buffer) 0)))
998 (if win
(set-window-point win
(point))))
999 ;; FIXME: we used to only run bookmark-after-jump-hook in
1000 ;; `bookmark-jump' itself, but in none of the other commands.
1001 (run-hooks 'bookmark-after-jump-hook
)
1002 (if bookmark-automatically-show-annotations
1003 ;; if there is an annotation for this bookmark,
1004 ;; show it in a buffer.
1005 (bookmark-show-annotation bookmark-name-or-record
)))
1009 (defun bookmark-jump (bookmark &optional display-func
)
1010 "Jump to bookmark BOOKMARK (a point in some file).
1011 You may have a problem using this function if the value of variable
1012 `bookmark-alist' is nil. If that happens, you need to load in some
1013 bookmarks. See help on function `bookmark-load' for more about
1016 If the file pointed to by BOOKMARK no longer exists, you will be asked
1017 if you wish to give the bookmark a new location, and `bookmark-jump'
1018 will then jump to the new location, as well as recording it in place
1019 of the old one in the permanent bookmark record.
1021 BOOKMARK is usually a bookmark name (a string). It can also be a
1022 bookmark record, but this is usually only done by programmatic callers.
1024 If DISPLAY-FUNC is non-nil, it is a function to invoke to display the
1025 bookmark. It defaults to `switch-to-buffer'. A typical value for
1026 DISPLAY-FUNC would be `switch-to-buffer-other-window'."
1028 (list (bookmark-completing-read "Jump to bookmark"
1029 bookmark-current-bookmark
)))
1031 (error "No bookmark specified"))
1032 (bookmark-maybe-historicize-string bookmark
)
1033 (bookmark--jump-via bookmark
(or display-func
'switch-to-buffer
)))
1037 (defun bookmark-jump-other-window (bookmark)
1038 "Jump to BOOKMARK in another window. See `bookmark-jump' for more."
1040 (list (bookmark-completing-read "Jump to bookmark (in another window)"
1041 bookmark-current-bookmark
)))
1042 (bookmark-jump bookmark
'switch-to-buffer-other-window
))
1045 (defun bookmark-jump-noselect (bookmark)
1046 "Return the location pointed to by BOOKMARK (see `bookmark-jump').
1047 The return value has the form (BUFFER . POINT).
1049 Note: this function is deprecated and is present for Emacs 22
1050 compatibility only."
1052 (bookmark-handle-bookmark bookmark
)
1053 (cons (current-buffer) (point))))
1055 (make-obsolete 'bookmark-jump-noselect
'bookmark-handle-bookmark
"23.1")
1057 (defun bookmark-handle-bookmark (bookmark-name-or-record)
1058 "Call BOOKMARK-NAME-OR-RECORD's handler or `bookmark-default-handler'
1059 if it has none. This changes current buffer and point and returns nil,
1060 or signals a `file-error'.
1062 If BOOKMARK-NAME-OR-RECORD has no file, this is a no-op. If
1063 BOOKMARK-NAME-OR-RECORD has a file, but that file no longer exists,
1064 then offer interactively to relocate BOOKMARK-NAME-OR-RECORD."
1066 (funcall (or (bookmark-get-handler bookmark-name-or-record
)
1067 'bookmark-default-handler
)
1068 (bookmark-get-bookmark bookmark-name-or-record
))
1069 (bookmark-error-no-filename ;file-error
1070 ;; We were unable to find the marked file, so ask if user wants to
1071 ;; relocate the bookmark, else remind them to consider deletion.
1072 (when (stringp bookmark-name-or-record
)
1073 ;; `bookmark-name-or-record' can be either a bookmark name
1074 ;; (from `bookmark-alist') or a bookmark object. If it's an
1075 ;; object, we assume it's a bookmark used internally by some
1077 (let ((file (bookmark-get-filename bookmark-name-or-record
)))
1078 (when file
;Don't know how to relocate if there's no `file'.
1079 ;; If file is not a dir, directory-file-name just returns file.
1080 (let ((display-name (directory-file-name file
)))
1082 ;; Dialog boxes can accept a file target, but usually don't
1083 ;; know how to accept a directory target (at least, this
1084 ;; is true in Gnome on GNU/Linux, and Bug#4230 says it's
1085 ;; true on Windows as well). So we suppress file dialogs
1087 (let ((use-dialog-box nil
)
1088 (use-file-dialog nil
))
1089 (if (y-or-n-p (concat display-name
" nonexistent. Relocate \""
1090 bookmark-name-or-record
"\"? "))
1092 (bookmark-relocate bookmark-name-or-record
)
1094 (funcall (or (bookmark-get-handler bookmark-name-or-record
)
1095 'bookmark-default-handler
)
1096 (bookmark-get-bookmark bookmark-name-or-record
)))
1098 "Bookmark not relocated; consider removing it (%s)."
1099 bookmark-name-or-record
)
1100 (signal (car err
) (cdr err
))))))))))
1102 (when (stringp bookmark-name-or-record
)
1103 (setq bookmark-current-bookmark bookmark-name-or-record
))
1106 (put 'bookmark-error-no-filename
1108 '(error bookmark-errors bookmark-error-no-filename
))
1109 (put 'bookmark-error-no-filename
1111 "Bookmark has no associated file (or directory)")
1113 (defun bookmark-default-handler (bmk-record)
1114 "Default handler to jump to a particular bookmark location.
1115 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
1116 Changes current buffer and point and returns nil, or signals a `file-error'."
1117 (let ((file (bookmark-get-filename bmk-record
))
1118 (buf (bookmark-prop-get bmk-record
'buffer
))
1119 (forward-str (bookmark-get-front-context-string bmk-record
))
1120 (behind-str (bookmark-get-rear-context-string bmk-record
))
1121 (place (bookmark-get-position bmk-record
)))
1124 ((and file
(file-readable-p file
) (not (buffer-live-p buf
)))
1125 (find-file-noselect file
))
1126 ;; No file found. See if buffer BUF have been created.
1127 ((and buf
(get-buffer buf
)))
1128 (t ;; If not, raise error.
1129 (signal 'bookmark-error-no-filename
(list 'stringp file
)))))
1130 (if place
(goto-char place
))
1131 ;; Go searching forward first. Then, if forward-str exists and
1132 ;; was found in the file, we can search backward for behind-str.
1133 ;; Rationale is that if text was inserted between the two in the
1134 ;; file, it's better to be put before it so you can read it,
1135 ;; rather than after and remain perhaps unaware of the changes.
1136 (when (and forward-str
(search-forward forward-str
(point-max) t
))
1137 (goto-char (match-beginning 0)))
1138 (when (and behind-str
(search-backward behind-str
(point-min) t
))
1139 (goto-char (match-end 0)))
1143 (defun bookmark-relocate (bookmark-name)
1144 "Relocate BOOKMARK-NAME to another file, reading file name with minibuffer.
1146 This makes an already existing bookmark point to that file, instead of
1147 the one it used to point at. Useful when a file has been renamed
1148 after a bookmark was set in it."
1149 (interactive (list (bookmark-completing-read "Bookmark to relocate")))
1150 (bookmark-maybe-historicize-string bookmark-name
)
1151 (bookmark-maybe-load-default-file)
1152 (let* ((bmrk-filename (bookmark-get-filename bookmark-name
))
1153 (newloc (abbreviate-file-name
1156 (format "Relocate %s to: " bookmark-name
)
1157 (file-name-directory bmrk-filename
))))))
1158 (bookmark-set-filename bookmark-name newloc
)
1159 (setq bookmark-alist-modification-count
1160 (1+ bookmark-alist-modification-count
))
1161 (if (bookmark-time-to-save-p)
1163 (bookmark-bmenu-surreptitiously-rebuild-list)))
1167 (defun bookmark-insert-location (bookmark-name &optional no-history
)
1168 "Insert the name of the file associated with BOOKMARK-NAME.
1170 Optional second arg NO-HISTORY means don't record this in the
1171 minibuffer history list `bookmark-history'."
1172 (interactive (list (bookmark-completing-read "Insert bookmark location")))
1173 (or no-history
(bookmark-maybe-historicize-string bookmark-name
))
1174 (let ((start (point)))
1176 (insert (bookmark-location bookmark-name
))
1177 (if (display-mouse-p)
1178 (add-text-properties
1180 (save-excursion (re-search-backward
1183 '(mouse-face highlight
1185 help-echo
"mouse-2: go to this bookmark in other window"))))))
1188 (defalias 'bookmark-locate
'bookmark-insert-location
)
1190 (defun bookmark-location (bookmark-name-or-record)
1191 "Return a description of the location of BOOKMARK-NAME-OR-RECORD."
1192 (bookmark-maybe-load-default-file)
1193 ;; We could call the `handler' and ask for it to construct a description
1194 ;; dynamically: it would open up several new possibilities, but it
1195 ;; would have the major disadvantage of forcing to load each and
1196 ;; every handler when the user calls bookmark-menu.
1197 (or (bookmark-prop-get bookmark-name-or-record
'location
)
1198 (bookmark-get-filename bookmark-name-or-record
)
1199 "-- Unknown location --"))
1203 (defun bookmark-rename (old-name &optional new-name
)
1204 "Change the name of OLD-NAME bookmark to NEW-NAME name.
1205 If called from keyboard, prompt for OLD-NAME and NEW-NAME.
1206 If called from menubar, select OLD-NAME from a menu and prompt for NEW-NAME.
1208 If called from Lisp, prompt for NEW-NAME if only OLD-NAME was passed
1209 as an argument. If called with two strings, then no prompting is done.
1210 You must pass at least OLD-NAME when calling from Lisp.
1212 While you are entering the new name, consecutive C-w's insert
1213 consecutive words from the text of the buffer into the new bookmark
1215 (interactive (list (bookmark-completing-read "Old bookmark name")))
1216 (bookmark-maybe-historicize-string old-name
)
1217 (bookmark-maybe-load-default-file)
1219 (setq bookmark-yank-point
(point))
1220 (setq bookmark-current-buffer
(current-buffer))
1221 (let ((final-new-name
1222 (or new-name
; use second arg, if non-nil
1223 (read-from-minibuffer
1226 (let ((now-map (copy-keymap minibuffer-local-map
)))
1227 (define-key now-map
"\C-w" 'bookmark-yank-word
)
1230 'bookmark-history
))))
1231 (bookmark-set-name old-name final-new-name
)
1232 (setq bookmark-current-bookmark final-new-name
)
1233 (bookmark-bmenu-surreptitiously-rebuild-list)
1234 (setq bookmark-alist-modification-count
1235 (1+ bookmark-alist-modification-count
))
1236 (if (bookmark-time-to-save-p)
1241 (defun bookmark-insert (bookmark-name)
1242 "Insert the text of the file pointed to by bookmark BOOKMARK-NAME.
1243 BOOKMARK-NAME is a bookmark name (a string), not a bookmark record.
1245 You may have a problem using this function if the value of variable
1246 `bookmark-alist' is nil. If that happens, you need to load in some
1247 bookmarks. See help on function `bookmark-load' for more about
1249 (interactive (list (bookmark-completing-read "Insert bookmark contents")))
1250 (bookmark-maybe-historicize-string bookmark-name
)
1251 (bookmark-maybe-load-default-file)
1252 (let ((orig-point (point))
1254 (save-current-buffer
1255 (bookmark-handle-bookmark bookmark-name
)
1257 (insert str-to-insert
)
1259 (goto-char orig-point
)))
1263 (defun bookmark-delete (bookmark-name &optional batch
)
1264 "Delete BOOKMARK-NAME from the bookmark list.
1266 Removes only the first instance of a bookmark with that name. If
1267 there are one or more other bookmarks with the same name, they will
1268 not be deleted. Defaults to the \"current\" bookmark (that is, the
1269 one most recently used in this file, if any).
1270 Optional second arg BATCH means don't update the bookmark list buffer,
1271 probably because we were called from there."
1273 (list (bookmark-completing-read "Delete bookmark"
1274 bookmark-current-bookmark
)))
1275 (bookmark-maybe-historicize-string bookmark-name
)
1276 (bookmark-maybe-load-default-file)
1277 (let ((will-go (bookmark-get-bookmark bookmark-name
'noerror
)))
1278 (setq bookmark-alist
(delq will-go bookmark-alist
))
1279 ;; Added by db, nil bookmark-current-bookmark if the last
1280 ;; occurrence has been deleted
1281 (or (bookmark-get-bookmark bookmark-current-bookmark
'noerror
)
1282 (setq bookmark-current-bookmark nil
)))
1284 (bookmark-bmenu-surreptitiously-rebuild-list))
1285 (setq bookmark-alist-modification-count
1286 (1+ bookmark-alist-modification-count
))
1287 (when (bookmark-time-to-save-p)
1291 (defun bookmark-time-to-save-p (&optional final-time
)
1292 "Return t if it is time to save bookmarks to disk, nil otherwise.
1293 Optional argument FINAL-TIME means this is being called when Emacs
1294 is being killed, so save even if `bookmark-save-flag' is a number and
1295 is greater than `bookmark-alist-modification-count'."
1296 ;; By Gregory M. Saunders <saunders{_AT_}cis.ohio-state.edu>
1298 (and (> bookmark-alist-modification-count
0)
1299 bookmark-save-flag
))
1300 ((numberp bookmark-save-flag
)
1301 (>= bookmark-alist-modification-count bookmark-save-flag
))
1307 (defun bookmark-write ()
1308 "Write bookmarks to a file (reading the file name with the minibuffer).
1309 Don't use this in Lisp programs; use `bookmark-save' instead."
1311 (bookmark-maybe-load-default-file)
1316 (defun bookmark-save (&optional parg file
)
1317 "Save currently defined bookmarks.
1318 Saves by default in the file defined by the variable
1319 `bookmark-default-file'. With a prefix arg, save it in file FILE
1322 If you are calling this from Lisp, the two arguments are PARG and
1323 FILE, and if you just want it to write to the default file, then
1324 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1325 instead. If you pass in one argument, and it is non-nil, then the
1326 user will be interactively queried for a file to save in.
1328 When you want to load in the bookmarks from a file, use
1329 `bookmark-load', \\[bookmark-load]. That function will prompt you
1330 for a file, defaulting to the file defined by variable
1331 `bookmark-default-file'."
1333 (bookmark-maybe-load-default-file)
1335 ((and (null parg
) (null file
))
1336 ;;whether interactive or not, write to default file
1337 (bookmark-write-file bookmark-default-file
))
1338 ((and (null parg
) file
)
1339 ;;whether interactive or not, write to given file
1340 (bookmark-write-file file
))
1341 ((and parg
(not file
))
1342 ;;have been called interactively w/ prefix arg
1343 (let ((file (read-file-name "File to save bookmarks in: ")))
1344 (bookmark-write-file file
)))
1345 (t ; someone called us with prefix-arg *and* a file, so just write to file
1346 (bookmark-write-file file
)))
1347 ;; signal that we have synced the bookmark file by setting this to
1348 ;; 0. If there was an error at any point before, it will not get
1349 ;; set, which is what we want.
1350 (setq bookmark-alist-modification-count
0))
1354 (defun bookmark-write-file (file)
1355 "Write `bookmark-alist' to FILE."
1356 (bookmark-maybe-message "Saving bookmarks to file %s..." file
)
1357 (with-current-buffer (get-buffer-create " *Bookmarks*")
1358 (goto-char (point-min))
1359 (delete-region (point-min) (point-max))
1360 (let ((print-length nil
)
1362 (bookmark-insert-file-format-version-stamp)
1364 ;; Rather than a single call to `pp' we make one per bookmark.
1365 ;; Apparently `pp' has a poor algorithmic complexity, so this
1366 ;; scales a lot better. bug#4485.
1367 (dolist (i bookmark-alist
) (pp i
(current-buffer)))
1369 (let ((version-control
1371 ((null bookmark-version-control
) nil
)
1372 ((eq 'never bookmark-version-control
) 'never
)
1373 ((eq 'nospecial bookmark-version-control
) version-control
)
1376 (write-region (point-min) (point-max) file
)
1377 (file-error (message "Can't write %s" file
)))
1378 (kill-buffer (current-buffer))
1379 (bookmark-maybe-message
1380 "Saving bookmarks to file %s...done" file
)))))
1383 (defun bookmark-import-new-list (new-list)
1384 "Add NEW-LIST of bookmarks to `bookmark-alist'.
1385 Rename new bookmarks as needed using suffix \"<N>\" (N=1,2,3...), when
1386 they conflict with existing bookmark names."
1387 (let ((names (bookmark-all-names)))
1388 (dolist (full-record new-list
)
1389 (bookmark-maybe-rename full-record names
)
1390 (setq bookmark-alist
(nconc bookmark-alist
(list full-record
)))
1391 (push (bookmark-name-from-full-record full-record
) names
))))
1394 (defun bookmark-maybe-rename (full-record names
)
1395 "Rename bookmark FULL-RECORD if its current name is already used.
1396 This is a helper for `bookmark-import-new-list'."
1397 (let ((found-name (bookmark-name-from-full-record full-record
)))
1398 (if (member found-name names
)
1399 ;; We've got a conflict, so generate a new name
1401 (new-name found-name
))
1402 (while (member new-name names
)
1403 (setq new-name
(concat found-name
(format "<%d>" count
)))
1404 (setq count
(1+ count
)))
1405 (bookmark-set-name full-record new-name
)))))
1409 (defun bookmark-load (file &optional overwrite no-msg
)
1410 "Load bookmarks from FILE (which must be in bookmark format).
1411 Appends loaded bookmarks to the front of the list of bookmarks. If
1412 optional second argument OVERWRITE is non-nil, existing bookmarks are
1413 destroyed. Optional third arg NO-MSG means don't display any messages
1416 If you load a file that doesn't contain a proper bookmark alist, you
1417 will corrupt Emacs's bookmark list. Generally, you should only load
1418 in files that were created with the bookmark functions in the first
1419 place. Your own personal bookmark file, `~/.emacs.bmk', is
1420 maintained automatically by Emacs; you shouldn't need to load it
1423 If you load a file containing bookmarks with the same names as
1424 bookmarks already present in your Emacs, the new bookmarks will get
1425 unique numeric suffixes \"<2>\", \"<3>\", ... following the same
1426 method buffers use to resolve name collisions."
1428 (list (read-file-name
1429 (format "Load bookmarks from: (%s) "
1430 bookmark-default-file
)
1431 ;;Default might not be used often,
1432 ;;but there's no better default, and
1433 ;;I guess it's better than none at all.
1434 "~/" bookmark-default-file
'confirm
)))
1435 (setq file
(abbreviate-file-name (expand-file-name file
)))
1436 (if (not (file-readable-p file
))
1437 (error "Cannot read bookmark file %s" file
)
1439 (bookmark-maybe-message "Loading bookmarks from %s..." file
))
1440 (with-current-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 (abbreviate-file-name
1457 (expand-file-name bookmark-default-file
))
1459 (setq bookmarks-already-loaded t
))
1460 (bookmark-bmenu-surreptitiously-rebuild-list))
1461 (error "Invalid bookmark list in %s" file
)))
1462 (kill-buffer (current-buffer)))
1464 (bookmark-maybe-message "Loading bookmarks from %s...done" file
))))
1468 ;;; Code supporting the dired-like bookmark menu.
1469 ;; Prefix is "bookmark-bmenu" for "buffer-menu":
1472 (defvar bookmark-bmenu-hidden-bookmarks
())
1475 (defvar bookmark-bmenu-mode-map
1476 (let ((map (make-keymap)))
1477 (set-keymap-parent map special-mode-map
)
1478 (define-key map
"v" 'bookmark-bmenu-select
)
1479 (define-key map
"w" 'bookmark-bmenu-locate
)
1480 (define-key map
"2" 'bookmark-bmenu-2-window
)
1481 (define-key map
"1" 'bookmark-bmenu-1-window
)
1482 (define-key map
"j" 'bookmark-bmenu-this-window
)
1483 (define-key map
"\C-c\C-c" 'bookmark-bmenu-this-window
)
1484 (define-key map
"f" 'bookmark-bmenu-this-window
)
1485 (define-key map
"\C-m" 'bookmark-bmenu-this-window
)
1486 (define-key map
"o" 'bookmark-bmenu-other-window
)
1487 (define-key map
"\C-o" 'bookmark-bmenu-switch-other-window
)
1488 (define-key map
"s" 'bookmark-bmenu-save
)
1489 (define-key map
"k" 'bookmark-bmenu-delete
)
1490 (define-key map
"\C-d" 'bookmark-bmenu-delete-backwards
)
1491 (define-key map
"x" 'bookmark-bmenu-execute-deletions
)
1492 (define-key map
"d" 'bookmark-bmenu-delete
)
1493 (define-key map
" " 'next-line
)
1494 (define-key map
"n" 'next-line
)
1495 (define-key map
"p" 'previous-line
)
1496 (define-key map
"\177" 'bookmark-bmenu-backup-unmark
)
1497 (define-key map
"u" 'bookmark-bmenu-unmark
)
1498 (define-key map
"m" 'bookmark-bmenu-mark
)
1499 (define-key map
"l" 'bookmark-bmenu-load
)
1500 (define-key map
"r" 'bookmark-bmenu-rename
)
1501 (define-key map
"R" 'bookmark-bmenu-relocate
)
1502 (define-key map
"t" 'bookmark-bmenu-toggle-filenames
)
1503 (define-key map
"a" 'bookmark-bmenu-show-annotation
)
1504 (define-key map
"A" 'bookmark-bmenu-show-all-annotations
)
1505 (define-key map
"e" 'bookmark-bmenu-edit-annotation
)
1506 (define-key map
"/" 'bookmark-bmenu-search
)
1507 (define-key map
[mouse-2
] 'bookmark-bmenu-other-window-with-mouse
)
1510 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1512 (put 'bookmark-bmenu-mode
'mode-class
'special
)
1515 ;; todo: need to display whether or not bookmark exists as a buffer in
1519 ;; FLAGS BOOKMARK [ LOCATION ]
1522 (defun bookmark-bmenu-surreptitiously-rebuild-list ()
1523 "Rebuild the Bookmark List if it exists.
1524 Don't affect the buffer ring order."
1525 (if (get-buffer "*Bookmark List*")
1527 (save-window-excursion
1528 (bookmark-bmenu-list)))))
1532 (defun bookmark-bmenu-list ()
1533 "Display a list of existing bookmarks.
1534 The list is displayed in a buffer named `*Bookmark List*'.
1535 The leftmost column displays a D if the bookmark is flagged for
1536 deletion, or > if it is flagged for displaying."
1538 (bookmark-maybe-load-default-file)
1539 (let ((buf (get-buffer-create "*Bookmark List*")))
1540 (if (called-interactively-p 'interactive
)
1541 (switch-to-buffer buf
)
1543 (let ((inhibit-read-only t
))
1545 (insert "% Bookmark\n- --------\n")
1546 (add-text-properties (point-min) (point)
1547 '(font-lock-face bookmark-menu-heading
))
1548 (dolist (full-record (bookmark-maybe-sort-alist))
1549 (let ((name (bookmark-name-from-full-record full-record
))
1550 (annotation (bookmark-get-annotation full-record
))
1553 ;; if a bookmark has an annotation, prepend a "*"
1554 ;; in the list of bookmarks.
1555 (insert (if (and annotation
(not (string-equal annotation
"")))
1560 (+ bookmark-bmenu-marks-width start
) end
'bookmark-name-prop name
)
1561 (when (display-mouse-p)
1562 (add-text-properties
1563 (+ bookmark-bmenu-marks-width start
) end
1564 '(mouse-face highlight
1566 help-echo
"mouse-2: go to this bookmark in other window")))
1568 (set-buffer-modified-p (not (= bookmark-alist-modification-count
0)))
1569 (goto-char (point-min))
1571 (bookmark-bmenu-mode)
1572 (if bookmark-bmenu-toggle-filenames
1573 (bookmark-bmenu-toggle-filenames t
))))
1576 (defalias 'list-bookmarks
'bookmark-bmenu-list
)
1578 (defalias 'edit-bookmarks
'bookmark-bmenu-list
)
1582 (define-derived-mode bookmark-bmenu-mode special-mode
"Bookmark Menu"
1583 "Major mode for editing a list of bookmarks.
1584 Each line describes one of the bookmarks in Emacs.
1585 Letters do not insert themselves; instead, they are commands.
1586 Bookmark names preceded by a \"*\" have annotations.
1587 \\<bookmark-bmenu-mode-map>
1588 \\[bookmark-bmenu-mark] -- mark bookmark to be displayed.
1589 \\[bookmark-bmenu-select] -- select bookmark of line point is on.
1590 Also show bookmarks marked using m in other windows.
1591 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1592 \\[bookmark-bmenu-locate] -- display (in minibuffer) location of this bookmark.
1593 \\[bookmark-bmenu-1-window] -- select this bookmark in full-frame window.
1594 \\[bookmark-bmenu-2-window] -- select this bookmark in one window,
1595 together with bookmark selected before this one in another window.
1596 \\[bookmark-bmenu-this-window] -- select this bookmark in place of the bookmark menu buffer.
1597 \\[bookmark-bmenu-other-window] -- select this bookmark in another window,
1598 so the bookmark menu bookmark remains visible in its window.
1599 \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark.
1600 \\[bookmark-bmenu-rename] -- rename this bookmark (prompts for new name).
1601 \\[bookmark-bmenu-relocate] -- relocate this bookmark's file (prompts for new file).
1602 \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down.
1603 \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up.
1604 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1605 \\[bookmark-bmenu-save] -- save the current bookmark list in the default file.
1606 With a prefix arg, prompts for a file to save in.
1607 \\[bookmark-bmenu-load] -- load in a file of bookmarks (prompts for file.)
1608 \\[bookmark-bmenu-unmark] -- remove all kinds of marks from current line.
1609 With prefix argument, also move up one line.
1610 \\[bookmark-bmenu-backup-unmark] -- back up a line and remove marks.
1611 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1613 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1614 \\[bookmark-bmenu-edit-annotation] -- edit the annotation for the current bookmark."
1615 (setq truncate-lines t
)
1616 (setq buffer-read-only t
))
1619 (defun bookmark-bmenu-toggle-filenames (&optional show
)
1620 "Toggle whether filenames are shown in the bookmark list.
1621 Optional argument SHOW means show them unconditionally."
1625 (setq bookmark-bmenu-toggle-filenames nil
)
1626 (bookmark-bmenu-show-filenames)
1627 (setq bookmark-bmenu-toggle-filenames t
))
1628 (bookmark-bmenu-toggle-filenames
1629 (bookmark-bmenu-hide-filenames)
1630 (setq bookmark-bmenu-toggle-filenames nil
))
1632 (bookmark-bmenu-show-filenames)
1633 (setq bookmark-bmenu-toggle-filenames t
))))
1636 (defun bookmark-bmenu-show-filenames (&optional force
)
1637 "In an interactive bookmark list, show filenames along with bookmarks.
1638 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1639 mainly for debugging, and should not be necessary in normal use."
1640 (if (and (not force
) bookmark-bmenu-toggle-filenames
)
1641 nil
;already shown, so do nothing
1642 (with-buffer-modified-unmodified
1644 (save-window-excursion
1645 (goto-char (point-min))
1647 (setq bookmark-bmenu-hidden-bookmarks
())
1648 (let ((inhibit-read-only t
))
1649 (while (< (point) (point-max))
1650 (let ((bmrk (bookmark-bmenu-bookmark)))
1651 (push bmrk bookmark-bmenu-hidden-bookmarks
)
1652 (let ((start (line-end-position)))
1653 (move-to-column bookmark-bmenu-file-column t
)
1654 ;; Strip off `mouse-face' from the white spaces region.
1655 (if (display-mouse-p)
1656 (remove-text-properties start
(point)
1657 '(mouse-face nil help-echo nil
))))
1658 (delete-region (point) (progn (end-of-line) (point)))
1660 ;; Pass the NO-HISTORY arg:
1661 (bookmark-insert-location bmrk t
)
1662 (forward-line 1)))))))))
1665 (defun bookmark-bmenu-hide-filenames (&optional force
)
1666 "In an interactive bookmark list, hide the filenames of the bookmarks.
1667 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1668 mainly for debugging, and should not be necessary in normal use."
1669 (when (and (not force
) bookmark-bmenu-toggle-filenames
)
1670 ;; nothing to hide if above is nil
1671 (with-buffer-modified-unmodified
1673 (goto-char (point-min))
1675 (setq bookmark-bmenu-hidden-bookmarks
1676 (nreverse bookmark-bmenu-hidden-bookmarks
))
1677 (let ((inhibit-read-only t
))
1678 (while bookmark-bmenu-hidden-bookmarks
1679 (move-to-column bookmark-bmenu-marks-width t
)
1680 (bookmark-kill-line)
1681 (let ((name (pop bookmark-bmenu-hidden-bookmarks
))
1684 (put-text-property start
(point) 'bookmark-name-prop name
)
1685 (if (display-mouse-p)
1686 (add-text-properties
1689 highlight follow-link t help-echo
1690 "mouse-2: go to this bookmark in other window"))))
1691 (forward-line 1)))))))
1694 (defun bookmark-bmenu-ensure-position ()
1695 "If point is not on a bookmark line, move it to one.
1696 If before the first bookmark line, move to the first; if after the
1697 last full line, move to the last full line. The return value is undefined."
1698 (cond ((< (count-lines (point-min) (point)) bookmark-bmenu-header-height
)
1699 (goto-char (point-min))
1700 (forward-line bookmark-bmenu-header-height
))
1701 ((and (bolp) (eobp))
1702 (beginning-of-line 0))))
1705 (defun bookmark-bmenu-bookmark ()
1706 "Return the bookmark for this line in an interactive bookmark list buffer."
1707 (bookmark-bmenu-ensure-position)
1710 (forward-char bookmark-bmenu-marks-width
)
1711 (get-text-property (point) 'bookmark-name-prop
)))
1714 (defun bookmark-show-annotation (bookmark-name-or-record)
1715 "Display the annotation for BOOKMARK-NAME-OR-RECORD in a buffer,
1716 if an annotation exists."
1717 (let ((annotation (bookmark-get-annotation bookmark-name-or-record
)))
1718 (when (and annotation
(not (string-equal annotation
"")))
1720 (let ((old-buf (current-buffer)))
1721 (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t
)
1722 (delete-region (point-min) (point-max))
1724 (goto-char (point-min))
1725 (switch-to-buffer-other-window old-buf
))))))
1728 (defun bookmark-show-all-annotations ()
1729 "Display the annotations for all bookmarks in a buffer."
1730 (save-selected-window
1731 (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t
)
1732 (delete-region (point-min) (point-max))
1733 (dolist (full-record bookmark-alist
)
1734 (let* ((name (bookmark-name-from-full-record full-record
))
1735 (ann (bookmark-get-annotation full-record
)))
1736 (insert (concat name
":\n"))
1737 (if (and ann
(not (string-equal ann
"")))
1738 ;; insert the annotation, indented by 4 spaces.
1740 (save-excursion (insert ann
) (unless (bolp)
1742 (while (< (point) (point-max))
1743 (beginning-of-line) ; paranoia
1747 (goto-char (point-min))))
1750 (defun bookmark-bmenu-mark ()
1751 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1754 (bookmark-bmenu-ensure-position)
1755 (with-buffer-modified-unmodified
1756 (let ((inhibit-read-only t
))
1760 (bookmark-bmenu-ensure-position))))
1763 (defun bookmark-bmenu-select ()
1764 "Select this line's bookmark; also display bookmarks marked with `>'.
1765 You can mark bookmarks with the \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-mark] command."
1767 (let ((bmrk (bookmark-bmenu-bookmark))
1768 (menu (current-buffer))
1771 (goto-char (point-min))
1772 (while (re-search-forward "^>" nil t
)
1773 (setq tem
(bookmark-bmenu-bookmark))
1774 (let ((inhibit-read-only t
))
1777 (or (string-equal tem bmrk
)
1779 (setq others
(cons tem others
))))
1780 (setq others
(nreverse others
)
1781 tem
(/ (1- (frame-height)) (1+ (length others
))))
1782 (delete-other-windows)
1783 (bookmark-jump bmrk
)
1787 (split-window nil tem
)
1789 (bookmark-jump (car others
))
1790 (setq others
(cdr others
)))
1794 (defun bookmark-bmenu-any-marks ()
1795 "Return non-nil if any bookmarks are marked in the marks column."
1797 (goto-char (point-min))
1798 (bookmark-bmenu-ensure-position)
1802 (if (looking-at "^\\S-")
1803 (throw 'found-mark t
)
1808 (defun bookmark-bmenu-save (parg)
1809 "Save the current list into a bookmark file.
1810 With a prefix arg, prompts for a file to save them in."
1813 (save-window-excursion
1814 (bookmark-save parg
)
1815 (set-buffer-modified-p nil
))))
1818 (defun bookmark-bmenu-load ()
1819 "Load the bookmark file and rebuild the bookmark menu-buffer."
1821 (bookmark-bmenu-ensure-position)
1823 (save-window-excursion
1824 ;; This will call `bookmark-bmenu-list'
1825 (call-interactively 'bookmark-load
))))
1828 (defun bookmark-bmenu-1-window ()
1829 "Select this line's bookmark, alone, in full frame."
1831 (bookmark-jump (bookmark-bmenu-bookmark))
1832 (bury-buffer (other-buffer))
1833 (delete-other-windows))
1836 (defun bookmark-bmenu-2-window ()
1837 "Select this line's bookmark, with previous buffer in second window."
1839 (let ((bmrk (bookmark-bmenu-bookmark))
1840 (menu (current-buffer))
1842 (delete-other-windows)
1843 (switch-to-buffer (other-buffer) nil t
)
1844 (bookmark--jump-via bmrk
'pop-to-buffer
)
1845 (bury-buffer menu
)))
1848 (defun bookmark-bmenu-this-window ()
1849 "Select this line's bookmark in this window."
1851 (bookmark-jump (bookmark-bmenu-bookmark)))
1854 (defun bookmark-bmenu-other-window ()
1855 "Select this line's bookmark in other window, leaving bookmark menu visible."
1857 (let ((bookmark (bookmark-bmenu-bookmark)))
1858 (bookmark--jump-via bookmark
'switch-to-buffer-other-window
)))
1861 (defun bookmark-bmenu-switch-other-window ()
1862 "Make the other window select this line's bookmark.
1863 The current window remains selected."
1865 (let ((bookmark (bookmark-bmenu-bookmark))
1867 same-window-buffer-names
1868 same-window-regexps
)
1869 (bookmark--jump-via bookmark
'display-buffer
)))
1871 (defun bookmark-bmenu-other-window-with-mouse (event)
1872 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1874 (with-current-buffer (window-buffer (posn-window (event-end event
)))
1876 (goto-char (posn-point (event-end event
)))
1877 (bookmark-bmenu-other-window))))
1880 (defun bookmark-bmenu-show-annotation ()
1881 "Show the annotation for the current bookmark in another window."
1883 (let ((bookmark (bookmark-bmenu-bookmark)))
1884 (bookmark-show-annotation bookmark
)))
1887 (defun bookmark-bmenu-show-all-annotations ()
1888 "Show the annotation for all bookmarks in another window."
1890 (bookmark-show-all-annotations))
1893 (defun bookmark-bmenu-edit-annotation ()
1894 "Edit the annotation for the current bookmark in another window."
1896 (let ((bookmark (bookmark-bmenu-bookmark)))
1897 (bookmark-edit-annotation bookmark
)))
1900 (defun bookmark-bmenu-unmark (&optional backup
)
1901 "Cancel all requested operations on bookmark on this line and move down.
1902 Optional BACKUP means move up."
1905 (bookmark-bmenu-ensure-position)
1906 (with-buffer-modified-unmodified
1907 (let ((inhibit-read-only t
))
1909 ;; any flags to reset according to circumstances? How about a
1910 ;; flag indicating whether this bookmark is being visited?
1911 ;; well, we don't have this now, so maybe later.
1913 (forward-line (if backup -
1 1))
1914 (bookmark-bmenu-ensure-position)))
1917 (defun bookmark-bmenu-backup-unmark ()
1918 "Move up and cancel all requested operations on bookmark on line above."
1921 (bookmark-bmenu-ensure-position)
1922 (bookmark-bmenu-unmark)
1924 (bookmark-bmenu-ensure-position))
1927 (defun bookmark-bmenu-delete ()
1928 "Mark bookmark on this line to be deleted.
1929 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1932 (bookmark-bmenu-ensure-position)
1933 (with-buffer-modified-unmodified
1934 (let ((inhibit-read-only t
))
1938 (bookmark-bmenu-ensure-position))))
1941 (defun bookmark-bmenu-delete-backwards ()
1942 "Mark bookmark on this line to be deleted, then move up one line.
1943 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1945 (bookmark-bmenu-delete)
1947 (bookmark-bmenu-ensure-position)
1949 (bookmark-bmenu-ensure-position))
1952 (defun bookmark-bmenu-execute-deletions ()
1953 "Delete bookmarks flagged `D'."
1955 (message "Deleting bookmarks...")
1956 (let ((o-point (point))
1957 (o-str (save-excursion
1959 (unless (looking-at "^D")
1962 (progn (end-of-line) (point))))))
1963 (o-col (current-column)))
1964 (goto-char (point-min))
1966 (while (re-search-forward "^D" (point-max) t
)
1967 (bookmark-delete (bookmark-bmenu-bookmark) t
)) ; pass BATCH arg
1968 (bookmark-bmenu-list)
1971 (goto-char (point-min))
1972 (search-forward o-str
)
1974 (forward-char o-col
))
1975 (goto-char o-point
))
1977 (message "Deleting bookmarks...done")
1981 (defun bookmark-bmenu-rename ()
1982 "Rename bookmark on current line. Prompts for a new name."
1984 (let ((bmrk (bookmark-bmenu-bookmark))
1985 (thispoint (point)))
1986 (bookmark-rename bmrk
)
1987 (goto-char thispoint
)))
1990 (defun bookmark-bmenu-locate ()
1991 "Display location of this bookmark. Displays in the minibuffer."
1993 (let ((bmrk (bookmark-bmenu-bookmark)))
1994 (message "%s" (bookmark-location bmrk
))))
1996 (defun bookmark-bmenu-relocate ()
1997 "Change the file path of the bookmark on the current line,
1998 prompting with completion for the new path."
2000 (let ((bmrk (bookmark-bmenu-bookmark))
2001 (thispoint (point)))
2002 (bookmark-relocate bmrk
)
2003 (goto-char thispoint
)))
2005 ;;; Bookmark-bmenu search
2007 ;; Store keyboard input for incremental search.
2008 (defvar bookmark-search-pattern
)
2010 (defun bookmark-read-search-input ()
2011 "Read each keyboard input and add it to `bookmark-search-pattern'."
2012 (let ((prompt (propertize "Pattern: " 'face
'minibuffer-prompt
))
2013 ;; (inhibit-quit t) ; inhibit-quit is evil. Use it with extreme care!
2016 (let ((char (read-key (concat prompt bookmark-search-pattern
))))
2018 ((or ?\e ?
\r) nil
) ; RET or ESC break the search loop.
2019 (?\C-g
(setq bookmark-quit-flag t
) nil
)
2020 (?\d
(pop tmp-list
) t
) ; Delete last char of pattern with DEL
2022 (if (characterp char
)
2023 (push char tmp-list
)
2024 (setq unread-command-events
2025 (nconc (mapcar 'identity
2026 (this-single-command-raw-keys))
2027 unread-command-events
))
2029 (setq bookmark-search-pattern
2030 (apply 'string
(reverse tmp-list
))))))
2033 (defun bookmark-bmenu-filter-alist-by-regexp (regexp)
2034 "Filter `bookmark-alist' with bookmarks matching REGEXP and rebuild list."
2035 (let ((bookmark-alist
2036 (cl-loop for i in bookmark-alist
2037 when
(string-match regexp
(car i
)) collect i into new
2038 finally return new
)))
2039 (bookmark-bmenu-list)))
2043 (defun bookmark-bmenu-search ()
2044 "Incremental search of bookmarks, hiding the non-matches as we go."
2046 (let ((bmk (bookmark-bmenu-bookmark))
2047 (bookmark-search-pattern "")
2048 (timer (run-with-idle-timer
2049 bookmark-search-delay
'repeat
2051 (bookmark-bmenu-filter-alist-by-regexp
2052 bookmark-search-pattern
)))))
2054 (bookmark-read-search-input)
2055 (cancel-timer timer
)
2057 (when bookmark-quit-flag
; C-g hit restore menu list.
2058 (bookmark-bmenu-list) (bookmark-bmenu-goto-bookmark bmk
))
2059 (setq bookmark-quit-flag nil
))))
2061 (defun bookmark-bmenu-goto-bookmark (name)
2062 "Move point to bookmark with name NAME."
2063 (goto-char (point-min))
2064 (while (not (equal name
(bookmark-bmenu-bookmark)))
2070 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2072 (defun bookmark-menu-popup-paned-menu (event name entries
)
2073 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2074 That is, ENTRIES is a list of strings which appear as the choices
2076 The number of panes depends on the number of entries.
2077 The visible entries are truncated to `bookmark-menu-length', but the
2078 strings returned are not."
2079 (let ((f-height (/ (frame-height) 2))
2085 (while (and (< count f-height
) entries
)
2086 (let ((str (car entries
)))
2088 (if (> (length str
) bookmark-menu-length
)
2089 (substring str
0 bookmark-menu-length
)
2093 (setq entries
(cdr entries
))
2094 (setq count
(1+ count
))))
2095 (setq iter
(1+ iter
))
2097 (format "-*- %s (%d) -*-" name iter
)
2101 ;; Popup the menu and return the string.
2102 (x-popup-menu event
(cons (concat "-*- " name
" -*-")
2103 (nreverse pane-list
)))))
2106 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2107 ;; following works, and for explaining what to do to make it work.
2109 ;; We MUST autoload EACH form used to set up this variable's value, so
2110 ;; that the whole job is done in loaddefs.el.
2112 ;; Emacs menubar stuff.
2115 (defvar menu-bar-bookmark-map
2116 (let ((map (make-sparse-keymap "Bookmark functions")))
2117 (bindings--define-key map
[load]
2118 '(menu-item "Load a Bookmark File..." bookmark-load
2119 :help "Load bookmarks from a bookmark file)"))
2120 (bindings--define-key map [write]
2121 '(menu-item "Save Bookmarks As..." bookmark-write
2122 :help "Write bookmarks to a file (reading the file name with the minibuffer)"))
2123 (bindings--define-key map [save]
2124 '(menu-item "Save Bookmarks" bookmark-save
2125 :help "Save currently defined bookmarks"))
2126 (bindings--define-key map [edit]
2127 '(menu-item "Edit Bookmark List" bookmark-bmenu-list
2128 :help "Display a list of existing bookmarks"))
2129 (bindings--define-key map [delete]
2130 '(menu-item "Delete Bookmark..." bookmark-delete
2131 :help "Delete a bookmark from the bookmark list"))
2132 (bindings--define-key map [rename]
2133 '(menu-item "Rename Bookmark..." bookmark-rename
2134 :help "Change the name of a bookmark"))
2135 (bindings--define-key map [locate]
2136 '(menu-item "Insert Location..." bookmark-locate
2137 :help "Insert the name of the file associated with a bookmark"))
2138 (bindings--define-key map [insert]
2139 '(menu-item "Insert Contents..." bookmark-insert
2140 :help "Insert the text of the file pointed to by a bookmark"))
2141 (bindings--define-key map [set]
2142 '(menu-item "Set Bookmark..." bookmark-set
2143 :help "Set a bookmark named inside a file."))
2144 (bindings--define-key map [jump]
2145 '(menu-item "Jump to Bookmark..." bookmark-jump
2146 :help "Jump to a bookmark (a point in some file)"))
2150 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2152 ;; make bookmarks appear toward the right side of the menu.
2153 (if (boundp 'menu-bar-final-items)
2154 (if menu-bar-final-items
2155 (push 'bookmark menu-bar-final-items))
2156 (setq menu-bar-final-items '(bookmark)))
2158 ;;;; end bookmark menu stuff ;;;;
2162 (defvar bookmark-load-hook nil
2163 "Hook run at the end of loading library `bookmark.el'.")
2165 ;; Exit Hook, called from kill-emacs-hook
2166 (define-obsolete-variable-alias 'bookmark-exit-hooks
2167 'bookmark-exit-hook "22.1")
2168 (defvar bookmark-exit-hook nil
2169 "Hook run when Emacs exits.")
2171 (defun bookmark-exit-hook-internal ()
2172 "Save bookmark state, if necessary, at Emacs exit time.
2173 This also runs `bookmark-exit-hook'."
2174 (run-hooks 'bookmark-exit-hook)
2176 (bookmark-time-to-save-p t)
2179 (unless noninteractive
2180 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal))
2182 (defun bookmark-unload-function ()
2183 "Unload the Bookmark library."
2184 (when bookmark-save-flag (bookmark-save))
2185 ;; continue standard unloading
2189 (run-hooks 'bookmark-load-hook)
2193 ;;; bookmark.el ends here
HCoop / bpt / emacs.git / blob