* lisp/vc/vc-hooks.el (vc-refresh-state): New command
[emacs.git] / lisp / bookmark.el
blob308d1cab585fdc6ad484930ff1bf50c15abbabe9
1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later
3 ;; Copyright (C) 1993-1997, 2001-2015 Free Software Foundation, Inc.
5 ;; Author: Karl Fogel <kfogel@red-bean.com>
6 ;; Maintainer: Karl Fogel <kfogel@red-bean.com>
7 ;; Created: July, 1993
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/>.
25 ;;; Commentary:
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.
32 \f
33 ;;; Code:
35 (require 'pp)
36 (eval-when-compile (require 'cl-lib))
38 ;;; Misc comments:
39 ;;
40 ;; If variable bookmark-use-annotations is non-nil, an annotation is
41 ;; queried for when setting a bookmark.
42 ;;
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.
48 ;;; User Variables
50 (defgroup bookmark nil
51 "Setting, annotation and jumping to bookmarks."
52 :group 'matching)
55 (defcustom bookmark-use-annotations nil
56 "If non-nil, saving a bookmark queries for an annotation in a buffer."
57 :type 'boolean
58 :group 'bookmark)
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
74 behavior.)
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))
79 :group 'bookmark)
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
91 (if bookmark-file
92 ;; In case user set `bookmark-file' in her .emacs:
93 bookmark-file
94 (locate-user-emacs-file "bookmarks" ".emacs.bmk"))
95 "File in which to save bookmarks by default."
96 :type 'file
97 :group 'bookmark)
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', or `nospecial'.
103 The first three have the same meaning that they do for the
104 variable `version-control'; the value `nospecial' (the default) means
105 just use the value of `version-control'."
106 :type '(choice (const :tag "If existing" nil)
107 (const :tag "Never" never)
108 (const :tag "Use value of option `version-control'" nospecial)
109 (other :tag "Always" t))
110 :group 'bookmark)
113 (defcustom bookmark-completion-ignore-case t
114 "Non-nil means bookmark functions ignore case in completion."
115 :type 'boolean
116 :group 'bookmark)
119 (defcustom bookmark-sort-flag t
120 "Non-nil means that bookmarks will be displayed sorted by bookmark name.
121 Otherwise they will be displayed in LIFO order (that is, most
122 recently set ones come first, oldest ones come last)."
123 :type 'boolean
124 :group 'bookmark)
127 (defcustom bookmark-automatically-show-annotations t
128 "Non-nil means show annotations when jumping to a bookmark."
129 :type 'boolean
130 :group 'bookmark)
132 (defcustom bookmark-bmenu-use-header-line t
133 "Non-nil means to use an immovable header line.
134 This is as opposed to inline text at the top of the buffer."
135 :version "24.4"
136 :type 'boolean
137 :group 'bookmark)
139 (defconst bookmark-bmenu-inline-header-height 2
140 "Number of lines used for the *Bookmark List* header
141 \(only significant when `bookmark-bmenu-use-header-line' is nil\).")
143 (defconst bookmark-bmenu-marks-width 2
144 "Number of columns (chars) used for the *Bookmark List* marks column,
145 including the annotations column.")
147 (defcustom bookmark-bmenu-file-column 30
148 "Column at which to display filenames in a buffer listing bookmarks.
149 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
150 :type 'integer
151 :group 'bookmark)
154 (defcustom bookmark-bmenu-toggle-filenames t
155 "Non-nil means show filenames when listing bookmarks.
156 A non-nil value may result in truncated bookmark names."
157 :type 'boolean
158 :group 'bookmark)
160 (defface bookmark-menu-bookmark
161 '((t (:weight bold)))
162 "Face used to highlight bookmark names in bookmark menu buffers."
163 :group 'bookmark)
165 (defcustom bookmark-menu-length 70
166 "Maximum length of a bookmark name displayed on a popup menu."
167 :type 'integer
168 :group 'bookmark)
170 ;; FIXME: Is it really worth a customization option?
171 (defcustom bookmark-search-delay 0.2
172 "Time before `bookmark-bmenu-search' updates the display."
173 :group 'bookmark
174 :type 'number)
176 (defface bookmark-menu-heading
177 '((t (:inherit font-lock-type-face)))
178 "Face used to highlight the heading in bookmark menu buffers."
179 :group 'bookmark
180 :version "22.1")
183 ;;; No user-serviceable parts beyond this point.
185 ;; Added for lucid emacs compatibility, db
186 (or (fboundp 'defalias) (fset 'defalias 'fset))
188 ;; suggested for lucid compatibility by david hughes:
189 (or (fboundp 'frame-height) (defalias 'frame-height 'screen-height))
191 \f
192 ;;; Keymap stuff:
194 ;; Set up these bindings dumping time *only*;
195 ;; if the user alters them, don't override the user when loading bookmark.el.
197 ;;;###autoload (define-key ctl-x-r-map "b" 'bookmark-jump)
198 ;;;###autoload (define-key ctl-x-r-map "m" 'bookmark-set)
199 ;;;###autoload (define-key ctl-x-r-map "l" 'bookmark-bmenu-list)
201 ;;;###autoload
202 (defvar bookmark-map
203 (let ((map (make-sparse-keymap)))
204 ;; Read the help on all of these functions for details...
205 (define-key map "x" 'bookmark-set)
206 (define-key map "m" 'bookmark-set) ;"m"ark
207 (define-key map "j" 'bookmark-jump)
208 (define-key map "g" 'bookmark-jump) ;"g"o
209 (define-key map "o" 'bookmark-jump-other-window)
210 (define-key map "i" 'bookmark-insert)
211 (define-key map "e" 'edit-bookmarks)
212 (define-key map "f" 'bookmark-insert-location) ;"f"ind
213 (define-key map "r" 'bookmark-rename)
214 (define-key map "d" 'bookmark-delete)
215 (define-key map "l" 'bookmark-load)
216 (define-key map "w" 'bookmark-write)
217 (define-key map "s" 'bookmark-save)
218 map)
219 "Keymap containing bindings to bookmark functions.
220 It is not bound to any key by default: to bind it
221 so that you have a bookmark prefix, just use `global-set-key' and bind a
222 key of your choice to `bookmark-map'. All interactive bookmark
223 functions have a binding in this keymap.")
225 ;;;###autoload (fset 'bookmark-map bookmark-map)
227 \f
228 ;;; Core variables and data structures:
229 (defvar bookmark-alist ()
230 "Association list of bookmarks and their records.
231 Bookmark functions update the value automatically.
232 You probably do NOT want to change the value yourself.
234 The value is an alist with entries of the form
236 (BOOKMARK-NAME . PARAM-ALIST)
238 or the deprecated form (BOOKMARK-NAME PARAM-ALIST).
240 BOOKMARK-NAME is the name you gave to the bookmark when creating it.
242 PARAM-ALIST is an alist of bookmark information. The order of the
243 entries in PARAM-ALIST is not important. The possible entries are
244 described below. An entry with a key but null value means the entry
245 is not used.
247 (filename . FILENAME)
248 (position . POS)
249 (front-context-string . STR-AFTER-POS)
250 (rear-context-string . STR-BEFORE-POS)
251 (handler . HANDLER)
252 (annotation . ANNOTATION)
254 FILENAME names the bookmarked file.
255 POS is the bookmarked buffer position (position in the file).
256 STR-AFTER-POS is buffer text that immediately follows POS.
257 STR-BEFORE-POS is buffer text that immediately precedes POS.
258 ANNOTATION is a string that describes the bookmark.
259 See options `bookmark-use-annotations' and
260 `bookmark-automatically-show-annotations'.
261 HANDLER is a function that provides the bookmark-jump behavior for a
262 specific kind of bookmark. This is the case for Info bookmarks,
263 for instance. HANDLER must accept a bookmark as argument.")
265 (defvar bookmarks-already-loaded nil
266 "Non-nil if and only if bookmarks have been loaded from `bookmark-default-file'.")
269 ;; more stuff added by db.
271 (defvar bookmark-current-bookmark nil
272 "Name of bookmark most recently used in the current file.
273 It is buffer local, used to make moving a bookmark forward
274 through a file easier.")
276 (make-variable-buffer-local 'bookmark-current-bookmark)
279 (defvar bookmark-alist-modification-count 0
280 "Number of modifications to bookmark list since it was last saved.")
283 (defvar bookmark-search-size 16
284 "Length of the context strings recorded on either side of a bookmark.")
287 (defvar bookmark-current-buffer nil
288 "The buffer in which a bookmark is currently being set or renamed.
289 Functions that insert strings into the minibuffer use this to know
290 the source buffer for that information; see `bookmark-yank-word'
291 for example.")
294 (defvar bookmark-yank-point 0
295 "The next point from which to pull source text for `bookmark-yank-word'.
296 This point is in `bookmark-current-buffer'.")
299 (defvar bookmark-quit-flag nil
300 "Non nil make `bookmark-bmenu-search' quit immediately.")
301 \f
302 ;; Helper functions and macros.
304 (defmacro with-buffer-modified-unmodified (&rest body)
305 "Run BODY while preserving the buffer's `buffer-modified-p' state."
306 (let ((was-modified (make-symbol "was-modified")))
307 `(let ((,was-modified (buffer-modified-p)))
308 (unwind-protect
309 (progn ,@body)
310 (set-buffer-modified-p ,was-modified)))))
312 ;; Only functions below, in this page and the next one (file formats),
313 ;; need to know anything about the format of bookmark-alist entries.
314 ;; Everyone else should go through them.
316 (defun bookmark-name-from-full-record (bookmark-record)
317 "Return the name of BOOKMARK-RECORD. BOOKMARK-RECORD is, e.g.,
318 one element from `bookmark-alist'."
319 (car bookmark-record))
322 (defun bookmark-all-names ()
323 "Return a list of all current bookmark names."
324 (bookmark-maybe-load-default-file)
325 (mapcar 'bookmark-name-from-full-record bookmark-alist))
328 (defun bookmark-get-bookmark (bookmark-name-or-record &optional noerror)
329 "Return the bookmark record corresponding to BOOKMARK-NAME-OR-RECORD.
330 If BOOKMARK-NAME-OR-RECORD is a string, look for the corresponding
331 bookmark record in `bookmark-alist'; return it if found, otherwise
332 error. Else if BOOKMARK-NAME-OR-RECORD is already a bookmark record,
333 just return it."
334 (cond
335 ((consp bookmark-name-or-record) bookmark-name-or-record)
336 ((stringp bookmark-name-or-record)
337 (or (assoc-string bookmark-name-or-record bookmark-alist
338 bookmark-completion-ignore-case)
339 (unless noerror (error "Invalid bookmark %s"
340 bookmark-name-or-record))))))
343 (defun bookmark-get-bookmark-record (bookmark-name-or-record)
344 "Return the record portion of the entry for BOOKMARK-NAME-OR-RECORD in
345 `bookmark-alist' (that is, all information but the name)."
346 (let ((alist (cdr (bookmark-get-bookmark bookmark-name-or-record))))
347 ;; The bookmark objects can either look like (NAME ALIST) or
348 ;; (NAME . ALIST), so we have to distinguish the two here.
349 (if (and (null (cdr alist)) (consp (caar alist)))
350 (car alist) alist)))
353 (defun bookmark-set-name (bookmark-name-or-record newname)
354 "Set BOOKMARK-NAME-OR-RECORD's name to NEWNAME."
355 (setcar (bookmark-get-bookmark bookmark-name-or-record) newname))
357 (defun bookmark-prop-get (bookmark-name-or-record prop)
358 "Return the property PROP of BOOKMARK-NAME-OR-RECORD, or nil if none."
359 (cdr (assq prop (bookmark-get-bookmark-record bookmark-name-or-record))))
361 (defun bookmark-prop-set (bookmark-name-or-record prop val)
362 "Set the property PROP of BOOKMARK-NAME-OR-RECORD to VAL."
363 (let ((cell (assq
364 prop (bookmark-get-bookmark-record bookmark-name-or-record))))
365 (if cell
366 (setcdr cell val)
367 (nconc (bookmark-get-bookmark-record bookmark-name-or-record)
368 (list (cons prop val))))))
370 (defun bookmark-get-annotation (bookmark-name-or-record)
371 "Return the annotation of BOOKMARK-NAME-OR-RECORD, or nil if none."
372 (bookmark-prop-get bookmark-name-or-record 'annotation))
374 (defun bookmark-set-annotation (bookmark-name-or-record ann)
375 "Set the annotation of BOOKMARK-NAME-OR-RECORD to ANN."
376 (bookmark-prop-set bookmark-name-or-record 'annotation ann))
379 (defun bookmark-get-filename (bookmark-name-or-record)
380 "Return the full filename of BOOKMARK-NAME-OR-RECORD, or nil if none."
381 (bookmark-prop-get bookmark-name-or-record 'filename))
384 (defun bookmark-set-filename (bookmark-name-or-record filename)
385 "Set the full filename of BOOKMARK-NAME-OR-RECORD to FILENAME."
386 (bookmark-prop-set bookmark-name-or-record 'filename filename))
389 (defun bookmark-get-position (bookmark-name-or-record)
390 "Return the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD, or nil if none."
391 (bookmark-prop-get bookmark-name-or-record 'position))
394 (defun bookmark-set-position (bookmark-name-or-record position)
395 "Set the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD to POSITION."
396 (bookmark-prop-set bookmark-name-or-record 'position position))
399 (defun bookmark-get-front-context-string (bookmark-name-or-record)
400 "Return the front-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
401 (bookmark-prop-get bookmark-name-or-record 'front-context-string))
404 (defun bookmark-set-front-context-string (bookmark-name-or-record string)
405 "Set the front-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
406 (bookmark-prop-set bookmark-name-or-record 'front-context-string string))
409 (defun bookmark-get-rear-context-string (bookmark-name-or-record)
410 "Return the rear-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
411 (bookmark-prop-get bookmark-name-or-record 'rear-context-string))
414 (defun bookmark-set-rear-context-string (bookmark-name-or-record string)
415 "Set the rear-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
416 (bookmark-prop-set bookmark-name-or-record 'rear-context-string string))
419 (defun bookmark-get-handler (bookmark-name-or-record)
420 "Return the handler function for BOOKMARK-NAME-OR-RECORD, or nil if none."
421 (bookmark-prop-get bookmark-name-or-record 'handler))
423 (defvar bookmark-history nil
424 "The history list for bookmark functions.")
427 (defun bookmark-completing-read (prompt &optional default)
428 "Prompting with PROMPT, read a bookmark name in completion.
429 PROMPT will get a \": \" stuck on the end no matter what, so you
430 probably don't want to include one yourself.
431 Optional arg DEFAULT is a string to return if the user input is empty.
432 If DEFAULT is nil then return empty string for empty input."
433 (bookmark-maybe-load-default-file) ; paranoia
434 (if (listp last-nonmenu-event)
435 (bookmark-menu-popup-paned-menu t prompt
436 (if bookmark-sort-flag
437 (sort (bookmark-all-names)
438 'string-lessp)
439 (bookmark-all-names)))
440 (let* ((completion-ignore-case bookmark-completion-ignore-case)
441 (default (unless (equal "" default) default))
442 (prompt (concat prompt (if default
443 (format " (%s): " default)
444 ": "))))
445 (completing-read prompt
446 (lambda (string pred action)
447 (if (eq action 'metadata)
448 '(metadata (category . bookmark))
449 (complete-with-action
450 action bookmark-alist string pred)))
451 nil 0 nil 'bookmark-history default))))
454 (defmacro bookmark-maybe-historicize-string (string)
455 "Put STRING into the bookmark prompt history, if caller non-interactive.
456 We need this because sometimes bookmark functions are invoked from
457 menus, so `completing-read' never gets a chance to set `bookmark-history'."
458 `(or
459 (called-interactively-p 'interactive)
460 (setq bookmark-history (cons ,string bookmark-history))))
462 (defvar bookmark-make-record-function 'bookmark-make-record-default
463 "A function that should be called to create a bookmark record.
464 Modes may set this variable buffer-locally to enable bookmarking of
465 locations that should be treated specially, such as Info nodes,
466 news posts, images, pdf documents, etc.
468 The function will be called with no arguments.
469 It should signal a user error if it is unable to construct a record for
470 the current location.
472 The returned record should be a cons cell of the form (NAME . ALIST)
473 where ALIST is as described in `bookmark-alist' and may typically contain
474 a special cons (handler . HANDLER-FUNC) which specifies the handler function
475 that should be used instead of `bookmark-default-handler' to open this
476 bookmark. See the documentation for `bookmark-alist' for more.
478 NAME is a suggested name for the constructed bookmark. It can be nil
479 in which case a default heuristic will be used. The function can also
480 equivalently just return ALIST without NAME.")
482 (defun bookmark-make-record ()
483 "Return a new bookmark record (NAME . ALIST) for the current location."
484 (let ((record (funcall bookmark-make-record-function)))
485 ;; Set up default name if the function does not provide one.
486 (unless (stringp (car record))
487 (if (car record) (push nil record))
488 (setcar record (or bookmark-current-bookmark (bookmark-buffer-name))))
489 ;; Set up defaults.
490 (bookmark-prop-set
491 record 'defaults
492 (delq nil (delete-dups (append (bookmark-prop-get record 'defaults)
493 (list bookmark-current-bookmark
494 (car record)
495 (bookmark-buffer-name))))))
496 record))
498 (defun bookmark-store (name alist no-overwrite)
499 "Store the bookmark NAME with data ALIST.
500 If NO-OVERWRITE is non-nil and another bookmark of the same name already
501 exists in `bookmark-alist', record the new bookmark without throwing away the
502 old one."
503 (bookmark-maybe-load-default-file)
504 (let ((stripped-name (copy-sequence name)))
505 (or (featurep 'xemacs)
506 ;; XEmacs's `set-text-properties' doesn't work on
507 ;; free-standing strings, apparently.
508 (set-text-properties 0 (length stripped-name) nil stripped-name))
509 (if (and (not no-overwrite)
510 (bookmark-get-bookmark stripped-name 'noerror))
511 ;; already existing bookmark under that name and
512 ;; no prefix arg means just overwrite old bookmark
513 ;; Use the new (NAME . ALIST) format.
514 (setcdr (bookmark-get-bookmark stripped-name) alist)
516 ;; otherwise just cons it onto the front (either the bookmark
517 ;; doesn't exist already, or there is no prefix arg. In either
518 ;; case, we want the new bookmark consed onto the alist...)
520 (push (cons stripped-name alist) bookmark-alist))
522 ;; Added by db
523 (setq bookmark-current-bookmark stripped-name)
524 (setq bookmark-alist-modification-count
525 (1+ bookmark-alist-modification-count))
526 (if (bookmark-time-to-save-p)
527 (bookmark-save))
529 (setq bookmark-current-bookmark stripped-name)
530 (bookmark-bmenu-surreptitiously-rebuild-list)))
532 (defun bookmark-make-record-default (&optional no-file no-context posn)
533 "Return the record describing the location of a new bookmark.
534 Point should be at the buffer in which the bookmark is being set,
535 and normally should be at the position where the bookmark is desired,
536 but see the optional arguments for other possibilities.
538 If NO-FILE is non-nil, then only return the subset of the
539 record that pertains to the location within the buffer, leaving off
540 the part that records the filename.
542 If NO-CONTEXT is non-nil, do not include the front- and rear-context
543 strings in the record -- the position is enough.
545 If POSN is non-nil, record POSN as the point instead of `(point)'."
546 `(,@(unless no-file `((filename . ,(bookmark-buffer-file-name))))
547 ,@(unless no-context `((front-context-string
548 . ,(if (>= (- (point-max) (point))
549 bookmark-search-size)
550 (buffer-substring-no-properties
551 (point)
552 (+ (point) bookmark-search-size))
553 nil))))
554 ,@(unless no-context `((rear-context-string
555 . ,(if (>= (- (point) (point-min))
556 bookmark-search-size)
557 (buffer-substring-no-properties
558 (point)
559 (- (point) bookmark-search-size))
560 nil))))
561 (position . ,(or posn (point)))))
563 \f
564 ;;; File format stuff
566 ;; *IMPORTANT NOTICE* If you are thinking about modifying (redefining)
567 ;; the bookmark file format -- please don't. The current format
568 ;; should be extensible enough. If you feel the need to change it,
569 ;; please discuss it with other Emacs developers first.
570 ;;
571 ;; The format of `bookmark-alist' has changed twice in its lifetime.
572 ;; This comment describes the three formats, FIRST, SECOND, and
573 ;; CURRENT.
574 ;;
575 ;; The FIRST format was used prior to Emacs 20:
576 ;;
577 ;; ((BOOKMARK-NAME (FILENAME
578 ;; STRING-IN-FRONT
579 ;; STRING-BEHIND
580 ;; POINT))
581 ;; ...)
582 ;;
583 ;; The SECOND format was introduced in Emacs 20:
584 ;;
585 ;; ((BOOKMARK-NAME ((filename . FILENAME)
586 ;; (position . POS)
587 ;; (front-context-string . STR-AFTER-POS)
588 ;; (rear-context-string . STR-BEFORE-POS)
589 ;; (annotation . ANNOTATION)
590 ;; (whatever . VALUE)
591 ;; ...
592 ;; ))
593 ;; ...)
594 ;;
595 ;; The CURRENT format was introduced in Emacs 22:
596 ;;
597 ;; ((BOOKMARK-NAME (filename . FILENAME)
598 ;; (position . POS)
599 ;; (front-context-string . STR-AFTER-POS)
600 ;; (rear-context-string . STR-BEFORE-POS)
601 ;; (annotation . ANNOTATION)
602 ;; (whatever . VALUE)
603 ;; ...
604 ;; )
605 ;; ...)
606 ;;
607 ;; Both FIRST and SECOND have the same level of nesting: the cadr of a
608 ;; bookmark record is a list of entry information. FIRST and SECOND
609 ;; differ in the form of the record information: FIRST uses a list of
610 ;; atoms, and SECOND uses an alist. In the FIRST format, the order of
611 ;; the list elements matters. In the SECOND format, the order of the
612 ;; alist elements is unimportant. The SECOND format facilitates the
613 ;; addition of new kinds of elements, to support new kinds of
614 ;; bookmarks or code evolution.
615 ;;
616 ;; The CURRENT format removes a level of nesting wrt FIRST and SECOND,
617 ;; saving one cons cell per bookmark: the cadr of a bookmark record is
618 ;; no longer a cons. Why that change was made remains a mystery --
619 ;; just be aware of it. (Be aware too that this explanatory comment
620 ;; was incorrect in Emacs 22 and Emacs 23.1.)
621 ;;
622 ;; To deal with the change from FIRST format to SECOND, conversion
623 ;; code was added, and it is still in use. See
624 ;; `bookmark-maybe-upgrade-file-format'.
625 ;;
626 ;; No conversion from SECOND to CURRENT is done. Instead, the code
627 ;; handles both formats OK. It must continue to do so.
628 ;;
629 ;; See the doc string of `bookmark-alist' for information about the
630 ;; elements that define a bookmark (e.g. `filename').
633 (defconst bookmark-file-format-version 1
634 "The current version of the format used by bookmark files.
635 You should never need to change this.")
638 (defconst bookmark-end-of-version-stamp-marker
639 "-*- End Of Bookmark File Format Version Stamp -*-\n"
640 "This string marks the end of the version stamp in a bookmark file.")
643 (defun bookmark-alist-from-buffer ()
644 "Return a `bookmark-alist' (in any format) from the current buffer.
645 The buffer must of course contain bookmark format information.
646 Does not care from where in the buffer it is called, and does not
647 affect point."
648 (save-excursion
649 (goto-char (point-min))
650 (if (search-forward bookmark-end-of-version-stamp-marker nil t)
651 (read (current-buffer))
652 ;; Else we're dealing with format version 0
653 (if (search-forward "(" nil t)
654 (progn
655 (forward-char -1)
656 (read (current-buffer)))
657 ;; Else no hope of getting information here.
658 (error "Not bookmark format")))))
661 (defun bookmark-upgrade-version-0-alist (old-list)
662 "Upgrade a version 0 alist OLD-LIST to the current version."
663 (mapcar
664 (lambda (bookmark)
665 (let* ((name (car bookmark))
666 (record (car (cdr bookmark)))
667 (filename (nth 0 record))
668 (front-str (nth 1 record))
669 (rear-str (nth 2 record))
670 (position (nth 3 record))
671 (ann (nth 4 record)))
672 (list
673 name
674 `((filename . ,filename)
675 (front-context-string . ,(or front-str ""))
676 (rear-context-string . ,(or rear-str ""))
677 (position . ,position)
678 (annotation . ,ann)))))
679 old-list))
682 (defun bookmark-upgrade-file-format-from-0 ()
683 "Upgrade a bookmark file of format 0 (the original format) to format 1.
684 This expects to be called from `point-min' in a bookmark file."
685 (message "Upgrading bookmark format from 0 to %d..."
686 bookmark-file-format-version)
687 (let* ((old-list (bookmark-alist-from-buffer))
688 (new-list (bookmark-upgrade-version-0-alist old-list)))
689 (delete-region (point-min) (point-max))
690 (bookmark-insert-file-format-version-stamp)
691 (pp new-list (current-buffer))
692 (save-buffer))
693 (goto-char (point-min))
694 (message "Upgrading bookmark format from 0 to %d...done"
695 bookmark-file-format-version)
699 (defun bookmark-grok-file-format-version ()
700 "Return an integer which is the file-format version of this bookmark file.
701 This expects to be called from `point-min' in a bookmark file."
702 (if (looking-at "^;;;;")
703 (save-excursion
704 (save-match-data
705 (re-search-forward "[0-9]")
706 (forward-char -1)
707 (read (current-buffer))))
708 ;; Else this is format version 0, the original one, which didn't
709 ;; even have version stamps.
710 0))
713 (defun bookmark-maybe-upgrade-file-format ()
714 "Check the file-format version of this bookmark file.
715 If the version is not up-to-date, upgrade it automatically.
716 This expects to be called from `point-min' in a bookmark file."
717 (let ((version (bookmark-grok-file-format-version)))
718 (cond
719 ((= version bookmark-file-format-version)
720 ) ; home free -- version is current
721 ((= version 0)
722 (bookmark-upgrade-file-format-from-0))
723 (t
724 (error "Bookmark file format version strangeness")))))
727 (defun bookmark-insert-file-format-version-stamp ()
728 "Insert text indicating current version of bookmark file format."
729 (insert
730 (format ";;;; Emacs Bookmark Format Version %d ;;;;\n"
731 bookmark-file-format-version))
732 (insert ";;; This format is meant to be slightly human-readable;\n"
733 ";;; nevertheless, you probably don't want to edit it.\n"
734 ";;; "
735 bookmark-end-of-version-stamp-marker))
738 ;;; end file-format stuff
740 \f
741 ;;; Generic helpers.
743 (defun bookmark-maybe-message (fmt &rest args)
744 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
745 (if (>= baud-rate 9600)
746 (apply 'message fmt args)))
748 \f
749 ;;; Core code:
751 (defvar bookmark-minibuffer-read-name-map
752 (let ((map (make-sparse-keymap)))
753 (set-keymap-parent map minibuffer-local-map)
754 (define-key map "\C-w" 'bookmark-yank-word)
755 map))
757 ;;;###autoload
758 (defun bookmark-set (&optional name no-overwrite)
759 "Set a bookmark named NAME at the current location.
760 If name is nil, then prompt the user.
762 With a prefix arg (non-nil NO-OVERWRITE), do not overwrite any
763 existing bookmark that has the same name as NAME, but instead push the
764 new bookmark onto the bookmark alist. The most recently set bookmark
765 with name NAME is thus the one in effect at any given time, but the
766 others are still there, should the user decide to delete the most
767 recent one.
769 To yank words from the text of the buffer and use them as part of the
770 bookmark name, type C-w while setting a bookmark. Successive C-w's
771 yank successive words.
773 Typing C-u inserts (at the bookmark name prompt) the name of the last
774 bookmark used in the document where the new bookmark is being set;
775 this helps you use a single bookmark name to track progress through a
776 large document. If there is no prior bookmark for this document, then
777 C-u inserts an appropriate name based on the buffer or file.
779 Use \\[bookmark-delete] to remove bookmarks (you give it a name and
780 it removes only the first instance of a bookmark with that name from
781 the list of bookmarks.)"
782 (interactive (list nil current-prefix-arg))
783 (unwind-protect
784 (let* ((record (bookmark-make-record))
785 ;; `defaults' is a transient element of the
786 ;; extensible format described above in the section
787 ;; `File format stuff'. Bookmark record functions
788 ;; can use it to specify a list of default values
789 ;; accessible via M-n while reading a bookmark name.
790 (defaults (bookmark-prop-get record 'defaults))
791 (default (if (consp defaults) (car defaults) defaults)))
793 (if defaults
794 ;; Don't store default values in the record.
795 (setq record (assq-delete-all 'defaults record))
796 ;; When no defaults in the record, use its first element.
797 (setq defaults (car record) default defaults))
799 (bookmark-maybe-load-default-file)
800 ;; Don't set `bookmark-yank-point' and `bookmark-current-buffer'
801 ;; if they have been already set in another buffer. (e.g gnus-art).
802 (unless (and bookmark-yank-point
803 bookmark-current-buffer)
804 (setq bookmark-yank-point (point))
805 (setq bookmark-current-buffer (current-buffer)))
807 (let ((str
808 (or name
809 (read-from-minibuffer
810 (format "Set bookmark (%s): " default)
811 nil
812 bookmark-minibuffer-read-name-map
813 nil nil defaults))))
814 (and (string-equal str "") (setq str default))
815 (bookmark-store str (cdr record) no-overwrite)
817 ;; Ask for an annotation buffer for this bookmark
818 (when bookmark-use-annotations
819 (bookmark-edit-annotation str))))
820 (setq bookmark-yank-point nil)
821 (setq bookmark-current-buffer nil)))
824 (defun bookmark-kill-line (&optional newline-too)
825 "Kill from point to end of line.
826 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
827 Does not affect the kill ring."
828 (let ((eol (line-end-position)))
829 (delete-region (point) eol)
830 (if (and newline-too (looking-at "\n"))
831 (delete-char 1))))
834 ;; Defvars to avoid compilation warnings:
835 (defvar bookmark-annotation-name nil
836 "Variable holding the name of the bookmark.
837 This is used in `bookmark-edit-annotation' to record the bookmark
838 whose annotation is being edited.")
841 (defun bookmark-default-annotation-text (bookmark-name)
842 "Return default annotation text for BOOKMARK-NAME.
843 The default annotation text is simply some text explaining how to use
844 annotations."
845 (concat (format-message
846 "# Type the annotation for bookmark ā€˜%sā€™ here.\n"
847 bookmark-name)
848 (format-message
849 "# All lines which start with a ā€˜#ā€™ will be deleted.\n")
850 "# Type C-c C-c when done.\n#\n"
851 "# Author: " (user-full-name) " <" (user-login-name) "@"
852 (system-name) ">\n"
853 "# Date: " (current-time-string) "\n"))
856 (define-obsolete-variable-alias 'bookmark-read-annotation-text-func
857 'bookmark-edit-annotation-text-func "23.1")
858 (defvar bookmark-edit-annotation-text-func 'bookmark-default-annotation-text
859 "Function to return default text to use for a bookmark annotation.
860 It takes one argument, the name of the bookmark, as a string.")
862 (defvar bookmark-edit-annotation-mode-map
863 (let ((map (make-sparse-keymap)))
864 (set-keymap-parent map text-mode-map)
865 (define-key map "\C-c\C-c" 'bookmark-send-edited-annotation)
866 map)
867 "Keymap for editing an annotation of a bookmark.")
869 (defun bookmark-insert-annotation (bookmark-name-or-record)
870 (insert (funcall bookmark-edit-annotation-text-func bookmark-name-or-record))
871 (let ((annotation (bookmark-get-annotation bookmark-name-or-record)))
872 (if (and annotation (not (string-equal annotation "")))
873 (insert annotation))))
875 (define-derived-mode bookmark-edit-annotation-mode
876 text-mode "Edit Bookmark Annotation"
877 "Mode for editing the annotation of bookmarks.
878 When you have finished composing, type \\[bookmark-send-annotation].
880 \\{bookmark-edit-annotation-mode-map}")
883 (defun bookmark-send-edited-annotation ()
884 "Use buffer contents as annotation for a bookmark.
885 Lines beginning with `#' are ignored."
886 (interactive)
887 (if (not (derived-mode-p 'bookmark-edit-annotation-mode))
888 (error "Not in bookmark-edit-annotation-mode"))
889 (goto-char (point-min))
890 (while (< (point) (point-max))
891 (if (looking-at "^#")
892 (bookmark-kill-line t)
893 (forward-line 1)))
894 ;; Take no chances with text properties.
895 (let ((annotation (buffer-substring-no-properties (point-min) (point-max)))
896 (bookmark-name bookmark-annotation-name))
897 (bookmark-set-annotation bookmark-name annotation)
898 (setq bookmark-alist-modification-count
899 (1+ bookmark-alist-modification-count))
900 (bookmark-bmenu-surreptitiously-rebuild-list))
901 (kill-buffer (current-buffer)))
904 (defun bookmark-edit-annotation (bookmark-name-or-record)
905 "Pop up a buffer for editing bookmark BOOKMARK-NAME-OR-RECORD's annotation."
906 (pop-to-buffer (generate-new-buffer-name "*Bookmark Annotation Compose*"))
907 (bookmark-insert-annotation bookmark-name-or-record)
908 (bookmark-edit-annotation-mode)
909 (set (make-local-variable 'bookmark-annotation-name)
910 bookmark-name-or-record))
913 (defun bookmark-buffer-name ()
914 "Return the name of the current buffer in a form usable as a bookmark name.
915 If the buffer is associated with a file or directory, use that name."
916 (cond
917 ;; Or are we a file?
918 (buffer-file-name (file-name-nondirectory buffer-file-name))
919 ;; Or are we a directory?
920 ((and (boundp 'dired-directory) dired-directory)
921 (let* ((dirname (if (stringp dired-directory)
922 dired-directory
923 (car dired-directory)))
924 (idx (1- (length dirname))))
925 ;; Strip the trailing slash.
926 (if (= ?/ (aref dirname idx))
927 (file-name-nondirectory (substring dirname 0 idx))
928 ;; Else return the current-buffer
929 (buffer-name (current-buffer)))))
930 ;; If all else fails, use the buffer's name.
931 (t
932 (buffer-name (current-buffer)))))
935 (defun bookmark-yank-word ()
936 "Get the next word from buffer `bookmark-current-buffer' and append
937 it to the name of the bookmark currently being set, advancing
938 `bookmark-yank-point' by one word."
939 (interactive)
940 (let ((string (with-current-buffer bookmark-current-buffer
941 (goto-char bookmark-yank-point)
942 (buffer-substring-no-properties
943 (point)
944 (progn
945 (forward-word 1)
946 (setq bookmark-yank-point (point)))))))
947 (insert string)))
949 (defun bookmark-buffer-file-name ()
950 "Return the current buffer's file in a way useful for bookmarks."
951 ;; Abbreviate the path, both so it's shorter and so it's more
952 ;; portable. E.g., the user's home dir might be a different
953 ;; path on different machines, but "~/" will still reach it.
954 (abbreviate-file-name
955 (cond
956 (buffer-file-name buffer-file-name)
957 ((and (boundp 'dired-directory) dired-directory)
958 (if (stringp dired-directory)
959 dired-directory
960 (car dired-directory)))
961 (t (error "Buffer not visiting a file or directory")))))
964 (defun bookmark-maybe-load-default-file ()
965 "If bookmarks have not been loaded from the default place, load them."
966 (and (not bookmarks-already-loaded)
967 (null bookmark-alist)
968 (prog2
969 (and
970 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
971 ;; to be renamed.
972 (file-exists-p bookmark-old-default-file)
973 (not (file-exists-p bookmark-default-file))
974 (rename-file bookmark-old-default-file
975 bookmark-default-file))
976 ;; return t so the `and' will continue...
977 t)
979 (file-readable-p bookmark-default-file)
980 (bookmark-load bookmark-default-file t t)
981 (setq bookmarks-already-loaded t)))
984 (defun bookmark-maybe-sort-alist ()
985 "Return `bookmark-alist' for display.
986 If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist."
987 (if bookmark-sort-flag
988 (sort (copy-alist bookmark-alist)
989 (function
990 (lambda (x y) (string-lessp (car x) (car y)))))
991 bookmark-alist))
994 (defvar bookmark-after-jump-hook nil
995 "Hook run after `bookmark-jump' jumps to a bookmark.
996 Useful for example to unhide text in `outline-mode'.")
998 (defun bookmark--jump-via (bookmark-name-or-record display-function)
999 "Handle BOOKMARK-NAME-OR-RECORD, then call DISPLAY-FUNCTION with
1000 current buffer as argument.
1002 After calling DISPLAY-FUNCTION, set window point to the point specified
1003 by BOOKMARK-NAME-OR-RECORD, if necessary, run `bookmark-after-jump-hook',
1004 and then show any annotations for this bookmark."
1005 (bookmark-handle-bookmark bookmark-name-or-record)
1006 (save-current-buffer
1007 (funcall display-function (current-buffer)))
1008 (let ((win (get-buffer-window (current-buffer) 0)))
1009 (if win (set-window-point win (point))))
1010 ;; FIXME: we used to only run bookmark-after-jump-hook in
1011 ;; `bookmark-jump' itself, but in none of the other commands.
1012 (run-hooks 'bookmark-after-jump-hook)
1013 (if bookmark-automatically-show-annotations
1014 ;; if there is an annotation for this bookmark,
1015 ;; show it in a buffer.
1016 (bookmark-show-annotation bookmark-name-or-record)))
1019 ;;;###autoload
1020 (defun bookmark-jump (bookmark &optional display-func)
1021 "Jump to bookmark BOOKMARK (a point in some file).
1022 You may have a problem using this function if the value of variable
1023 `bookmark-alist' is nil. If that happens, you need to load in some
1024 bookmarks. See help on function `bookmark-load' for more about
1025 this.
1027 If the file pointed to by BOOKMARK no longer exists, you will be asked
1028 if you wish to give the bookmark a new location, and `bookmark-jump'
1029 will then jump to the new location, as well as recording it in place
1030 of the old one in the permanent bookmark record.
1032 BOOKMARK is usually a bookmark name (a string). It can also be a
1033 bookmark record, but this is usually only done by programmatic callers.
1035 If DISPLAY-FUNC is non-nil, it is a function to invoke to display the
1036 bookmark. It defaults to `switch-to-buffer'. A typical value for
1037 DISPLAY-FUNC would be `switch-to-buffer-other-window'."
1038 (interactive
1039 (list (bookmark-completing-read "Jump to bookmark"
1040 bookmark-current-bookmark)))
1041 (unless bookmark
1042 (error "No bookmark specified"))
1043 (bookmark-maybe-historicize-string bookmark)
1044 (bookmark--jump-via bookmark (or display-func 'switch-to-buffer)))
1047 ;;;###autoload
1048 (defun bookmark-jump-other-window (bookmark)
1049 "Jump to BOOKMARK in another window. See `bookmark-jump' for more."
1050 (interactive
1051 (list (bookmark-completing-read "Jump to bookmark (in another window)"
1052 bookmark-current-bookmark)))
1053 (bookmark-jump bookmark 'switch-to-buffer-other-window))
1056 (defun bookmark-jump-noselect (bookmark)
1057 "Return the location pointed to by BOOKMARK (see `bookmark-jump').
1058 The return value has the form (BUFFER . POINT).
1060 Note: this function is deprecated and is present for Emacs 22
1061 compatibility only."
1062 (declare (obsolete bookmark-handle-bookmark "23.1"))
1063 (save-excursion
1064 (bookmark-handle-bookmark bookmark)
1065 (cons (current-buffer) (point))))
1067 (defun bookmark-handle-bookmark (bookmark-name-or-record)
1068 "Call BOOKMARK-NAME-OR-RECORD's handler or `bookmark-default-handler'
1069 if it has none. This changes current buffer and point and returns nil,
1070 or signals a `file-error'.
1072 If BOOKMARK-NAME-OR-RECORD has no file, this is a no-op. If
1073 BOOKMARK-NAME-OR-RECORD has a file, but that file no longer exists,
1074 then offer interactively to relocate BOOKMARK-NAME-OR-RECORD."
1075 (condition-case err
1076 (funcall (or (bookmark-get-handler bookmark-name-or-record)
1077 'bookmark-default-handler)
1078 (bookmark-get-bookmark bookmark-name-or-record))
1079 (bookmark-error-no-filename ;file-error
1080 ;; We were unable to find the marked file, so ask if user wants to
1081 ;; relocate the bookmark, else remind them to consider deletion.
1082 (when (stringp bookmark-name-or-record)
1083 ;; `bookmark-name-or-record' can be either a bookmark name
1084 ;; (from `bookmark-alist') or a bookmark object. If it's an
1085 ;; object, we assume it's a bookmark used internally by some
1086 ;; other package.
1087 (let ((file (bookmark-get-filename bookmark-name-or-record)))
1088 (when file ;Don't know how to relocate if there's no `file'.
1089 ;; If file is not a dir, directory-file-name just returns file.
1090 (let ((display-name (directory-file-name file)))
1091 (ding)
1092 ;; Dialog boxes can accept a file target, but usually don't
1093 ;; know how to accept a directory target (at least, this
1094 ;; is true in Gnome on GNU/Linux, and Bug#4230 says it's
1095 ;; true on Windows as well). So we suppress file dialogs
1096 ;; when relocating.
1097 (let ((use-dialog-box nil)
1098 (use-file-dialog nil))
1099 (if (y-or-n-p (concat display-name " nonexistent. Relocate \""
1100 bookmark-name-or-record "\"? "))
1101 (progn
1102 (bookmark-relocate bookmark-name-or-record)
1103 ;; Try again.
1104 (funcall (or (bookmark-get-handler bookmark-name-or-record)
1105 'bookmark-default-handler)
1106 (bookmark-get-bookmark bookmark-name-or-record)))
1107 (message
1108 "Bookmark not relocated; consider removing it (%s)."
1109 bookmark-name-or-record)
1110 (signal (car err) (cdr err))))))))))
1111 ;; Added by db.
1112 (when (stringp bookmark-name-or-record)
1113 (setq bookmark-current-bookmark bookmark-name-or-record))
1114 nil)
1116 (define-error 'bookmark-errors nil)
1117 (define-error 'bookmark-error-no-filename
1118 "Bookmark has no associated file (or directory)" 'bookmark-errors)
1120 (defun bookmark-default-handler (bmk-record)
1121 "Default handler to jump to a particular bookmark location.
1122 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
1123 Changes current buffer and point and returns nil, or signals a `file-error'."
1124 (let ((file (bookmark-get-filename bmk-record))
1125 (buf (bookmark-prop-get bmk-record 'buffer))
1126 (forward-str (bookmark-get-front-context-string bmk-record))
1127 (behind-str (bookmark-get-rear-context-string bmk-record))
1128 (place (bookmark-get-position bmk-record)))
1129 (set-buffer
1130 (cond
1131 ((and file (file-readable-p file) (not (buffer-live-p buf)))
1132 (find-file-noselect file))
1133 ;; No file found. See if buffer BUF have been created.
1134 ((and buf (get-buffer buf)))
1135 (t ;; If not, raise error.
1136 (signal 'bookmark-error-no-filename (list 'stringp file)))))
1137 (if place (goto-char place))
1138 ;; Go searching forward first. Then, if forward-str exists and
1139 ;; was found in the file, we can search backward for behind-str.
1140 ;; Rationale is that if text was inserted between the two in the
1141 ;; file, it's better to be put before it so you can read it,
1142 ;; rather than after and remain perhaps unaware of the changes.
1143 (when (and forward-str (search-forward forward-str (point-max) t))
1144 (goto-char (match-beginning 0)))
1145 (when (and behind-str (search-backward behind-str (point-min) t))
1146 (goto-char (match-end 0)))
1147 nil))
1149 ;;;###autoload
1150 (defun bookmark-relocate (bookmark-name)
1151 "Relocate BOOKMARK-NAME to another file, reading file name with minibuffer.
1153 This makes an already existing bookmark point to that file, instead of
1154 the one it used to point at. Useful when a file has been renamed
1155 after a bookmark was set in it."
1156 (interactive (list (bookmark-completing-read "Bookmark to relocate")))
1157 (bookmark-maybe-historicize-string bookmark-name)
1158 (bookmark-maybe-load-default-file)
1159 (let* ((bmrk-filename (bookmark-get-filename bookmark-name))
1160 (newloc (abbreviate-file-name
1161 (expand-file-name
1162 (read-file-name
1163 (format "Relocate %s to: " bookmark-name)
1164 (file-name-directory bmrk-filename))))))
1165 (bookmark-set-filename bookmark-name newloc)
1166 (setq bookmark-alist-modification-count
1167 (1+ bookmark-alist-modification-count))
1168 (if (bookmark-time-to-save-p)
1169 (bookmark-save))
1170 (bookmark-bmenu-surreptitiously-rebuild-list)))
1173 ;;;###autoload
1174 (defun bookmark-insert-location (bookmark-name &optional no-history)
1175 "Insert the name of the file associated with BOOKMARK-NAME.
1177 Optional second arg NO-HISTORY means don't record this in the
1178 minibuffer history list `bookmark-history'."
1179 (interactive (list (bookmark-completing-read "Insert bookmark location")))
1180 (or no-history (bookmark-maybe-historicize-string bookmark-name))
1181 (insert (bookmark-location bookmark-name)))
1183 ;;;###autoload
1184 (defalias 'bookmark-locate 'bookmark-insert-location)
1186 (defun bookmark-location (bookmark-name-or-record)
1187 "Return a description of the location of BOOKMARK-NAME-OR-RECORD."
1188 (bookmark-maybe-load-default-file)
1189 ;; We could call the `handler' and ask for it to construct a description
1190 ;; dynamically: it would open up several new possibilities, but it
1191 ;; would have the major disadvantage of forcing to load each and
1192 ;; every handler when the user calls bookmark-menu.
1193 (or (bookmark-prop-get bookmark-name-or-record 'location)
1194 (bookmark-get-filename bookmark-name-or-record)
1195 "-- Unknown location --"))
1198 ;;;###autoload
1199 (defun bookmark-rename (old-name &optional new-name)
1200 "Change the name of OLD-NAME bookmark to NEW-NAME name.
1201 If called from keyboard, prompt for OLD-NAME and NEW-NAME.
1202 If called from menubar, select OLD-NAME from a menu and prompt for NEW-NAME.
1204 If called from Lisp, prompt for NEW-NAME if only OLD-NAME was passed
1205 as an argument. If called with two strings, then no prompting is done.
1206 You must pass at least OLD-NAME 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
1210 name."
1211 (interactive (list (bookmark-completing-read "Old bookmark name")))
1212 (bookmark-maybe-historicize-string old-name)
1213 (bookmark-maybe-load-default-file)
1215 (setq bookmark-yank-point (point))
1216 (setq bookmark-current-buffer (current-buffer))
1217 (let ((final-new-name
1218 (or new-name ; use second arg, if non-nil
1219 (read-from-minibuffer
1220 "New name: "
1221 nil
1222 (let ((now-map (copy-keymap minibuffer-local-map)))
1223 (define-key now-map "\C-w" 'bookmark-yank-word)
1224 now-map)
1225 nil
1226 'bookmark-history))))
1227 (bookmark-set-name old-name final-new-name)
1228 (setq bookmark-current-bookmark final-new-name)
1229 (bookmark-bmenu-surreptitiously-rebuild-list)
1230 (setq bookmark-alist-modification-count
1231 (1+ bookmark-alist-modification-count))
1232 (if (bookmark-time-to-save-p)
1233 (bookmark-save))))
1236 ;;;###autoload
1237 (defun bookmark-insert (bookmark-name)
1238 "Insert the text of the file pointed to by bookmark BOOKMARK-NAME.
1239 BOOKMARK-NAME is a bookmark name (a string), not a bookmark record.
1241 You may have a problem using this function if the value of variable
1242 `bookmark-alist' is nil. If that happens, you need to load in some
1243 bookmarks. See help on function `bookmark-load' for more about
1244 this."
1245 (interactive (list (bookmark-completing-read "Insert bookmark contents")))
1246 (bookmark-maybe-historicize-string bookmark-name)
1247 (bookmark-maybe-load-default-file)
1248 (let ((orig-point (point))
1249 (str-to-insert
1250 (save-current-buffer
1251 (bookmark-handle-bookmark bookmark-name)
1252 (buffer-string))))
1253 (insert str-to-insert)
1254 (push-mark)
1255 (goto-char orig-point)))
1258 ;;;###autoload
1259 (defun bookmark-delete (bookmark-name &optional batch)
1260 "Delete BOOKMARK-NAME from the bookmark list.
1262 Removes only the first instance of a bookmark with that name. If
1263 there are one or more other bookmarks with the same name, they will
1264 not be deleted. Defaults to the \"current\" bookmark (that is, the
1265 one most recently used in this file, if any).
1266 Optional second arg BATCH means don't update the bookmark list buffer,
1267 probably because we were called from there."
1268 (interactive
1269 (list (bookmark-completing-read "Delete bookmark"
1270 bookmark-current-bookmark)))
1271 (bookmark-maybe-historicize-string bookmark-name)
1272 (bookmark-maybe-load-default-file)
1273 (let ((will-go (bookmark-get-bookmark bookmark-name 'noerror)))
1274 (setq bookmark-alist (delq will-go bookmark-alist))
1275 ;; Added by db, nil bookmark-current-bookmark if the last
1276 ;; occurrence has been deleted
1277 (or (bookmark-get-bookmark bookmark-current-bookmark 'noerror)
1278 (setq bookmark-current-bookmark nil)))
1279 (unless batch
1280 (bookmark-bmenu-surreptitiously-rebuild-list))
1281 (setq bookmark-alist-modification-count
1282 (1+ bookmark-alist-modification-count))
1283 (when (bookmark-time-to-save-p)
1284 (bookmark-save)))
1287 (defun bookmark-time-to-save-p (&optional final-time)
1288 "Return t if it is time to save bookmarks to disk, nil otherwise.
1289 Optional argument FINAL-TIME means this is being called when Emacs
1290 is being killed, so save even if `bookmark-save-flag' is a number and
1291 is greater than `bookmark-alist-modification-count'."
1292 ;; By Gregory M. Saunders <saunders{_AT_}cis.ohio-state.edu>
1293 (cond (final-time
1294 (and (> bookmark-alist-modification-count 0)
1295 bookmark-save-flag))
1296 ((numberp bookmark-save-flag)
1297 (>= bookmark-alist-modification-count bookmark-save-flag))
1298 (t
1299 nil)))
1302 ;;;###autoload
1303 (defun bookmark-write ()
1304 "Write bookmarks to a file (reading the file name with the minibuffer)."
1305 (declare (interactive-only bookmark-save))
1306 (interactive)
1307 (bookmark-maybe-load-default-file)
1308 (bookmark-save t))
1311 ;;;###autoload
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 PARG and
1319 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'."
1328 (interactive "P")
1329 (bookmark-maybe-load-default-file)
1330 (cond
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))
1349 \f
1350 (defun bookmark-write-file (file)
1351 "Write `bookmark-alist' to FILE."
1352 (bookmark-maybe-message "Saving bookmarks to file %s..." file)
1353 (with-current-buffer (get-buffer-create " *Bookmarks*")
1354 (goto-char (point-min))
1355 (delete-region (point-min) (point-max))
1356 (let ((print-length nil)
1357 (print-level nil)
1358 ;; See bug #12503 for why we bind `print-circle'. Users
1359 ;; can define their own bookmark types, which can result in
1360 ;; arbitrary Lisp objects being stored in bookmark records,
1361 ;; and some users create objects containing circularities.
1362 (print-circle t))
1363 (bookmark-insert-file-format-version-stamp)
1364 (insert "(")
1365 ;; Rather than a single call to `pp' we make one per bookmark.
1366 ;; Apparently `pp' has a poor algorithmic complexity, so this
1367 ;; scales a lot better. bug#4485.
1368 (dolist (i bookmark-alist) (pp i (current-buffer)))
1369 (insert ")")
1370 (let ((version-control
1371 (cond
1372 ((null bookmark-version-control) nil)
1373 ((eq 'never bookmark-version-control) 'never)
1374 ((eq 'nospecial bookmark-version-control) version-control)
1375 (t t))))
1376 (condition-case nil
1377 (write-region (point-min) (point-max) file)
1378 (file-error (message "Can't write %s" file)))
1379 (kill-buffer (current-buffer))
1380 (bookmark-maybe-message
1381 "Saving bookmarks to file %s...done" file)))))
1384 (defun bookmark-import-new-list (new-list)
1385 "Add NEW-LIST of bookmarks to `bookmark-alist'.
1386 Rename new bookmarks as needed using suffix \"<N>\" (N=1,2,3...), when
1387 they conflict with existing bookmark names."
1388 (let ((names (bookmark-all-names)))
1389 (dolist (full-record new-list)
1390 (bookmark-maybe-rename full-record names)
1391 (setq bookmark-alist (nconc bookmark-alist (list full-record)))
1392 (push (bookmark-name-from-full-record full-record) names))))
1395 (defun bookmark-maybe-rename (full-record names)
1396 "Rename bookmark FULL-RECORD if its current name is already used.
1397 This is a helper for `bookmark-import-new-list'."
1398 (let ((found-name (bookmark-name-from-full-record full-record)))
1399 (if (member found-name names)
1400 ;; We've got a conflict, so generate a new name
1401 (let ((count 2)
1402 (new-name found-name))
1403 (while (member new-name names)
1404 (setq new-name (concat found-name (format "<%d>" count)))
1405 (setq count (1+ count)))
1406 (bookmark-set-name full-record new-name)))))
1409 ;;;###autoload
1410 (defun bookmark-load (file &optional overwrite no-msg)
1411 "Load bookmarks from FILE (which must be in bookmark format).
1412 Appends loaded bookmarks to the front of the list of bookmarks. If
1413 optional second argument OVERWRITE is non-nil, existing bookmarks are
1414 destroyed. Optional third arg NO-MSG means don't display any messages
1415 while loading.
1417 If you load a file that doesn't contain a proper bookmark alist, you
1418 will corrupt Emacs's bookmark list. Generally, you should only load
1419 in files that were created with the bookmark functions in the first
1420 place. Your own personal bookmark file, `~/.emacs.bmk', is
1421 maintained automatically by Emacs; you shouldn't need to load it
1422 explicitly.
1424 If you load a file containing bookmarks with the same names as
1425 bookmarks already present in your Emacs, the new bookmarks will get
1426 unique numeric suffixes \"<2>\", \"<3>\", etc."
1427 (interactive
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)
1438 (if (null no-msg)
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)))
1445 (if (listp blist)
1446 (progn
1447 (if overwrite
1448 (progn
1449 (setq bookmark-alist blist)
1450 (setq bookmark-alist-modification-count 0))
1451 ;; else
1452 (bookmark-import-new-list blist)
1453 (setq bookmark-alist-modification-count
1454 (1+ bookmark-alist-modification-count)))
1455 (if (string-equal
1456 (abbreviate-file-name
1457 (expand-file-name bookmark-default-file))
1458 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)))
1463 (if (null no-msg)
1464 (bookmark-maybe-message "Loading bookmarks from %s...done" file))))
1467 \f
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)
1508 map))
1510 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1511 ;; data.
1512 (put 'bookmark-bmenu-mode 'mode-class 'special)
1515 ;; todo: need to display whether or not bookmark exists as a buffer in
1516 ;; flag column.
1518 ;; Format:
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*")
1526 (save-excursion
1527 (save-window-excursion
1528 (bookmark-bmenu-list)))))
1531 ;;;###autoload
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."
1537 (interactive)
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)
1542 (set-buffer buf)))
1543 (let ((inhibit-read-only t))
1544 (erase-buffer)
1545 (if (not bookmark-bmenu-use-header-line)
1546 (insert "% Bookmark\n- --------\n"))
1547 (add-text-properties (point-min) (point)
1548 '(font-lock-face bookmark-menu-heading))
1549 (dolist (full-record (bookmark-maybe-sort-alist))
1550 (let ((name (bookmark-name-from-full-record full-record))
1551 (annotation (bookmark-get-annotation full-record))
1552 (start (point))
1553 end)
1554 ;; if a bookmark has an annotation, prepend a "*"
1555 ;; in the list of bookmarks.
1556 (insert (if (and annotation (not (string-equal annotation "")))
1557 " *" " ")
1558 name)
1559 (setq end (point))
1560 (put-text-property
1561 (+ bookmark-bmenu-marks-width start) end 'bookmark-name-prop name)
1562 (when (display-mouse-p)
1563 (add-text-properties
1564 (+ bookmark-bmenu-marks-width start) end
1565 '(font-lock-face bookmark-menu-bookmark
1566 mouse-face highlight
1567 follow-link t
1568 help-echo "mouse-2: go to this bookmark in other window")))
1569 (insert "\n")))
1570 (set-buffer-modified-p (not (= bookmark-alist-modification-count 0)))
1571 (goto-char (point-min))
1572 (bookmark-bmenu-mode)
1573 (if bookmark-bmenu-use-header-line
1574 (bookmark-bmenu-set-header)
1575 (forward-line bookmark-bmenu-inline-header-height))
1576 (when (and bookmark-alist bookmark-bmenu-toggle-filenames)
1577 (bookmark-bmenu-toggle-filenames t))))
1579 ;;;###autoload
1580 (defalias 'list-bookmarks 'bookmark-bmenu-list)
1581 ;;;###autoload
1582 (defalias 'edit-bookmarks 'bookmark-bmenu-list)
1584 (defun bookmark-bmenu-set-header ()
1585 "Sets the immutable header line."
1586 (let ((header (concat "%% " "Bookmark")))
1587 (when bookmark-bmenu-toggle-filenames
1588 (setq header (concat header
1589 (make-string (- bookmark-bmenu-file-column
1590 (- (length header) 3)) ?\s)
1591 "File")))
1592 (let ((pos 0))
1593 (while (string-match "[ \t\n]+" header pos)
1594 (setq pos (match-end 0))
1595 (put-text-property (match-beginning 0) pos 'display
1596 (list 'space :align-to (- pos 1))
1597 header)))
1598 (put-text-property 0 2 'face 'fixed-pitch header)
1599 (setq header (concat (propertize " " 'display '(space :align-to 0))
1600 header))
1601 ;; Code derived from `buff-menu.el'.
1602 (setq header-line-format header)))
1604 (define-derived-mode bookmark-bmenu-mode special-mode "Bookmark Menu"
1605 "Major mode for editing a list of bookmarks.
1606 Each line describes one of the bookmarks in Emacs.
1607 Letters do not insert themselves; instead, they are commands.
1608 Bookmark names preceded by a \"*\" have annotations.
1609 \\<bookmark-bmenu-mode-map>
1610 \\[bookmark-bmenu-mark] -- mark bookmark to be displayed.
1611 \\[bookmark-bmenu-select] -- select bookmark of line point is on.
1612 Also show bookmarks marked using m in other windows.
1613 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1614 \\[bookmark-bmenu-locate] -- display (in minibuffer) location of this bookmark.
1615 \\[bookmark-bmenu-1-window] -- select this bookmark in full-frame window.
1616 \\[bookmark-bmenu-2-window] -- select this bookmark in one window,
1617 together with bookmark selected before this one in another window.
1618 \\[bookmark-bmenu-this-window] -- select this bookmark in place of the bookmark menu buffer.
1619 \\[bookmark-bmenu-other-window] -- select this bookmark in another window,
1620 so the bookmark menu bookmark remains visible in its window.
1621 \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark.
1622 \\[bookmark-bmenu-rename] -- rename this bookmark (prompts for new name).
1623 \\[bookmark-bmenu-relocate] -- relocate this bookmark's file (prompts for new file).
1624 \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down.
1625 \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up.
1626 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1627 \\[bookmark-bmenu-save] -- save the current bookmark list in the default file.
1628 With a prefix arg, prompts for a file to save in.
1629 \\[bookmark-bmenu-load] -- load in a file of bookmarks (prompts for file.)
1630 \\[bookmark-bmenu-unmark] -- remove all kinds of marks from current line.
1631 With prefix argument, also move up one line.
1632 \\[bookmark-bmenu-backup-unmark] -- back up a line and remove marks.
1633 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1634 in another buffer.
1635 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1636 \\[bookmark-bmenu-edit-annotation] -- edit the annotation for the current bookmark."
1637 (setq truncate-lines t)
1638 (setq buffer-read-only t))
1641 (defun bookmark-bmenu-toggle-filenames (&optional show)
1642 "Toggle whether filenames are shown in the bookmark list.
1643 Optional argument SHOW means show them unconditionally."
1644 (interactive)
1645 (cond
1646 (show
1647 (setq bookmark-bmenu-toggle-filenames nil)
1648 (bookmark-bmenu-show-filenames)
1649 (setq bookmark-bmenu-toggle-filenames t))
1650 (bookmark-bmenu-toggle-filenames
1651 (bookmark-bmenu-hide-filenames)
1652 (setq bookmark-bmenu-toggle-filenames nil))
1653 (t
1654 (bookmark-bmenu-show-filenames)
1655 (setq bookmark-bmenu-toggle-filenames t)))
1656 (when bookmark-bmenu-use-header-line
1657 (bookmark-bmenu-set-header)))
1660 (defun bookmark-bmenu-show-filenames (&optional force)
1661 "In an interactive bookmark list, show filenames along with bookmarks.
1662 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1663 mainly for debugging, and should not be necessary in normal use."
1664 (if (and (not force) bookmark-bmenu-toggle-filenames)
1665 nil ;already shown, so do nothing
1666 (with-buffer-modified-unmodified
1667 (save-excursion
1668 (save-window-excursion
1669 (goto-char (point-min))
1670 (if (not bookmark-bmenu-use-header-line)
1671 (forward-line bookmark-bmenu-inline-header-height))
1672 (setq bookmark-bmenu-hidden-bookmarks ())
1673 (let ((inhibit-read-only t))
1674 (while (< (point) (point-max))
1675 (let ((bmrk (bookmark-bmenu-bookmark)))
1676 (push bmrk bookmark-bmenu-hidden-bookmarks)
1677 (let ((start (line-end-position)))
1678 (move-to-column bookmark-bmenu-file-column t)
1679 ;; Strip off `mouse-face' from the white spaces region.
1680 (if (display-mouse-p)
1681 (remove-text-properties start (point)
1682 '(mouse-face nil help-echo nil))))
1683 (delete-region (point) (progn (end-of-line) (point)))
1684 (insert " ")
1685 ;; Pass the NO-HISTORY arg:
1686 (bookmark-insert-location bmrk t)
1687 (forward-line 1)))))))))
1690 (defun bookmark-bmenu-hide-filenames (&optional force)
1691 "In an interactive bookmark list, hide the filenames of the bookmarks.
1692 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1693 mainly for debugging, and should not be necessary in normal use."
1694 (when (and (not force) bookmark-bmenu-toggle-filenames)
1695 ;; nothing to hide if above is nil
1696 (with-buffer-modified-unmodified
1697 (save-excursion
1698 (goto-char (point-min))
1699 (if (not bookmark-bmenu-use-header-line)
1700 (forward-line bookmark-bmenu-inline-header-height))
1701 (setq bookmark-bmenu-hidden-bookmarks
1702 (nreverse bookmark-bmenu-hidden-bookmarks))
1703 (let ((inhibit-read-only t))
1704 (while bookmark-bmenu-hidden-bookmarks
1705 (move-to-column bookmark-bmenu-marks-width t)
1706 (bookmark-kill-line)
1707 (let ((name (pop bookmark-bmenu-hidden-bookmarks))
1708 (start (point)))
1709 (insert name)
1710 (put-text-property start (point) 'bookmark-name-prop name)
1711 (if (display-mouse-p)
1712 (add-text-properties
1713 start (point)
1714 '(font-lock-face bookmark-menu-bookmark
1715 mouse-face highlight
1716 follow-link t help-echo
1717 "mouse-2: go to this bookmark in other window"))))
1718 (forward-line 1)))))))
1721 (defun bookmark-bmenu-ensure-position ()
1722 "If point is not on a bookmark line, move it to one.
1723 If before the first bookmark line, move to the first; if after the
1724 last full line, move to the last full line. The return value is undefined."
1725 (cond ((and (not bookmark-bmenu-use-header-line)
1726 (< (count-lines (point-min) (point))
1727 bookmark-bmenu-inline-header-height))
1728 (goto-char (point-min))
1729 (forward-line bookmark-bmenu-inline-header-height))
1730 ((and (bolp) (eobp))
1731 (beginning-of-line 0))))
1734 (defun bookmark-bmenu-bookmark ()
1735 "Return the bookmark for this line in an interactive bookmark list buffer."
1736 (bookmark-bmenu-ensure-position)
1737 (save-excursion
1738 (beginning-of-line)
1739 (forward-char bookmark-bmenu-marks-width)
1740 (get-text-property (point) 'bookmark-name-prop)))
1743 (defun bookmark-show-annotation (bookmark-name-or-record)
1744 "Display the annotation for BOOKMARK-NAME-OR-RECORD in a buffer,
1745 if an annotation exists."
1746 (let ((annotation (bookmark-get-annotation bookmark-name-or-record)))
1747 (when (and annotation (not (string-equal annotation "")))
1748 (save-excursion
1749 (let ((old-buf (current-buffer)))
1750 (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t)
1751 (delete-region (point-min) (point-max))
1752 (insert annotation)
1753 (goto-char (point-min))
1754 (switch-to-buffer-other-window old-buf))))))
1757 (defun bookmark-show-all-annotations ()
1758 "Display the annotations for all bookmarks in a buffer."
1759 (save-selected-window
1760 (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t)
1761 (delete-region (point-min) (point-max))
1762 (dolist (full-record (bookmark-maybe-sort-alist))
1763 (let* ((name (bookmark-name-from-full-record full-record))
1764 (ann (bookmark-get-annotation full-record)))
1765 (insert (concat name ":\n"))
1766 (if (and ann (not (string-equal ann "")))
1767 ;; insert the annotation, indented by 4 spaces.
1768 (progn
1769 (save-excursion (insert ann) (unless (bolp)
1770 (insert "\n")))
1771 (while (< (point) (point-max))
1772 (beginning-of-line) ; paranoia
1773 (insert " ")
1774 (forward-line)
1775 (end-of-line))))))
1776 (goto-char (point-min))))
1779 (defun bookmark-bmenu-mark ()
1780 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1781 (interactive)
1782 (beginning-of-line)
1783 (bookmark-bmenu-ensure-position)
1784 (with-buffer-modified-unmodified
1785 (let ((inhibit-read-only t))
1786 (delete-char 1)
1787 (insert ?>)
1788 (forward-line 1)
1789 (bookmark-bmenu-ensure-position))))
1792 (defun bookmark-bmenu-select ()
1793 "Select this line's bookmark; also display bookmarks marked with `>'.
1794 You can mark bookmarks with the \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-mark] command."
1795 (interactive)
1796 (let ((bmrk (bookmark-bmenu-bookmark))
1797 (menu (current-buffer))
1798 (others ())
1799 tem)
1800 (goto-char (point-min))
1801 (while (re-search-forward "^>" nil t)
1802 (setq tem (bookmark-bmenu-bookmark))
1803 (let ((inhibit-read-only t))
1804 (delete-char -1)
1805 (insert ?\s))
1806 (or (string-equal tem bmrk)
1807 (member tem others)
1808 (setq others (cons tem others))))
1809 (setq others (nreverse others)
1810 tem (/ (1- (frame-height)) (1+ (length others))))
1811 (delete-other-windows)
1812 (bookmark-jump bmrk)
1813 (bury-buffer menu)
1814 (if others
1815 (while others
1816 (split-window nil tem)
1817 (other-window 1)
1818 (bookmark-jump (car others))
1819 (setq others (cdr others)))
1820 (other-window 1))))
1823 (defun bookmark-bmenu-any-marks ()
1824 "Return non-nil if any bookmarks are marked in the marks column."
1825 (save-excursion
1826 (goto-char (point-min))
1827 (bookmark-bmenu-ensure-position)
1828 (catch 'found-mark
1829 (while (not (eobp))
1830 (beginning-of-line)
1831 (if (looking-at "^\\S-")
1832 (throw 'found-mark t)
1833 (forward-line 1)))
1834 nil)))
1837 (defun bookmark-bmenu-save (parg)
1838 "Save the current list into a bookmark file.
1839 With a prefix arg, prompts for a file to save them in."
1840 (interactive "P")
1841 (save-excursion
1842 (save-window-excursion
1843 (bookmark-save parg)
1844 (set-buffer-modified-p nil))))
1847 (defun bookmark-bmenu-load ()
1848 "Load the bookmark file and rebuild the bookmark menu-buffer."
1849 (interactive)
1850 (bookmark-bmenu-ensure-position)
1851 (save-excursion
1852 (save-window-excursion
1853 ;; This will call `bookmark-bmenu-list'
1854 (call-interactively 'bookmark-load))))
1857 (defun bookmark-bmenu-1-window ()
1858 "Select this line's bookmark, alone, in full frame."
1859 (interactive)
1860 (bookmark-jump (bookmark-bmenu-bookmark))
1861 (bury-buffer (other-buffer))
1862 (delete-other-windows))
1865 (defun bookmark-bmenu-2-window ()
1866 "Select this line's bookmark, with previous buffer in second window."
1867 (interactive)
1868 (let ((bmrk (bookmark-bmenu-bookmark))
1869 (menu (current-buffer))
1870 (pop-up-windows t))
1871 (delete-other-windows)
1872 (switch-to-buffer (other-buffer) nil t)
1873 (bookmark--jump-via bmrk 'pop-to-buffer)
1874 (bury-buffer menu)))
1877 (defun bookmark-bmenu-this-window ()
1878 "Select this line's bookmark in this window."
1879 (interactive)
1880 (bookmark-jump (bookmark-bmenu-bookmark)))
1883 (defun bookmark-bmenu-other-window ()
1884 "Select this line's bookmark in other window, leaving bookmark menu visible."
1885 (interactive)
1886 (let ((bookmark (bookmark-bmenu-bookmark)))
1887 (bookmark--jump-via bookmark 'switch-to-buffer-other-window)))
1890 (defun bookmark-bmenu-switch-other-window ()
1891 "Make the other window select this line's bookmark.
1892 The current window remains selected."
1893 (interactive)
1894 (let ((bookmark (bookmark-bmenu-bookmark))
1895 (fun (lambda (b) (display-buffer b t))))
1896 (bookmark--jump-via bookmark fun)))
1898 (defun bookmark-bmenu-other-window-with-mouse (event)
1899 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1900 (interactive "e")
1901 (with-current-buffer (window-buffer (posn-window (event-end event)))
1902 (save-excursion
1903 (goto-char (posn-point (event-end event)))
1904 (bookmark-bmenu-other-window))))
1907 (defun bookmark-bmenu-show-annotation ()
1908 "Show the annotation for the current bookmark in another window."
1909 (interactive)
1910 (let ((bookmark (bookmark-bmenu-bookmark)))
1911 (bookmark-show-annotation bookmark)))
1914 (defun bookmark-bmenu-show-all-annotations ()
1915 "Show the annotation for all bookmarks in another window."
1916 (interactive)
1917 (bookmark-show-all-annotations))
1920 (defun bookmark-bmenu-edit-annotation ()
1921 "Edit the annotation for the current bookmark in another window."
1922 (interactive)
1923 (let ((bookmark (bookmark-bmenu-bookmark)))
1924 (bookmark-edit-annotation bookmark)))
1927 (defun bookmark-bmenu-unmark (&optional backup)
1928 "Cancel all requested operations on bookmark on this line and move down.
1929 Optional BACKUP means move up."
1930 (interactive "P")
1931 (beginning-of-line)
1932 (bookmark-bmenu-ensure-position)
1933 (with-buffer-modified-unmodified
1934 (let ((inhibit-read-only t))
1935 (delete-char 1)
1936 ;; any flags to reset according to circumstances? How about a
1937 ;; flag indicating whether this bookmark is being visited?
1938 ;; well, we don't have this now, so maybe later.
1939 (insert " "))
1940 (forward-line (if backup -1 1))
1941 (bookmark-bmenu-ensure-position)))
1944 (defun bookmark-bmenu-backup-unmark ()
1945 "Move up and cancel all requested operations on bookmark on line above."
1946 (interactive)
1947 (forward-line -1)
1948 (bookmark-bmenu-ensure-position)
1949 (bookmark-bmenu-unmark)
1950 (forward-line -1)
1951 (bookmark-bmenu-ensure-position))
1954 (defun bookmark-bmenu-delete ()
1955 "Mark bookmark on this line to be deleted.
1956 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1957 (interactive)
1958 (beginning-of-line)
1959 (bookmark-bmenu-ensure-position)
1960 (with-buffer-modified-unmodified
1961 (let ((inhibit-read-only t))
1962 (delete-char 1)
1963 (insert ?D)
1964 (forward-line 1)
1965 (bookmark-bmenu-ensure-position))))
1968 (defun bookmark-bmenu-delete-backwards ()
1969 "Mark bookmark on this line to be deleted, then move up one line.
1970 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1971 (interactive)
1972 (bookmark-bmenu-delete)
1973 (forward-line -2)
1974 (bookmark-bmenu-ensure-position)
1975 (forward-line 1)
1976 (bookmark-bmenu-ensure-position))
1979 (defun bookmark-bmenu-execute-deletions ()
1980 "Delete bookmarks flagged `D'."
1981 (interactive)
1982 (message "Deleting bookmarks...")
1983 (let ((o-point (point))
1984 (o-str (save-excursion
1985 (beginning-of-line)
1986 (unless (looking-at "^D")
1987 (buffer-substring
1988 (point)
1989 (progn (end-of-line) (point))))))
1990 (o-col (current-column)))
1991 (goto-char (point-min))
1992 (unless bookmark-bmenu-use-header-line
1993 (forward-line 1))
1994 (while (re-search-forward "^D" (point-max) t)
1995 (bookmark-delete (bookmark-bmenu-bookmark) t)) ; pass BATCH arg
1996 (bookmark-bmenu-list)
1997 (if o-str
1998 (progn
1999 (goto-char (point-min))
2000 (search-forward o-str)
2001 (beginning-of-line)
2002 (forward-char o-col))
2003 (goto-char o-point))
2004 (beginning-of-line)
2005 (message "Deleting bookmarks...done")
2006 ))
2009 (defun bookmark-bmenu-rename ()
2010 "Rename bookmark on current line. Prompts for a new name."
2011 (interactive)
2012 (let ((bmrk (bookmark-bmenu-bookmark))
2013 (thispoint (point)))
2014 (bookmark-rename bmrk)
2015 (goto-char thispoint)))
2018 (defun bookmark-bmenu-locate ()
2019 "Display location of this bookmark. Displays in the minibuffer."
2020 (interactive)
2021 (let ((bmrk (bookmark-bmenu-bookmark)))
2022 (message "%s" (bookmark-location bmrk))))
2024 (defun bookmark-bmenu-relocate ()
2025 "Change the file path of the bookmark on the current line,
2026 prompting with completion for the new path."
2027 (interactive)
2028 (let ((bmrk (bookmark-bmenu-bookmark))
2029 (thispoint (point)))
2030 (bookmark-relocate bmrk)
2031 (goto-char thispoint)))
2033 ;;; Bookmark-bmenu search
2035 (defun bookmark-bmenu-filter-alist-by-regexp (regexp)
2036 "Filter `bookmark-alist' with bookmarks matching REGEXP and rebuild list."
2037 (let ((bookmark-alist
2038 (cl-loop for i in bookmark-alist
2039 when (string-match regexp (car i)) collect i into new
2040 finally return new)))
2041 (bookmark-bmenu-list)))
2044 ;;;###autoload
2045 (defun bookmark-bmenu-search ()
2046 "Incremental search of bookmarks, hiding the non-matches as we go."
2047 (interactive)
2048 (let ((bmk (bookmark-bmenu-bookmark))
2049 (timer nil))
2050 (unwind-protect
2051 (minibuffer-with-setup-hook
2052 (lambda ()
2053 (setq timer (run-with-idle-timer
2054 bookmark-search-delay 'repeat
2055 #'(lambda (buf)
2056 (with-current-buffer buf
2057 (bookmark-bmenu-filter-alist-by-regexp
2058 (minibuffer-contents))))
2059 (current-buffer))))
2060 (read-string "Pattern: ")
2061 (when timer (cancel-timer timer) (setq timer nil)))
2062 (when timer ;; Signalled an error or a `quit'.
2063 (cancel-timer timer)
2064 (bookmark-bmenu-list)
2065 (bookmark-bmenu-goto-bookmark bmk)))))
2067 (defun bookmark-bmenu-goto-bookmark (name)
2068 "Move point to bookmark with name NAME."
2069 (goto-char (point-min))
2070 (while (not (or (equal name (bookmark-bmenu-bookmark))
2071 (eobp)))
2072 (forward-line 1))
2073 (forward-line 0))
2076 \f
2077 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2079 (defun bookmark-menu-popup-paned-menu (event name entries)
2080 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2081 That is, ENTRIES is a list of strings which appear as the choices
2082 in the menu.
2083 The number of panes depends on the number of entries.
2084 The visible entries are truncated to `bookmark-menu-length', but the
2085 strings returned are not."
2086 (let ((f-height (/ (frame-height) 2))
2087 (pane-list nil)
2088 (iter 0))
2089 (while entries
2090 (let (lst
2091 (count 0))
2092 (while (and (< count f-height) entries)
2093 (let ((str (car entries)))
2094 (push (cons
2095 (if (> (length str) bookmark-menu-length)
2096 (substring str 0 bookmark-menu-length)
2097 str)
2098 str)
2099 lst)
2100 (setq entries (cdr entries))
2101 (setq count (1+ count))))
2102 (setq iter (1+ iter))
2103 (push (cons
2104 (format "-*- %s (%d) -*-" name iter)
2105 (nreverse lst))
2106 pane-list)))
2108 ;; Popup the menu and return the string.
2109 (x-popup-menu event (cons (concat "-*- " name " -*-")
2110 (nreverse pane-list)))))
2113 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2114 ;; following works, and for explaining what to do to make it work.
2116 ;; We MUST autoload EACH form used to set up this variable's value, so
2117 ;; that the whole job is done in loaddefs.el.
2119 ;; Emacs menubar stuff.
2121 ;;;###autoload
2122 (defvar menu-bar-bookmark-map
2123 (let ((map (make-sparse-keymap "Bookmark functions")))
2124 (bindings--define-key map [load]
2125 '(menu-item "Load a Bookmark File..." bookmark-load
2126 :help "Load bookmarks from a bookmark file)"))
2127 (bindings--define-key map [write]
2128 '(menu-item "Save Bookmarks As..." bookmark-write
2129 :help "Write bookmarks to a file (reading the file name with the minibuffer)"))
2130 (bindings--define-key map [save]
2131 '(menu-item "Save Bookmarks" bookmark-save
2132 :help "Save currently defined bookmarks"))
2133 (bindings--define-key map [edit]
2134 '(menu-item "Edit Bookmark List" bookmark-bmenu-list
2135 :help "Display a list of existing bookmarks"))
2136 (bindings--define-key map [delete]
2137 '(menu-item "Delete Bookmark..." bookmark-delete
2138 :help "Delete a bookmark from the bookmark list"))
2139 (bindings--define-key map [rename]
2140 '(menu-item "Rename Bookmark..." bookmark-rename
2141 :help "Change the name of a bookmark"))
2142 (bindings--define-key map [locate]
2143 '(menu-item "Insert Location..." bookmark-locate
2144 :help "Insert the name of the file associated with a bookmark"))
2145 (bindings--define-key map [insert]
2146 '(menu-item "Insert Contents..." bookmark-insert
2147 :help "Insert the text of the file pointed to by a bookmark"))
2148 (bindings--define-key map [set]
2149 '(menu-item "Set Bookmark..." bookmark-set
2150 :help "Set a bookmark named inside a file."))
2151 (bindings--define-key map [jump]
2152 '(menu-item "Jump to Bookmark..." bookmark-jump
2153 :help "Jump to a bookmark (a point in some file)"))
2154 map))
2156 ;;;###autoload
2157 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2159 ;; make bookmarks appear toward the right side of the menu.
2160 (if (boundp 'menu-bar-final-items)
2161 (if menu-bar-final-items
2162 (push 'bookmark menu-bar-final-items))
2163 (setq menu-bar-final-items '(bookmark)))
2165 ;;;; end bookmark menu stuff ;;;;
2167 \f
2168 ;; Load Hook
2169 (defvar bookmark-load-hook nil
2170 "Hook run at the end of loading library `bookmark.el'.")
2172 ;; Exit Hook, called from kill-emacs-hook
2173 (define-obsolete-variable-alias 'bookmark-exit-hooks
2174 'bookmark-exit-hook "22.1")
2175 (defvar bookmark-exit-hook nil
2176 "Hook run when Emacs exits.")
2178 (defun bookmark-exit-hook-internal ()
2179 "Save bookmark state, if necessary, at Emacs exit time.
2180 This also runs `bookmark-exit-hook'."
2181 (run-hooks 'bookmark-exit-hook)
2182 (and (bookmark-time-to-save-p t)
2183 (bookmark-save)))
2185 (unless noninteractive
2186 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal))
2188 (defun bookmark-unload-function ()
2189 "Unload the Bookmark library."
2190 (when bookmark-save-flag (bookmark-save))
2191 ;; continue standard unloading
2192 nil)
2195 (run-hooks 'bookmark-load-hook)
2197 (provide 'bookmark)
2199 ;;; bookmark.el ends here