| blob | 8fbc92a75530612c86ae59ca5054b3d9954ca99c |
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:
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
51 "Setting, annotation and jumping to bookmarks."
56 "If non-nil, saving a bookmark queries for an annotation in a buffer."
62 "Controls when Emacs saves bookmarks to a file.
63 --> nil means never save bookmarks, except when `bookmark-save' is
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."
86 ;; defvared to avoid a compilation warning:
92 ;; In case user set `bookmark-file' in her .emacs:
93 bookmark-file
95 "File in which to save bookmarks by default."
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'."
114 "Non-nil means bookmark functions ignore case in completion."
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)."
128 "Non-nil means show annotations when jumping to a bookmark."
133 "Non-nil means to use an immovable header line.
134 This is as opposed to inline text at the top of the buffer."
140 "Number of lines used for the *Bookmark List* header
144 "Number of columns (chars) used for the *Bookmark List* marks column,
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]."
155 "Non-nil means show filenames when listing bookmarks.
156 A non-nil value may result in truncated bookmark names."
162 "Face used to highlight bookmark names in bookmark menu buffers."
166 "Maximum length of a bookmark name displayed on a popup menu."
170 ;; FIXME: Is it really worth a customization option?
172 "Time before `bookmark-bmenu-search' updates the display."
178 "Face used to highlight the heading in bookmark menu buffers."
183 ;;; No user-serviceable parts beyond this point.
185 ;; Added for lucid emacs compatibility, db
188 ;; suggested for lucid compatibility by david hughes:
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
204 ;; Read the help on all of these functions for details...
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
225 ;;;###autoload (fset 'bookmark-map bookmark-map)
227 \f
228 ;;; Core variables and data structures:
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,
269 ;; more stuff added by db.
272 "Name of bookmark most recently used in the current file.
273 It is buffer local, used to make moving a bookmark forward
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'
295 "The next point from which to pull source text for `bookmark-yank-word'.
301 \f
302 ;; Helper functions and macros.
305 "Run BODY while preserving the buffer's `buffer-modified-p' state."
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.
317 "Return the name of BOOKMARK-RECORD. BOOKMARK-RECORD is, e.g.,
318 one element from `bookmark-alist'."
323 "Return a list of all current bookmark names."
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."
338 bookmark-completion-ignore-case)
340 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)."
347 ;; The bookmark objects can either look like (NAME ALIST) or
348 ;; (NAME . ALIST), so we have to distinguish the two here.
354 "Set BOOKMARK-NAME-OR-RECORD's name to NEWNAME."
358 "Return the property PROP of BOOKMARK-NAME-OR-RECORD, or nil if none."
362 "Set the property PROP of BOOKMARK-NAME-OR-RECORD to VAL."
371 "Return the annotation of BOOKMARK-NAME-OR-RECORD, or nil if none."
375 "Set the annotation of BOOKMARK-NAME-OR-RECORD to ANN."
380 "Return the full filename of BOOKMARK-NAME-OR-RECORD, or nil if none."
385 "Set the full filename of BOOKMARK-NAME-OR-RECORD to FILENAME."
390 "Return the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD, or nil if none."
395 "Set the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD to POSITION."
400 "Return the front-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
405 "Set the front-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
410 "Return the rear-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
415 "Set the rear-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
420 "Return the handler function for BOOKMARK-NAME-OR-RECORD, or nil if none."
428 "Prompting with PROMPT, read a bookmark name in completion.
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."
450 action bookmark-alist string pred)))
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'."
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
483 "Return a new bookmark record (NAME . ALIST) for the current location."
485 ;; Set up default name if the function does not provide one.
489 ;; Set up defaults.
491 record 'defaults
496 record))
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."
506 ;; XEmacs's `set-text-properties' doesn't work on
507 ;; free-standing strings, apparently.
511 ;; already existing bookmark under that name and
512 ;; no prefix arg means just overwrite old bookmark
513 ;; Use the new (NAME . ALIST) format.
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...)
522 ;; Added by db
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)'."
549 bookmark-search-size)
553 nil))))
556 bookmark-search-size)
560 nil))))
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').
634 "The current version of the format used by bookmark files.
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."
652 ;; Else we're dealing with format version 0
657 ;; Else no hope of getting information here.
662 "Upgrade a version 0 alist OLD-LIST to the current version."
673 name
679 old-list))
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."
686 bookmark-file-format-version)
695 bookmark-file-format-version)
696 )
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."
708 ;; Else this is format version 0, the original one, which didn't
709 ;; even have version stamps.
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."
728 "Insert text indicating current version of bookmark file format."
731 bookmark-file-format-version))
734 ";;; "
735 bookmark-end-of-version-stamp-marker))
738 ;;; end file-format stuff
740 \f
741 ;;; Generic helpers.
744 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
748 \f
749 ;;; Core code:
755 map))
757 ;;;###autoload
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.
780 it removes only the first instance of a bookmark with that name from
781 the list of bookmarks.)"
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.
794 ;; Don't store default values in the record.
796 ;; When no defaults in the record, use its first element.
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).
803 bookmark-current-buffer)
811 nil
812 bookmark-minibuffer-read-name-map
813 nil nil defaults))))
817 ;; Ask for an annotation buffer for this bookmark
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."
834 ;; Defvars to avoid compilation warnings:
836 "Variable holding the name of the bookmark.
837 This is used in `bookmark-edit-annotation' to record the bookmark
842 "Return default annotation text for BOOKMARK-NAME.
843 The default annotation text is simply some text explaining how to use
844 annotations."
856 "Function to return default text to use for a bookmark annotation.
863 map)
873 text-mode "Edit Bookmark Annotation"
874 "Mode for editing the annotation of bookmarks.
881 "Use buffer contents as annotation for a bookmark.
882 Lines beginning with `#' are ignored."
891 ;; Take no chances with text properties.
902 "Pop up a buffer for editing bookmark BOOKMARK-NAME-OR-RECORD's annotation."
907 bookmark-name-or-record))
911 "Return the name of the current buffer in a form usable as a bookmark name.
912 If the buffer is associated with a file or directory, use that name."
914 ;; Or are we a file?
916 ;; Or are we a directory?
919 dired-directory
922 ;; Strip the trailing slash.
925 ;; Else return the current-buffer
927 ;; If all else fails, use the buffer's name.
933 "Get the next word from buffer `bookmark-current-buffer' and append
934 it to the name of the bookmark currently being set, advancing
935 `bookmark-yank-point' by one word."
947 "Return the current buffer's file in a way useful for bookmarks."
948 ;; Abbreviate the path, both so it's shorter and so it's more
949 ;; portable. E.g., the user's home dir might be a different
950 ;; path on different machines, but "~/" will still reach it.
956 dired-directory
962 "If bookmarks have not been loaded from the default place, load them."
967 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
968 ;; to be renamed.
972 bookmark-default-file))
973 ;; return t so the `and' will continue...
974 t)
982 "Return `bookmark-alist' for display.
983 If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist."
988 bookmark-alist))
992 "Hook run after `bookmark-jump' jumps to a bookmark.
996 "Handle BOOKMARK-NAME-OR-RECORD, then call DISPLAY-FUNCTION with
997 current buffer as argument.
999 After calling DISPLAY-FUNCTION, set window point to the point specified
1000 by BOOKMARK-NAME-OR-RECORD, if necessary, run `bookmark-after-jump-hook',
1001 and then show any annotations for this bookmark."
1007 ;; FIXME: we used to only run bookmark-after-jump-hook in
1008 ;; `bookmark-jump' itself, but in none of the other commands.
1011 ;; if there is an annotation for this bookmark,
1012 ;; show it in a buffer.
1016 ;;;###autoload
1018 "Jump to bookmark BOOKMARK (a point in some file).
1019 You may have a problem using this function if the value of variable
1020 `bookmark-alist' is nil. If that happens, you need to load in some
1021 bookmarks. See help on function `bookmark-load' for more about
1022 this.
1024 If the file pointed to by BOOKMARK no longer exists, you will be asked
1025 if you wish to give the bookmark a new location, and `bookmark-jump'
1026 will then jump to the new location, as well as recording it in place
1027 of the old one in the permanent bookmark record.
1029 BOOKMARK is usually a bookmark name (a string). It can also be a
1030 bookmark record, but this is usually only done by programmatic callers.
1032 If DISPLAY-FUNC is non-nil, it is a function to invoke to display the
1033 bookmark. It defaults to `switch-to-buffer'. A typical value for
1034 DISPLAY-FUNC would be `switch-to-buffer-other-window'."
1037 bookmark-current-bookmark)))
1044 ;;;###autoload
1046 "Jump to BOOKMARK in another window. See `bookmark-jump' for more."
1049 bookmark-current-bookmark)))
1054 "Return the location pointed to by BOOKMARK (see `bookmark-jump').
1055 The return value has the form (BUFFER . POINT).
1057 Note: this function is deprecated and is present for Emacs 22
1058 compatibility only."
1065 "Call BOOKMARK-NAME-OR-RECORD's handler or `bookmark-default-handler'
1066 if it has none. This changes current buffer and point and returns nil,
1067 or signals a `file-error'.
1069 If BOOKMARK-NAME-OR-RECORD has no file, this is a no-op. If
1070 BOOKMARK-NAME-OR-RECORD has a file, but that file no longer exists,
1071 then offer interactively to relocate BOOKMARK-NAME-OR-RECORD."
1077 ;; We were unable to find the marked file, so ask if user wants to
1078 ;; relocate the bookmark, else remind them to consider deletion.
1080 ;; `bookmark-name-or-record' can be either a bookmark name
1081 ;; (from `bookmark-alist') or a bookmark object. If it's an
1082 ;; object, we assume it's a bookmark used internally by some
1083 ;; other package.
1086 ;; If file is not a dir, directory-file-name just returns file.
1089 ;; Dialog boxes can accept a file target, but usually don't
1090 ;; know how to accept a directory target (at least, this
1091 ;; is true in Gnome on GNU/Linux, and Bug#4230 says it's
1092 ;; true on Windows as well). So we suppress file dialogs
1093 ;; when relocating.
1100 ;; Try again.
1105 "Bookmark not relocated; consider removing it (%s)."
1106 bookmark-name-or-record)
1108 ;; Added by db.
1111 nil)
1118 "Default handler to jump to a particular bookmark location.
1119 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
1120 Changes current buffer and point and returns nil, or signals a `file-error'."
1130 ;; No file found. See if buffer BUF have been created.
1135 ;; Go searching forward first. Then, if forward-str exists and
1136 ;; was found in the file, we can search backward for behind-str.
1137 ;; Rationale is that if text was inserted between the two in the
1138 ;; file, it's better to be put before it so you can read it,
1139 ;; rather than after and remain perhaps unaware of the changes.
1144 nil))
1146 ;;;###autoload
1148 "Relocate BOOKMARK-NAME to another file, reading file name with minibuffer.
1150 This makes an already existing bookmark point to that file, instead of
1151 the one it used to point at. Useful when a file has been renamed
1152 after a bookmark was set in it."
1170 ;;;###autoload
1172 "Insert the name of the file associated with BOOKMARK-NAME.
1174 Optional second arg NO-HISTORY means don't record this in the
1175 minibuffer history list `bookmark-history'."
1180 ;;;###autoload
1184 "Return a description of the location of BOOKMARK-NAME-OR-RECORD."
1186 ;; We could call the `handler' and ask for it to construct a description
1187 ;; dynamically: it would open up several new possibilities, but it
1188 ;; would have the major disadvantage of forcing to load each and
1189 ;; every handler when the user calls bookmark-menu.
1195 ;;;###autoload
1197 "Change the name of OLD-NAME bookmark to NEW-NAME name.
1198 If called from keyboard, prompt for OLD-NAME and NEW-NAME.
1199 If called from menubar, select OLD-NAME from a menu and prompt for NEW-NAME.
1201 If called from Lisp, prompt for NEW-NAME if only OLD-NAME was passed
1202 as an argument. If called with two strings, then no prompting is done.
1203 You must pass at least OLD-NAME when calling from Lisp.
1205 While you are entering the new name, consecutive C-w's insert
1206 consecutive words from the text of the buffer into the new bookmark
1207 name."
1217 "New name: "
1218 nil
1221 now-map)
1222 nil
1233 ;;;###autoload
1235 "Insert the text of the file pointed to by bookmark BOOKMARK-NAME.
1236 BOOKMARK-NAME is a bookmark name (a string), not a bookmark record.
1238 You may have a problem using this function if the value of variable
1239 `bookmark-alist' is nil. If that happens, you need to load in some
1240 bookmarks. See help on function `bookmark-load' for more about
1241 this."
1255 ;;;###autoload
1257 "Delete BOOKMARK-NAME from the bookmark list.
1259 Removes only the first instance of a bookmark with that name. If
1260 there are one or more other bookmarks with the same name, they will
1262 one most recently used in this file, if any).
1263 Optional second arg BATCH means don't update the bookmark list buffer,
1264 probably because we were called from there."
1267 bookmark-current-bookmark)))
1272 ;; Added by db, nil bookmark-current-bookmark if the last
1273 ;; occurrence has been deleted
1285 "Return t if it is time to save bookmarks to disk, nil otherwise.
1286 Optional argument FINAL-TIME means this is being called when Emacs
1287 is being killed, so save even if `bookmark-save-flag' is a number and
1288 is greater than `bookmark-alist-modification-count'."
1289 ;; By Gregory M. Saunders <saunders{_AT_}cis.ohio-state.edu>
1292 bookmark-save-flag))
1296 nil)))
1299 ;;;###autoload
1301 "Write bookmarks to a file (reading the file name with the minibuffer).
1302 Don't use this in Lisp programs; use `bookmark-save' instead."
1308 ;;;###autoload
1310 "Save currently defined bookmarks.
1311 Saves by default in the file defined by the variable
1312 `bookmark-default-file'. With a prefix arg, save it in file FILE
1313 \(second argument).
1315 If you are calling this from Lisp, the two arguments are PARG and
1316 FILE, and if you just want it to write to the default file, then
1317 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1318 instead. If you pass in one argument, and it is non-nil, then the
1319 user will be interactively queried for a file to save in.
1321 When you want to load in the bookmarks from a file, use
1323 for a file, defaulting to the file defined by variable
1324 `bookmark-default-file'."
1329 ;;whether interactive or not, write to default file
1332 ;;whether interactive or not, write to given file
1335 ;;have been called interactively w/ prefix arg
1340 ;; signal that we have synced the bookmark file by setting this to
1341 ;; 0. If there was an error at any point before, it will not get
1342 ;; set, which is what we want.
1346 \f
1348 "Write `bookmark-alist' to FILE."
1355 ;; See bug #12503 for why we bind `print-circle'. Users
1356 ;; can define their own bookmark types, which can result in
1357 ;; arbitrary Lisp objects being stored in bookmark records,
1358 ;; and some users create objects containing circularities.
1362 ;; Rather than a single call to `pp' we make one per bookmark.
1363 ;; Apparently `pp' has a poor algorithmic complexity, so this
1364 ;; scales a lot better. bug#4485.
1382 "Add NEW-LIST of bookmarks to `bookmark-alist'.
1384 they conflict with existing bookmark names."
1393 "Rename bookmark FULL-RECORD if its current name is already used.
1394 This is a helper for `bookmark-import-new-list'."
1397 ;; We've got a conflict, so generate a new name
1406 ;;;###autoload
1408 "Load bookmarks from FILE (which must be in bookmark format).
1409 Appends loaded bookmarks to the front of the list of bookmarks. If
1410 optional second argument OVERWRITE is non-nil, existing bookmarks are
1411 destroyed. Optional third arg NO-MSG means don't display any messages
1412 while loading.
1414 If you load a file that doesn't contain a proper bookmark alist, you
1415 will corrupt Emacs's bookmark list. Generally, you should only load
1416 in files that were created with the bookmark functions in the first
1417 place. Your own personal bookmark file, `~/.emacs.bmk', is
1418 maintained automatically by Emacs; you shouldn't need to load it
1419 explicitly.
1421 If you load a file containing bookmarks with the same names as
1422 bookmarks already present in your Emacs, the new bookmarks will get
1427 bookmark-default-file)
1428 ;;Default might not be used often,
1429 ;;but there's no better default, and
1430 ;;I guess it's better than none at all.
1448 ;; else
1455 file)
1464 \f
1465 ;;; Code supporting the dired-like bookmark menu.
1466 ;; Prefix is "bookmark-bmenu" for "buffer-menu":
1505 map))
1507 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1508 ;; data.
1512 ;; todo: need to display whether or not bookmark exists as a buffer in
1513 ;; flag column.
1515 ;; Format:
1516 ;; FLAGS BOOKMARK [ LOCATION ]
1520 "Rebuild the Bookmark List if it exists.
1521 Don't affect the buffer ring order."
1528 ;;;###autoload
1530 "Display a list of existing bookmarks.
1531 The list is displayed in a buffer named `*Bookmark List*'.
1532 The leftmost column displays a D if the bookmark is flagged for
1533 deletion, or > if it is flagged for displaying."
1550 end)
1551 ;; if a bookmark has an annotation, prepend a "*"
1552 ;; in the list of bookmarks.
1555 name)
1563 mouse-face highlight
1564 follow-link t
1576 ;;;###autoload
1578 ;;;###autoload
1582 "Sets the immutable header line."
1594 header)))
1597 header))
1598 ;; Code derived from `buff-menu.el'.
1602 "Major mode for editing a list of bookmarks.
1603 Each line describes one of the bookmarks in Emacs.
1604 Letters do not insert themselves; instead, they are commands.
1609 Also show bookmarks marked using m in other windows.
1610 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1614 together with bookmark selected before this one in another window.
1617 so the bookmark menu bookmark remains visible in its window.
1623 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1625 With a prefix arg, prompts for a file to save in.
1628 With prefix argument, also move up one line.
1630 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1631 in another buffer.
1632 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1639 "Toggle whether filenames are shown in the bookmark list.
1640 Optional argument SHOW means show them unconditionally."
1658 "In an interactive bookmark list, show filenames along with bookmarks.
1659 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1660 mainly for debugging, and should not be necessary in normal use."
1662 nil ;already shown, so do nothing
1676 ;; Strip off `mouse-face' from the white spaces region.
1682 ;; Pass the NO-HISTORY arg:
1688 "In an interactive bookmark list, hide the filenames of the bookmarks.
1689 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1690 mainly for debugging, and should not be necessary in normal use."
1692 ;; nothing to hide if above is nil
1712 mouse-face highlight
1713 follow-link t help-echo
1719 "If point is not on a bookmark line, move it to one.
1720 If before the first bookmark line, move to the first; if after the
1721 last full line, move to the last full line. The return value is undefined."
1724 bookmark-bmenu-inline-header-height))
1732 "Return the bookmark for this line in an interactive bookmark list buffer."
1741 "Display the annotation for BOOKMARK-NAME-OR-RECORD in a buffer,
1742 if an annotation exists."
1755 "Display the annotations for all bookmarks in a buffer."
1764 ;; insert the annotation, indented by 4 spaces.
1777 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1790 "Select this line's bookmark; also display bookmarks marked with `>'.
1796 tem)
1821 "Return non-nil if any bookmarks are marked in the marks column."
1831 nil)))
1835 "Save the current list into a bookmark file.
1836 With a prefix arg, prompts for a file to save them in."
1845 "Load the bookmark file and rebuild the bookmark menu-buffer."
1850 ;; This will call `bookmark-bmenu-list'
1855 "Select this line's bookmark, alone, in full frame."
1863 "Select this line's bookmark, with previous buffer in second window."
1875 "Select this line's bookmark in this window."
1881 "Select this line's bookmark in other window, leaving bookmark menu visible."
1888 "Make the other window select this line's bookmark.
1889 The current window remains selected."
1896 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1905 "Show the annotation for the current bookmark in another window."
1912 "Show the annotation for all bookmarks in another window."
1918 "Edit the annotation for the current bookmark in another window."
1925 "Cancel all requested operations on bookmark on this line and move down.
1926 Optional BACKUP means move up."
1933 ;; any flags to reset according to circumstances? How about a
1934 ;; flag indicating whether this bookmark is being visited?
1935 ;; well, we don't have this now, so maybe later.
1942 "Move up and cancel all requested operations on bookmark on line above."
1952 "Mark bookmark on this line to be deleted.
1953 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1966 "Mark bookmark on this line to be deleted, then move up one line.
1967 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1977 "Delete bookmarks flagged `D'."
2003 ))
2007 "Rename bookmark on current line. Prompts for a new name."
2016 "Display location of this bookmark. Displays in the minibuffer."
2022 "Change the file path of the bookmark on the current line,
2023 prompting with completion for the new path."
2030 ;;; Bookmark-bmenu search
2033 "Filter `bookmark-alist' with bookmarks matching REGEXP and rebuild list."
2037 finally return new)))
2041 ;;;###autoload
2043 "Incremental search of bookmarks, hiding the non-matches as we go."
2051 bookmark-search-delay 'repeat
2065 "Move point to bookmark with name NAME."
2072 \f
2073 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2076 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2077 That is, ENTRIES is a list of strings which appear as the choices
2078 in the menu.
2079 The number of panes depends on the number of entries.
2080 The visible entries are truncated to `bookmark-menu-length', but the
2081 strings returned are not."
2093 str)
2094 str)
2095 lst)
2102 pane-list)))
2104 ;; Popup the menu and return the string.
2109 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2110 ;; following works, and for explaining what to do to make it work.
2112 ;; We MUST autoload EACH form used to set up this variable's value, so
2113 ;; that the whole job is done in loaddefs.el.
2115 ;; Emacs menubar stuff.
2117 ;;;###autoload
2121 '(menu-item "Load a Bookmark File..." bookmark-load
2122 :help "Load bookmarks from a bookmark file)"))
2123 (bindings--define-key map [write]
2124 '(menu-item "Save Bookmarks As..." bookmark-write
2125 :help "Write bookmarks to a file (reading the file name with the minibuffer)"))
2126 (bindings--define-key map [save]
2127 '(menu-item "Save Bookmarks" bookmark-save
2128 :help "Save currently defined bookmarks"))
2129 (bindings--define-key map [edit]
2130 '(menu-item "Edit Bookmark List" bookmark-bmenu-list
2131 :help "Display a list of existing bookmarks"))
2132 (bindings--define-key map [delete]
2133 '(menu-item "Delete Bookmark..." bookmark-delete
2134 :help "Delete a bookmark from the bookmark list"))
2135 (bindings--define-key map [rename]
2136 '(menu-item "Rename Bookmark..." bookmark-rename
2137 :help "Change the name of a bookmark"))
2138 (bindings--define-key map [locate]
2139 '(menu-item "Insert Location..." bookmark-locate
2140 :help "Insert the name of the file associated with a bookmark"))
2141 (bindings--define-key map [insert]
2142 '(menu-item "Insert Contents..." bookmark-insert
2143 :help "Insert the text of the file pointed to by a bookmark"))
2144 (bindings--define-key map [set]
2145 '(menu-item "Set Bookmark..." bookmark-set
2146 :help "Set a bookmark named inside a file."))
2147 (bindings--define-key map [jump]
2148 '(menu-item "Jump to Bookmark..." bookmark-jump
2149 :help "Jump to a bookmark (a point in some file)"))
2150 map))
2152 ;;;###autoload
2153 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2155 ;; make bookmarks appear toward the right side of the menu.
2156 (if (boundp 'menu-bar-final-items)
2157 (if menu-bar-final-items
2158 (push 'bookmark menu-bar-final-items))
2159 (setq menu-bar-final-items '(bookmark)))
2161 ;;;; end bookmark menu stuff ;;;;
2163 \f
2164 ;; Load Hook
2165 (defvar bookmark-load-hook nil
2166 "Hook run at the end of loading library `bookmark.el'.")
2168 ;; Exit Hook, called from kill-emacs-hook
2169 (define-obsolete-variable-alias 'bookmark-exit-hooks
2170 'bookmark-exit-hook "22.1")
2171 (defvar bookmark-exit-hook nil
2172 "Hook run when Emacs exits.")
2174 (defun bookmark-exit-hook-internal ()
2175 "Save bookmark state, if necessary, at Emacs exit time.
2176 This also runs `bookmark-exit-hook'."
2177 (run-hooks 'bookmark-exit-hook)
2178 (and (bookmark-time-to-save-p t)
2179 (bookmark-save)))
2181 (unless noninteractive
2182 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal))
2184 (defun bookmark-unload-function ()
2185 "Unload the Bookmark library."
2186 (when bookmark-save-flag (bookmark-save))
2187 ;; continue standard unloading
2188 nil)
2191 (run-hooks 'bookmark-load-hook)
2193 (provide 'bookmark)
2195 ;;; bookmark.el ends here