| blob | c2f8cc3fbc19fdb794714eb302507b870a4bf513 |
1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later
3 ;; Copyright (C) 1993-1997, 2001-2016 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 "M" 'bookmark-set-no-overwrite)
200 ;;;###autoload (define-key ctl-x-r-map "l" 'bookmark-bmenu-list)
202 ;;;###autoload
205 ;; Read the help on all of these functions for details...
220 map)
221 "Keymap containing bindings to bookmark functions.
222 It is not bound to any key by default: to bind it
223 so that you have a bookmark prefix, just use `global-set-key' and bind a
224 key of your choice to `bookmark-map'. All interactive bookmark
227 ;;;###autoload (fset 'bookmark-map bookmark-map)
229 \f
230 ;;; Core variables and data structures:
232 "Association list of bookmarks and their records.
233 Bookmark functions update the value automatically.
234 You probably do NOT want to change the value yourself.
236 The value is an alist with entries of the form
238 (BOOKMARK-NAME . PARAM-ALIST)
240 or the deprecated form (BOOKMARK-NAME PARAM-ALIST).
242 BOOKMARK-NAME is the name you gave to the bookmark when creating it.
244 PARAM-ALIST is an alist of bookmark information. The order of the
245 entries in PARAM-ALIST is not important. The possible entries are
246 described below. An entry with a key but null value means the entry
247 is not used.
249 (filename . FILENAME)
250 (position . POS)
251 (front-context-string . STR-AFTER-POS)
252 (rear-context-string . STR-BEFORE-POS)
253 (handler . HANDLER)
254 (annotation . ANNOTATION)
256 FILENAME names the bookmarked file.
257 POS is the bookmarked buffer position (position in the file).
258 STR-AFTER-POS is buffer text that immediately follows POS.
259 STR-BEFORE-POS is buffer text that immediately precedes POS.
260 ANNOTATION is a string that describes the bookmark.
261 See options `bookmark-use-annotations' and
262 `bookmark-automatically-show-annotations'.
263 HANDLER is a function that provides the bookmark-jump behavior for a
264 specific kind of bookmark. This is the case for Info bookmarks,
271 ;; more stuff added by db.
274 "Name of bookmark most recently used in the current file.
275 It is buffer local, used to make moving a bookmark forward
290 "The buffer in which a bookmark is currently being set or renamed.
291 Functions that insert strings into the minibuffer use this to know
292 the source buffer for that information; see `bookmark-yank-word'
297 "The next point from which to pull source text for `bookmark-yank-word'.
303 \f
304 ;; Helper functions and macros.
307 "Run BODY while preserving the buffer's `buffer-modified-p' state."
314 ;; Only functions below, in this page and the next one (file formats),
315 ;; need to know anything about the format of bookmark-alist entries.
316 ;; Everyone else should go through them.
319 "Return the name of BOOKMARK-RECORD. BOOKMARK-RECORD is, e.g.,
320 one element from `bookmark-alist'."
325 "Return a list of all current bookmark names."
331 "Return the bookmark record corresponding to BOOKMARK-NAME-OR-RECORD.
332 If BOOKMARK-NAME-OR-RECORD is a string, look for the corresponding
333 bookmark record in `bookmark-alist'; return it if found, otherwise
334 error. Else if BOOKMARK-NAME-OR-RECORD is already a bookmark record,
335 just return it."
340 bookmark-completion-ignore-case)
342 bookmark-name-or-record))))))
346 "Return the record portion of the entry for BOOKMARK-NAME-OR-RECORD in
347 `bookmark-alist' (that is, all information but the name)."
349 ;; The bookmark objects can either look like (NAME ALIST) or
350 ;; (NAME . ALIST), so we have to distinguish the two here.
356 "Set BOOKMARK-NAME-OR-RECORD's name to NEWNAME."
360 "Return the property PROP of BOOKMARK-NAME-OR-RECORD, or nil if none."
364 "Set the property PROP of BOOKMARK-NAME-OR-RECORD to VAL."
373 "Return the annotation of BOOKMARK-NAME-OR-RECORD, or nil if none."
377 "Set the annotation of BOOKMARK-NAME-OR-RECORD to ANN."
382 "Return the full filename of BOOKMARK-NAME-OR-RECORD, or nil if none."
387 "Set the full filename of BOOKMARK-NAME-OR-RECORD to FILENAME."
392 "Return the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD, or nil if none."
397 "Set the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD to POSITION."
402 "Return the front-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
407 "Set the front-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
412 "Return the rear-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
417 "Set the rear-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
422 "Return the handler function for BOOKMARK-NAME-OR-RECORD, or nil if none."
430 "Prompting with PROMPT, read a bookmark name in completion.
432 probably don't want to include one yourself.
433 Optional arg DEFAULT is a string to return if the user input is empty.
434 If DEFAULT is nil then return empty string for empty input."
452 action bookmark-alist string pred)))
457 "Put STRING into the bookmark prompt history, if caller non-interactive.
458 We need this because sometimes bookmark functions are invoked from
459 menus, so `completing-read' never gets a chance to set `bookmark-history'."
465 "A function that should be called to create a bookmark record.
466 Modes may set this variable buffer-locally to enable bookmarking of
467 locations that should be treated specially, such as Info nodes,
468 news posts, images, pdf documents, etc.
470 The function will be called with no arguments.
471 It should signal a user error if it is unable to construct a record for
472 the current location.
474 The returned record should be a cons cell of the form (NAME . ALIST)
475 where ALIST is as described in `bookmark-alist' and may typically contain
476 a special cons (handler . HANDLER-FUNC) which specifies the handler function
477 that should be used instead of `bookmark-default-handler' to open this
478 bookmark. See the documentation for `bookmark-alist' for more.
480 NAME is a suggested name for the constructed bookmark. It can be nil
481 in which case a default heuristic will be used. The function can also
485 "Return a new bookmark record (NAME . ALIST) for the current location."
487 ;; Set up default name if the function does not provide one.
491 ;; Set up defaults.
493 record 'defaults
498 record))
501 "Store the bookmark NAME with data ALIST.
502 If NO-OVERWRITE is non-nil and another bookmark of the same name already
503 exists in `bookmark-alist', record the new bookmark without throwing away the
504 old one."
508 ;; XEmacs's `set-text-properties' doesn't work on
509 ;; free-standing strings, apparently.
513 ;; already existing bookmark under that name and
514 ;; no prefix arg means just overwrite old bookmark
515 ;; Use the new (NAME . ALIST) format.
518 ;; otherwise just cons it onto the front (either the bookmark
519 ;; doesn't exist already, or there is no prefix arg. In either
520 ;; case, we want the new bookmark consed onto the alist...)
524 ;; Added by db
535 "Return the record describing the location of a new bookmark.
536 Point should be at the buffer in which the bookmark is being set,
537 and normally should be at the position where the bookmark is desired,
538 but see the optional arguments for other possibilities.
540 If NO-FILE is non-nil, then only return the subset of the
541 record that pertains to the location within the buffer, leaving off
542 the part that records the filename.
544 If NO-CONTEXT is non-nil, do not include the front- and rear-context
545 strings in the record -- the position is enough.
547 If POSN is non-nil, record POSN as the point instead of `(point)'."
551 bookmark-search-size)
555 nil))))
558 bookmark-search-size)
562 nil))))
565 \f
566 ;;; File format stuff
568 ;; *IMPORTANT NOTICE* If you are thinking about modifying (redefining)
569 ;; the bookmark file format -- please don't. The current format
570 ;; should be extensible enough. If you feel the need to change it,
571 ;; please discuss it with other Emacs developers first.
572 ;;
573 ;; The format of `bookmark-alist' has changed twice in its lifetime.
574 ;; This comment describes the three formats, FIRST, SECOND, and
575 ;; CURRENT.
576 ;;
577 ;; The FIRST format was used prior to Emacs 20:
578 ;;
579 ;; ((BOOKMARK-NAME (FILENAME
580 ;; STRING-IN-FRONT
581 ;; STRING-BEHIND
582 ;; POINT))
583 ;; ...)
584 ;;
585 ;; The SECOND format was introduced in Emacs 20:
586 ;;
587 ;; ((BOOKMARK-NAME ((filename . FILENAME)
588 ;; (position . POS)
589 ;; (front-context-string . STR-AFTER-POS)
590 ;; (rear-context-string . STR-BEFORE-POS)
591 ;; (annotation . ANNOTATION)
592 ;; (whatever . VALUE)
593 ;; ...
594 ;; ))
595 ;; ...)
596 ;;
597 ;; The CURRENT format was introduced in Emacs 22:
598 ;;
599 ;; ((BOOKMARK-NAME (filename . FILENAME)
600 ;; (position . POS)
601 ;; (front-context-string . STR-AFTER-POS)
602 ;; (rear-context-string . STR-BEFORE-POS)
603 ;; (annotation . ANNOTATION)
604 ;; (whatever . VALUE)
605 ;; ...
606 ;; )
607 ;; ...)
608 ;;
609 ;; Both FIRST and SECOND have the same level of nesting: the cadr of a
610 ;; bookmark record is a list of entry information. FIRST and SECOND
611 ;; differ in the form of the record information: FIRST uses a list of
612 ;; atoms, and SECOND uses an alist. In the FIRST format, the order of
613 ;; the list elements matters. In the SECOND format, the order of the
614 ;; alist elements is unimportant. The SECOND format facilitates the
615 ;; addition of new kinds of elements, to support new kinds of
616 ;; bookmarks or code evolution.
617 ;;
618 ;; The CURRENT format removes a level of nesting wrt FIRST and SECOND,
619 ;; saving one cons cell per bookmark: the cadr of a bookmark record is
620 ;; no longer a cons. Why that change was made remains a mystery --
621 ;; just be aware of it. (Be aware too that this explanatory comment
622 ;; was incorrect in Emacs 22 and Emacs 23.1.)
623 ;;
624 ;; To deal with the change from FIRST format to SECOND, conversion
625 ;; code was added, and it is still in use. See
626 ;; `bookmark-maybe-upgrade-file-format'.
627 ;;
628 ;; No conversion from SECOND to CURRENT is done. Instead, the code
629 ;; handles both formats OK. It must continue to do so.
630 ;;
631 ;; See the doc string of `bookmark-alist' for information about the
632 ;; elements that define a bookmark (e.g. `filename').
636 "The current version of the format used by bookmark files.
646 "Return a `bookmark-alist' (in any format) from the current buffer.
647 The buffer must of course contain bookmark format information.
648 Does not care from where in the buffer it is called, and does not
649 affect point."
654 ;; Else we're dealing with format version 0
659 ;; Else no hope of getting information here.
664 "Upgrade a version 0 alist OLD-LIST to the current version."
675 name
681 old-list))
685 "Upgrade a bookmark file of format 0 (the original format) to format 1.
686 This expects to be called from `point-min' in a bookmark file."
688 bookmark-file-format-version)
697 bookmark-file-format-version)
698 )
702 "Return an integer which is the file-format version of this bookmark file.
703 This expects to be called from `point-min' in a bookmark file."
710 ;; Else this is format version 0, the original one, which didn't
711 ;; even have version stamps.
716 "Check the file-format version of this bookmark file.
717 If the version is not up-to-date, upgrade it automatically.
718 This expects to be called from `point-min' in a bookmark file."
730 "Insert text indicating current version of bookmark file format."
733 bookmark-file-format-version))
736 ";;; "
737 bookmark-end-of-version-stamp-marker))
740 ;;; end file-format stuff
742 \f
743 ;;; Generic helpers.
746 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
750 \f
751 ;;; Core code:
757 map))
760 "Interactively set a bookmark named NAME at the current location.
762 Begin the interactive prompt with PROMPT, followed by a space, a
763 generated default name in parentheses, a colon and a space.
765 If OVERWRITE-OR-PUSH is nil, then error if there is already a
766 bookmark named NAME; if `overwrite', then replace any existing
767 bookmark if there is one; if `push' then push the new bookmark
768 onto the bookmark alist. The `push' behavior means that among
769 bookmarks named NAME, this most recently set one becomes the one in
770 effect, but the others are still there, in order, if the topmost one
771 is ever deleted."
775 ;; `defaults' is a transient element of the
776 ;; extensible format described above in the section
777 ;; `File format stuff'. Bookmark record functions
778 ;; can use it to specify a list of default values
779 ;; accessible via M-n while reading a bookmark name.
784 ;; Don't store default values in the record.
786 ;; When no defaults in the record, use its first element.
790 ;; Don't set `bookmark-yank-point' and `bookmark-current-buffer'
791 ;; if they have been already set in another buffer. (e.g gnus-art).
793 bookmark-current-buffer)
801 nil
802 bookmark-minibuffer-read-name-map
803 nil nil defaults))))
817 overwrite-or-push)))
819 ;; Ask for an annotation buffer for this bookmark
826 ;;;###autoload
828 "Set a bookmark named NAME at the current location.
829 If NAME is nil, then prompt the user.
831 With a prefix arg (non-nil NO-OVERWRITE), do not overwrite any
832 existing bookmark that has the same name as NAME, but instead push the
833 new bookmark onto the bookmark alist. The most recently set bookmark
834 with name NAME is thus the one in effect at any given time, but the
835 others are still there, should the user decide to delete the most
836 recent one.
838 To yank words from the text of the buffer and use them as part of the
839 bookmark name, type C-w while setting a bookmark. Successive C-w's
840 yank successive words.
842 Typing C-u inserts (at the bookmark name prompt) the name of the last
843 bookmark used in the document where the new bookmark is being set;
844 this helps you use a single bookmark name to track progress through a
845 large document. If there is no prior bookmark for this document, then
846 C-u inserts an appropriate name based on the buffer or file.
849 it removes only the first instance of a bookmark with that name from
850 the list of bookmarks.)"
856 ;;;###autoload
858 "Set a bookmark named NAME at the current location.
859 If NAME is nil, then prompt the user.
861 If a bookmark named NAME already exists and prefix argument
862 PUSH-BOOKMARK is non-nil, then push the new bookmark onto the
863 bookmark alist. Pushing it means that among bookmarks named
864 NAME, this one becomes the one in effect, but the others are
865 still there, in order, and become effective again if the user
866 ever deletes the most recent one.
868 Otherwise, if a bookmark named NAME already exists but PUSH-BOOKMARK
869 is nil, raise an error.
871 To yank words from the text of the buffer and use them as part of the
872 bookmark name, type C-w while setting a bookmark. Successive C-w's
873 yank successive words.
875 Typing C-u inserts (at the bookmark name prompt) the name of the last
876 bookmark used in the document where the new bookmark is being set;
877 this helps you use a single bookmark name to track progress through a
878 large document. If there is no prior bookmark for this document, then
879 C-u inserts an appropriate name based on the buffer or file.
882 it removes only the first instance of a bookmark with that name from
883 the list of bookmarks.)"
889 "Kill from point to end of line.
890 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
891 Does not affect the kill ring."
898 ;; Defvars to avoid compilation warnings:
900 "Variable holding the name of the bookmark.
901 This is used in `bookmark-edit-annotation' to record the bookmark
906 "Return default annotation text for BOOKMARK-NAME.
907 The default annotation text is simply some text explaining how to use
908 annotations."
911 bookmark-name)
923 "Function to return default text to use for a bookmark annotation.
930 map)
940 text-mode "Edit Bookmark Annotation"
941 "Mode for editing the annotation of bookmarks.
948 "Use buffer contents as annotation for a bookmark.
949 Lines beginning with `#' are ignored."
958 ;; Take no chances with text properties.
969 "Pop up a buffer for editing bookmark BOOKMARK-NAME-OR-RECORD's annotation."
974 bookmark-name-or-record))
978 "Return the name of the current buffer in a form usable as a bookmark name.
979 If the buffer is associated with a file or directory, use that name."
981 ;; Or are we a file?
983 ;; Or are we a directory?
986 dired-directory
989 ;; Strip the trailing slash.
992 ;; Else return the current-buffer
994 ;; If all else fails, use the buffer's name.
1000 "Get the next word from buffer `bookmark-current-buffer' and append
1001 it to the name of the bookmark currently being set, advancing
1002 `bookmark-yank-point' by one word."
1014 "Return the current buffer's file in a way useful for bookmarks."
1015 ;; Abbreviate the path, both so it's shorter and so it's more
1016 ;; portable. E.g., the user's home dir might be a different
1017 ;; path on different machines, but "~/" will still reach it.
1023 dired-directory
1029 "If bookmarks have not been loaded from the default place, load them."
1034 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
1035 ;; to be renamed.
1039 bookmark-default-file))
1040 ;; return t so the `and' will continue...
1041 t)
1049 "Return `bookmark-alist' for display.
1050 If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist."
1055 bookmark-alist))
1059 "Hook run after `bookmark-jump' jumps to a bookmark.
1063 "Handle BOOKMARK-NAME-OR-RECORD, then call DISPLAY-FUNCTION with
1064 current buffer as argument.
1066 After calling DISPLAY-FUNCTION, set window point to the point specified
1067 by BOOKMARK-NAME-OR-RECORD, if necessary, run `bookmark-after-jump-hook',
1068 and then show any annotations for this bookmark."
1074 ;; FIXME: we used to only run bookmark-after-jump-hook in
1075 ;; `bookmark-jump' itself, but in none of the other commands.
1078 ;; if there is an annotation for this bookmark,
1079 ;; show it in a buffer.
1083 ;;;###autoload
1085 "Jump to bookmark BOOKMARK (a point in some file).
1086 You may have a problem using this function if the value of variable
1087 `bookmark-alist' is nil. If that happens, you need to load in some
1088 bookmarks. See help on function `bookmark-load' for more about
1089 this.
1091 If the file pointed to by BOOKMARK no longer exists, you will be asked
1092 if you wish to give the bookmark a new location, and `bookmark-jump'
1093 will then jump to the new location, as well as recording it in place
1094 of the old one in the permanent bookmark record.
1096 BOOKMARK is usually a bookmark name (a string). It can also be a
1097 bookmark record, but this is usually only done by programmatic callers.
1099 If DISPLAY-FUNC is non-nil, it is a function to invoke to display the
1100 bookmark. It defaults to `switch-to-buffer'. A typical value for
1101 DISPLAY-FUNC would be `switch-to-buffer-other-window'."
1104 bookmark-current-bookmark)))
1111 ;;;###autoload
1113 "Jump to BOOKMARK in another window. See `bookmark-jump' for more."
1116 bookmark-current-bookmark)))
1121 "Return the location pointed to by BOOKMARK (see `bookmark-jump').
1122 The return value has the form (BUFFER . POINT).
1124 Note: this function is deprecated and is present for Emacs 22
1125 compatibility only."
1132 "Call BOOKMARK-NAME-OR-RECORD's handler or `bookmark-default-handler'
1133 if it has none. This changes current buffer and point and returns nil,
1134 or signals a `file-error'.
1136 If BOOKMARK-NAME-OR-RECORD has no file, this is a no-op. If
1137 BOOKMARK-NAME-OR-RECORD has a file, but that file no longer exists,
1138 then offer interactively to relocate BOOKMARK-NAME-OR-RECORD."
1144 ;; We were unable to find the marked file, so ask if user wants to
1145 ;; relocate the bookmark, else remind them to consider deletion.
1147 ;; `bookmark-name-or-record' can be either a bookmark name
1148 ;; (from `bookmark-alist') or a bookmark object. If it's an
1149 ;; object, we assume it's a bookmark used internally by some
1150 ;; other package.
1153 ;; If file is not a dir, directory-file-name just returns file.
1156 ;; Dialog boxes can accept a file target, but usually don't
1157 ;; know how to accept a directory target (at least, this
1158 ;; is true in Gnome on GNU/Linux, and Bug#4230 says it's
1159 ;; true on Windows as well). So we suppress file dialogs
1160 ;; when relocating.
1167 ;; Try again.
1172 "Bookmark not relocated; consider removing it (%s)."
1173 bookmark-name-or-record)
1175 ;; Added by db.
1178 nil)
1185 "Default handler to jump to a particular bookmark location.
1186 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
1187 Changes current buffer and point and returns nil, or signals a `file-error'."
1197 ;; No file found. See if buffer BUF have been created.
1202 ;; Go searching forward first. Then, if forward-str exists and
1203 ;; was found in the file, we can search backward for behind-str.
1204 ;; Rationale is that if text was inserted between the two in the
1205 ;; file, it's better to be put before it so you can read it,
1206 ;; rather than after and remain perhaps unaware of the changes.
1211 nil))
1213 ;;;###autoload
1215 "Relocate BOOKMARK-NAME to another file, reading file name with minibuffer.
1217 This makes an already existing bookmark point to that file, instead of
1218 the one it used to point at. Useful when a file has been renamed
1219 after a bookmark was set in it."
1237 ;;;###autoload
1239 "Insert the name of the file associated with BOOKMARK-NAME.
1241 Optional second arg NO-HISTORY means don't record this in the
1242 minibuffer history list `bookmark-history'."
1247 ;;;###autoload
1251 "Return a description of the location of BOOKMARK-NAME-OR-RECORD."
1253 ;; We could call the `handler' and ask for it to construct a description
1254 ;; dynamically: it would open up several new possibilities, but it
1255 ;; would have the major disadvantage of forcing to load each and
1256 ;; every handler when the user calls bookmark-menu.
1262 ;;;###autoload
1264 "Change the name of OLD-NAME bookmark to NEW-NAME name.
1265 If called from keyboard, prompt for OLD-NAME and NEW-NAME.
1266 If called from menubar, select OLD-NAME from a menu and prompt for NEW-NAME.
1268 If called from Lisp, prompt for NEW-NAME if only OLD-NAME was passed
1269 as an argument. If called with two strings, then no prompting is done.
1270 You must pass at least OLD-NAME when calling from Lisp.
1272 While you are entering the new name, consecutive C-w's insert
1273 consecutive words from the text of the buffer into the new bookmark
1274 name."
1284 "New name: "
1285 nil
1288 now-map)
1289 nil
1300 ;;;###autoload
1302 "Insert the text of the file pointed to by bookmark BOOKMARK-NAME.
1303 BOOKMARK-NAME is a bookmark name (a string), not a bookmark record.
1305 You may have a problem using this function if the value of variable
1306 `bookmark-alist' is nil. If that happens, you need to load in some
1307 bookmarks. See help on function `bookmark-load' for more about
1308 this."
1322 ;;;###autoload
1324 "Delete BOOKMARK-NAME from the bookmark list.
1326 Removes only the first instance of a bookmark with that name. If
1327 there are one or more other bookmarks with the same name, they will
1329 one most recently used in this file, if any).
1330 Optional second arg BATCH means don't update the bookmark list buffer,
1331 probably because we were called from there."
1334 bookmark-current-bookmark)))
1339 ;; Added by db, nil bookmark-current-bookmark if the last
1340 ;; occurrence has been deleted
1352 "Return t if it is time to save bookmarks to disk, nil otherwise.
1353 Optional argument FINAL-TIME means this is being called when Emacs
1354 is being killed, so save even if `bookmark-save-flag' is a number and
1355 is greater than `bookmark-alist-modification-count'."
1356 ;; By Gregory M. Saunders <saunders{_AT_}cis.ohio-state.edu>
1359 bookmark-save-flag))
1363 nil)))
1366 ;;;###autoload
1368 "Write bookmarks to a file (reading the file name with the minibuffer)."
1375 ;;;###autoload
1377 "Save currently defined bookmarks.
1378 Saves by default in the file defined by the variable
1379 `bookmark-default-file'. With a prefix arg, save it in file FILE
1380 \(second argument).
1382 If you are calling this from Lisp, the two arguments are PARG and
1383 FILE, and if you just want it to write to the default file, then
1384 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1385 instead. If you pass in one argument, and it is non-nil, then the
1386 user will be interactively queried for a file to save in.
1388 When you want to load in the bookmarks from a file, use
1390 for a file, defaulting to the file defined by variable
1391 `bookmark-default-file'."
1396 ;;whether interactive or not, write to default file
1399 ;;whether interactive or not, write to given file
1402 ;;have been called interactively w/ prefix arg
1407 ;; signal that we have synced the bookmark file by setting this to
1408 ;; 0. If there was an error at any point before, it will not get
1409 ;; set, which is what we want.
1413 \f
1415 "Write `bookmark-alist' to FILE."
1422 ;; See bug #12503 for why we bind `print-circle'. Users
1423 ;; can define their own bookmark types, which can result in
1424 ;; arbitrary Lisp objects being stored in bookmark records,
1425 ;; and some users create objects containing circularities.
1429 ;; Rather than a single call to `pp' we make one per bookmark.
1430 ;; Apparently `pp' has a poor algorithmic complexity, so this
1431 ;; scales a lot better. bug#4485.
1449 "Add NEW-LIST of bookmarks to `bookmark-alist'.
1451 they conflict with existing bookmark names."
1460 "Rename bookmark FULL-RECORD if its current name is already used.
1461 This is a helper for `bookmark-import-new-list'."
1464 ;; We've got a conflict, so generate a new name
1473 ;;;###autoload
1475 "Load bookmarks from FILE (which must be in bookmark format).
1476 Appends loaded bookmarks to the front of the list of bookmarks. If
1477 optional second argument OVERWRITE is non-nil, existing bookmarks are
1478 destroyed. Optional third arg NO-MSG means don't display any messages
1479 while loading.
1481 If you load a file that doesn't contain a proper bookmark alist, you
1482 will corrupt Emacs's bookmark list. Generally, you should only load
1483 in files that were created with the bookmark functions in the first
1484 place. Your own personal bookmark file, `~/.emacs.bmk', is
1485 maintained automatically by Emacs; you shouldn't need to load it
1486 explicitly.
1488 If you load a file containing bookmarks with the same names as
1489 bookmarks already present in your Emacs, the new bookmarks will get
1494 bookmark-default-file)
1495 ;;Default might not be used often,
1496 ;;but there's no better default, and
1497 ;;I guess it's better than none at all.
1515 ;; else
1522 file)
1531 \f
1532 ;;; Code supporting the dired-like bookmark menu.
1533 ;; Prefix is "bookmark-bmenu" for "buffer-menu":
1572 map))
1574 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1575 ;; data.
1579 ;; todo: need to display whether or not bookmark exists as a buffer in
1580 ;; flag column.
1582 ;; Format:
1583 ;; FLAGS BOOKMARK [ LOCATION ]
1587 "Rebuild the Bookmark List if it exists.
1588 Don't affect the buffer ring order."
1595 ;;;###autoload
1597 "Display a list of existing bookmarks.
1598 The list is displayed in a buffer named `*Bookmark List*'.
1599 The leftmost column displays a D if the bookmark is flagged for
1600 deletion, or > if it is flagged for displaying."
1617 end)
1618 ;; if a bookmark has an annotation, prepend a "*"
1619 ;; in the list of bookmarks.
1622 name)
1630 mouse-face highlight
1631 follow-link t
1643 ;;;###autoload
1645 ;;;###autoload
1649 "Sets the immutable header line."
1661 header)))
1664 header))
1665 ;; Code derived from `buff-menu.el'.
1669 "Major mode for editing a list of bookmarks.
1670 Each line describes one of the bookmarks in Emacs.
1671 Letters do not insert themselves; instead, they are commands.
1676 Also show bookmarks marked using m in other windows.
1677 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1681 together with bookmark selected before this one in another window.
1684 so the bookmark menu bookmark remains visible in its window.
1690 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1692 With a prefix arg, prompts for a file to save in.
1695 With prefix argument, also move up one line.
1697 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1698 in another buffer.
1699 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1706 "Toggle whether filenames are shown in the bookmark list.
1707 Optional argument SHOW means show them unconditionally."
1725 "In an interactive bookmark list, show filenames along with bookmarks.
1726 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1727 mainly for debugging, and should not be necessary in normal use."
1729 nil ;already shown, so do nothing
1743 ;; Strip off `mouse-face' from the white spaces region.
1749 ;; Pass the NO-HISTORY arg:
1755 "In an interactive bookmark list, hide the filenames of the bookmarks.
1756 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1757 mainly for debugging, and should not be necessary in normal use."
1759 ;; nothing to hide if above is nil
1779 mouse-face highlight
1780 follow-link t help-echo
1786 "If point is not on a bookmark line, move it to one.
1787 If before the first bookmark line, move to the first; if after the
1788 last full line, move to the last full line. The return value is undefined."
1791 bookmark-bmenu-inline-header-height))
1799 "Return the bookmark for this line in an interactive bookmark list buffer."
1808 "Display the annotation for BOOKMARK-NAME-OR-RECORD in a buffer,
1809 if an annotation exists."
1822 "Display the annotations for all bookmarks in a buffer."
1831 ;; insert the annotation, indented by 4 spaces.
1844 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1857 "Select this line's bookmark; also display bookmarks marked with `>'.
1863 tem)
1888 "Return non-nil if any bookmarks are marked in the marks column."
1898 nil)))
1902 "Save the current list into a bookmark file.
1903 With a prefix arg, prompts for a file to save them in."
1912 "Load the bookmark file and rebuild the bookmark menu-buffer."
1917 ;; This will call `bookmark-bmenu-list'
1922 "Select this line's bookmark, alone, in full frame."
1930 "Select this line's bookmark, with previous buffer in second window."
1942 "Select this line's bookmark in this window."
1948 "Select this line's bookmark in other window, leaving bookmark menu visible."
1955 "Make the other window select this line's bookmark.
1956 The current window remains selected."
1963 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1972 "Show the annotation for the current bookmark in another window."
1979 "Show the annotation for all bookmarks in another window."
1985 "Edit the annotation for the current bookmark in another window."
1992 "Cancel all requested operations on bookmark on this line and move down.
1993 Optional BACKUP means move up."
2000 ;; any flags to reset according to circumstances? How about a
2001 ;; flag indicating whether this bookmark is being visited?
2002 ;; well, we don't have this now, so maybe later.
2009 "Move up and cancel all requested operations on bookmark on line above."
2019 "Mark bookmark on this line to be deleted.
2020 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2033 "Mark bookmark on this line to be deleted, then move up one line.
2034 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2044 "Delete bookmarks flagged `D'."
2070 ))
2074 "Rename bookmark on current line. Prompts for a new name."
2083 "Display location of this bookmark. Displays in the minibuffer."
2089 "Change the file path of the bookmark on the current line,
2090 prompting with completion for the new path."
2097 ;;; Bookmark-bmenu search
2100 "Filter `bookmark-alist' with bookmarks matching REGEXP and rebuild list."
2104 finally return new)))
2108 ;;;###autoload
2110 "Incremental search of bookmarks, hiding the non-matches as we go."
2118 bookmark-search-delay 'repeat
2132 "Move point to bookmark with name NAME."
2140 \f
2141 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2144 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2145 That is, ENTRIES is a list of strings which appear as the choices
2146 in the menu.
2147 The number of panes depends on the number of entries.
2148 The visible entries are truncated to `bookmark-menu-length', but the
2149 strings returned are not."
2161 str)
2162 str)
2163 lst)
2170 pane-list)))
2172 ;; Popup the menu and return the string.
2177 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2178 ;; following works, and for explaining what to do to make it work.
2180 ;; We MUST autoload EACH form used to set up this variable's value, so
2181 ;; that the whole job is done in loaddefs.el.
2183 ;; Emacs menubar stuff.
2185 ;;;###autoload
2189 '(menu-item "Load a Bookmark File..." bookmark-load
2190 :help "Load bookmarks from a bookmark file)"))
2191 (bindings--define-key map [write]
2192 '(menu-item "Save Bookmarks As..." bookmark-write
2193 :help "Write bookmarks to a file (reading the file name with the minibuffer)"))
2194 (bindings--define-key map [save]
2195 '(menu-item "Save Bookmarks" bookmark-save
2196 :help "Save currently defined bookmarks"))
2197 (bindings--define-key map [edit]
2198 '(menu-item "Edit Bookmark List" bookmark-bmenu-list
2199 :help "Display a list of existing bookmarks"))
2200 (bindings--define-key map [delete]
2201 '(menu-item "Delete Bookmark..." bookmark-delete
2202 :help "Delete a bookmark from the bookmark list"))
2203 (bindings--define-key map [rename]
2204 '(menu-item "Rename Bookmark..." bookmark-rename
2205 :help "Change the name of a bookmark"))
2206 (bindings--define-key map [locate]
2207 '(menu-item "Insert Location..." bookmark-locate
2208 :help "Insert the name of the file associated with a bookmark"))
2209 (bindings--define-key map [insert]
2210 '(menu-item "Insert Contents..." bookmark-insert
2211 :help "Insert the text of the file pointed to by a bookmark"))
2212 (bindings--define-key map [set]
2213 '(menu-item "Set Bookmark..." bookmark-set
2214 :help "Set a bookmark named inside a file."))
2215 (bindings--define-key map [jump]
2216 '(menu-item "Jump to Bookmark..." bookmark-jump
2217 :help "Jump to a bookmark (a point in some file)"))
2218 map))
2220 ;;;###autoload
2221 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2223 ;; make bookmarks appear toward the right side of the menu.
2224 (if (boundp 'menu-bar-final-items)
2225 (if menu-bar-final-items
2226 (push 'bookmark menu-bar-final-items))
2227 (setq menu-bar-final-items '(bookmark)))
2229 ;;;; end bookmark menu stuff ;;;;
2231 \f
2232 ;; Load Hook
2233 (defvar bookmark-load-hook nil
2234 "Hook run at the end of loading library `bookmark.el'.")
2236 ;; Exit Hook, called from kill-emacs-hook
2237 (define-obsolete-variable-alias 'bookmark-exit-hooks
2238 'bookmark-exit-hook "22.1")
2239 (defvar bookmark-exit-hook nil
2240 "Hook run when Emacs exits.")
2242 (defun bookmark-exit-hook-internal ()
2243 "Save bookmark state, if necessary, at Emacs exit time.
2244 This also runs `bookmark-exit-hook'."
2245 (run-hooks 'bookmark-exit-hook)
2246 (and (bookmark-time-to-save-p t)
2247 (bookmark-save)))
2249 (unless noninteractive
2250 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal))
2252 (defun bookmark-unload-function ()
2253 "Unload the Bookmark library."
2254 (when bookmark-save-flag (bookmark-save))
2255 ;; continue standard unloading
2256 nil)
2259 (run-hooks 'bookmark-load-hook)
2261 (provide 'bookmark)
2263 ;;; bookmark.el ends here