| blob | f7266dc225049e8877add0d560f70c16b92783c5 |
1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later
3 ;; Copyright (C) 1993-1997, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Karl Fogel <kfogel@red-bean.com>
6 ;; Maintainer: Karl Fogel <kfogel@red-bean.com>
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', and `nospecial'.
103 The first three have the same meaning that they do for the
104 variable `version-control', and the final value `nospecial' means just
105 use the value of `version-control'."
112 "Non-nil means bookmark functions ignore case in completion."
118 "Non-nil means that bookmarks will be displayed sorted by bookmark name.
119 Otherwise they will be displayed in LIFO order (that is, most
120 recently set ones come first, oldest ones come last)."
126 "Non-nil means show annotations when jumping to a bookmark."
135 "Number of columns (chars) used for the *Bookmark List* marks column,
139 "Column at which to display filenames in a buffer listing bookmarks.
140 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
146 "Non-nil means show filenames when listing bookmarks.
147 This may result in truncated bookmark names. To disable this, put the
148 following in your `.emacs' file:
150 \(setq bookmark-bmenu-toggle-filenames nil)"
156 "Maximum length of a bookmark name displayed on a popup menu."
160 ;; FIXME: Is it really worth a customization option?
162 "Time before `bookmark-bmenu-search' updates the display."
168 "Face used to highlight the heading in bookmark menu buffers."
173 ;;; No user-serviceable parts beyond this point.
175 ;; Added for lucid emacs compatibility, db
178 ;; suggested for lucid compatibility by david hughes:
181 \f
182 ;;; Keymap stuff:
184 ;; Set up these bindings dumping time *only*;
185 ;; if the user alters them, don't override the user when loading bookmark.el.
187 ;;;###autoload (define-key ctl-x-r-map "b" 'bookmark-jump)
188 ;;;###autoload (define-key ctl-x-r-map "m" 'bookmark-set)
189 ;;;###autoload (define-key ctl-x-r-map "l" 'bookmark-bmenu-list)
191 ;;;###autoload
194 ;; Read the help on all of these functions for details...
208 map)
209 "Keymap containing bindings to bookmark functions.
210 It is not bound to any key by default: to bind it
211 so that you have a bookmark prefix, just use `global-set-key' and bind a
212 key of your choice to `bookmark-map'. All interactive bookmark
215 ;;;###autoload (fset 'bookmark-map bookmark-map)
217 \f
218 ;;; Core variables and data structures:
220 "Association list of bookmarks and their records.
221 Bookmark functions update the value automatically.
222 You probably do NOT want to change the value yourself.
224 The value is an alist with entries of the form
226 (BOOKMARK-NAME . PARAM-ALIST)
228 or the deprecated form (BOOKMARK-NAME PARAM-ALIST).
230 BOOKMARK-NAME is the name you gave to the bookmark when creating it.
232 PARAM-ALIST is an alist of bookmark information. The order of the
233 entries in PARAM-ALIST is not important. The possible entries are
234 described below. An entry with a key but null value means the entry
235 is not used.
237 (filename . FILENAME)
238 (position . POS)
239 (front-context-string . STR-AFTER-POS)
240 (rear-context-string . STR-BEFORE-POS)
241 (handler . HANDLER)
242 (annotation . ANNOTATION)
244 FILENAME names the bookmarked file.
245 POS is the bookmarked buffer position (position in the file).
246 STR-AFTER-POS is buffer text that immediately follows POS.
247 STR-BEFORE-POS is buffer text that immediately precedes POS.
248 ANNOTATION is a string that describes the bookmark.
249 See options `bookmark-use-annotations' and
250 `bookmark-automatically-show-annotations'.
251 HANDLER is a function that provides the bookmark-jump behavior for a
252 specific kind of bookmark. This is the case for Info bookmarks,
259 ;; more stuff added by db.
262 "Name of bookmark most recently used in the current file.
263 It is buffer local, used to make moving a bookmark forward
278 "The buffer in which a bookmark is currently being set or renamed.
279 Functions that insert strings into the minibuffer use this to know
280 the source buffer for that information; see `bookmark-yank-word' and
285 "The next point from which to pull source text for `bookmark-yank-word'.
291 \f
292 ;; Helper functions and macros.
295 "Run BODY while preserving the buffer's `buffer-modified-p' state."
302 ;; Only functions below, in this page and the next one (file formats),
303 ;; need to know anything about the format of bookmark-alist entries.
304 ;; Everyone else should go through them.
307 "Return the name of BOOKMARK-RECORD. BOOKMARK-RECORD is, e.g.,
308 one element from `bookmark-alist'."
313 "Return a list of all current bookmark names."
319 "Return the bookmark record corresponding to BOOKMARK-NAME-OR-RECORD.
320 If BOOKMARK-NAME-OR-RECORD is a string, look for the corresponding
321 bookmark record in `bookmark-alist'; return it if found, otherwise
322 error. Else if BOOKMARK-NAME-OR-RECORD is already a bookmark record,
323 just return it."
328 bookmark-completion-ignore-case)
330 bookmark-name-or-record))))))
334 "Return the record portion of the entry for BOOKMARK-NAME-OR-RECORD in
335 `bookmark-alist' (that is, all information but the name)."
337 ;; The bookmark objects can either look like (NAME ALIST) or
338 ;; (NAME . ALIST), so we have to distinguish the two here.
344 "Set BOOKMARK-NAME-OR-RECORD's name to NEWNAME."
348 "Return the property PROP of BOOKMARK-NAME-OR-RECORD, or nil if none."
352 "Set the property PROP of BOOKMARK-NAME-OR-RECORD to VAL."
361 "Return the annotation of BOOKMARK-NAME-OR-RECORD, or nil if none."
365 "Set the annotation of BOOKMARK-NAME-OR-RECORD to ANN."
370 "Return the full filename of BOOKMARK-NAME-OR-RECORD, or nil if none."
375 "Set the full filename of BOOKMARK-NAME-OR-RECORD to FILENAME."
380 "Return the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD, or nil if none."
385 "Set the position (i.e.: point) of BOOKMARK-NAME-OR-RECORD to POSITION."
390 "Return the front-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
395 "Set the front-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
400 "Return the rear-context-string of BOOKMARK-NAME-OR-RECORD, or nil if none."
405 "Set the rear-context-string of BOOKMARK-NAME-OR-RECORD to STRING."
410 "Return the handler function for BOOKMARK-NAME-OR-RECORD, or nil if none."
418 "Prompting with PROMPT, read a bookmark name in completion.
420 probably don't want to include one yourself.
421 Optional second arg DEFAULT is a string to return if the user enters
422 the empty string."
437 bookmark-alist
438 nil
439 0
440 nil
446 "Put STRING into the bookmark prompt history, if caller non-interactive.
447 We need this because sometimes bookmark functions are invoked from
448 menus, so `completing-read' never gets a chance to set `bookmark-history'."
454 "A function that should be called to create a bookmark record.
455 Modes may set this variable buffer-locally to enable bookmarking of
456 locations that should be treated specially, such as Info nodes,
457 news posts, images, pdf documents, etc.
459 The function will be called with no arguments.
460 It should signal a user error if it is unable to construct a record for
461 the current location.
463 The returned record should be a cons cell of the form (NAME . ALIST)
464 where ALIST is as described in `bookmark-alist' and may typically contain
465 a special cons (handler . HANDLER-FUNC) which specifies the handler function
466 that should be used instead of `bookmark-default-handler' to open this
467 bookmark. See the documentation for `bookmark-alist' for more.
469 NAME is a suggested name for the constructed bookmark. It can be nil
470 in which case a default heuristic will be used. The function can also
474 "Return a new bookmark record (NAME . ALIST) for the current location."
476 ;; Set up default name.
478 ;; The function already provided a default name.
479 record
482 record)))
485 "Store the bookmark NAME with data ALIST.
486 If NO-OVERWRITE is non-nil and another bookmark of the same name already
487 exists in `bookmark-alist', record the new bookmark without throwing away the
488 old one."
492 ;; XEmacs's `set-text-properties' doesn't work on
493 ;; free-standing strings, apparently.
497 ;; already existing bookmark under that name and
498 ;; no prefix arg means just overwrite old bookmark
499 ;; Use the new (NAME . ALIST) format.
502 ;; otherwise just cons it onto the front (either the bookmark
503 ;; doesn't exist already, or there is no prefix arg. In either
504 ;; case, we want the new bookmark consed onto the alist...)
508 ;; Added by db
519 "Return the record describing the location of a new bookmark.
520 Point should be at the buffer in which the bookmark is being set,
521 and normally should be at the position where the bookmark is desired,
522 but see the optional arguments for other possibilities.
524 If NO-FILE is non-nil, then only return the subset of the
525 record that pertains to the location within the buffer, leaving off
526 the part that records the filename.
528 If NO-CONTEXT is non-nil, do not include the front- and rear-context
529 strings in the record -- the position is enough.
531 If POSN is non-nil, record POSN as the point instead of `(point)'."
535 bookmark-search-size)
539 nil))))
542 bookmark-search-size)
546 nil))))
549 \f
550 ;;; File format stuff
552 ;; *IMPORTANT NOTICE* If you are thinking about modifying (redefining)
553 ;; the bookmark file format -- please don't. The current format
554 ;; should be extensible enough. If you feel the need to change it,
555 ;; please discuss it with other Emacs developers first.
556 ;;
557 ;; The format of `bookmark-alist' has changed twice in its lifetime.
558 ;; This comment describes the three formats, FIRST, SECOND, and
559 ;; CURRENT.
560 ;;
561 ;; The FIRST format was used prior to Emacs 20:
562 ;;
563 ;; ((BOOKMARK-NAME (FILENAME
564 ;; STRING-IN-FRONT
565 ;; STRING-BEHIND
566 ;; POINT))
567 ;; ...)
568 ;;
569 ;; The SECOND format was introduced in Emacs 20:
570 ;;
571 ;; ((BOOKMARK-NAME ((filename . FILENAME)
572 ;; (position . POS)
573 ;; (front-context-string . STR-AFTER-POS)
574 ;; (rear-context-string . STR-BEFORE-POS)
575 ;; (annotation . ANNOTATION)
576 ;; (whatever . VALUE)
577 ;; ...
578 ;; ))
579 ;; ...)
580 ;;
581 ;; The CURRENT format was introduced in Emacs 22:
582 ;;
583 ;; ((BOOKMARK-NAME (filename . FILENAME)
584 ;; (position . POS)
585 ;; (front-context-string . STR-AFTER-POS)
586 ;; (rear-context-string . STR-BEFORE-POS)
587 ;; (annotation . ANNOTATION)
588 ;; (whatever . VALUE)
589 ;; ...
590 ;; )
591 ;; ...)
592 ;;
593 ;; Both FIRST and SECOND have the same level of nesting: the cadr of a
594 ;; bookmark record is a list of entry information. FIRST and SECOND
595 ;; differ in the form of the record information: FIRST uses a list of
596 ;; atoms, and SECOND uses an alist. In the FIRST format, the order of
597 ;; the list elements matters. In the SECOND format, the order of the
598 ;; alist elements is unimportant. The SECOND format facilitates the
599 ;; addition of new kinds of elements, to support new kinds of
600 ;; bookmarks or code evolution.
601 ;;
602 ;; The CURRENT format removes a level of nesting wrt FIRST and SECOND,
603 ;; saving one cons cell per bookmark: the cadr of a bookmark record is
604 ;; no longer a cons. Why that change was made remains a mystery --
605 ;; just be aware of it. (Be aware too that this explanatory comment
606 ;; was incorrect in Emacs 22 and Emacs 23.1.)
607 ;;
608 ;; To deal with the change from FIRST format to SECOND, conversion
609 ;; code was added, and it is still in use. See
610 ;; `bookmark-maybe-upgrade-file-format'.
611 ;;
612 ;; No conversion from SECOND to CURRENT is done. Instead, the code
613 ;; handles both formats OK. It must continue to do so.
614 ;;
615 ;; See the doc string of `bookmark-alist' for information about the
616 ;; elements that define a bookmark (e.g. `filename').
620 "The current version of the format used by bookmark files.
630 "Return a `bookmark-alist' (in any format) from the current buffer.
631 The buffer must of course contain bookmark format information.
632 Does not care from where in the buffer it is called, and does not
633 affect point."
638 ;; Else we're dealing with format version 0
643 ;; Else no hope of getting information here.
648 "Upgrade a version 0 alist OLD-LIST to the current version."
659 name
665 old-list))
669 "Upgrade a bookmark file of format 0 (the original format) to format 1.
670 This expects to be called from `point-min' in a bookmark file."
672 bookmark-file-format-version)
681 bookmark-file-format-version)
682 )
686 "Return an integer which is the file-format version of this bookmark file.
687 This expects to be called from `point-min' in a bookmark file."
694 ;; Else this is format version 0, the original one, which didn't
695 ;; even have version stamps.
700 "Check the file-format version of this bookmark file.
701 If the version is not up-to-date, upgrade it automatically.
702 This expects to be called from `point-min' in a bookmark file."
714 "Insert text indicating current version of bookmark file format."
717 bookmark-file-format-version))
720 ";;; "
721 bookmark-end-of-version-stamp-marker))
724 ;;; end file-format stuff
726 \f
727 ;;; Generic helpers.
730 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
734 \f
735 ;;; Core code:
741 ;; This C-u binding might not be very useful any more now that we
742 ;; provide access to the default via the standard M-n binding.
743 ;; Maybe we should just remove it? --Stef-08
745 map))
747 ;;;###autoload
749 "Set a bookmark named NAME at the current location.
750 If name is nil, then prompt the user.
752 With a prefix arg (non-nil NO-OVERWRITE), do not overwrite any
753 existing bookmark that has the same name as NAME, but instead push the
754 new bookmark onto the bookmark alist. The most recently set bookmark
755 with name NAME is thus the one in effect at any given time, but the
756 others are still there, should the user decide to delete the most
757 recent one.
759 To yank words from the text of the buffer and use them as part of the
760 bookmark name, type C-w while setting a bookmark. Successive C-w's
761 yank successive words.
763 Typing C-u inserts (at the bookmark name prompt) the name of the last
764 bookmark used in the document where the new bookmark is being set;
765 this helps you use a single bookmark name to track progress through a
766 large document. If there is no prior bookmark for this document, then
767 C-u inserts an appropriate name based on the buffer or file.
770 it removes only the first instance of a bookmark with that name from
771 the list of bookmarks.)"
778 ;; Don't set `bookmark-yank-point' and `bookmark-current-buffer'
779 ;; if they have been already set in another buffer. (e.g gnus-art).
781 bookmark-current-buffer)
789 nil
790 bookmark-minibuffer-read-name-map
791 nil nil default))))
795 ;; Ask for an annotation buffer for this bookmark
803 "Kill from point to end of line.
804 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
805 Does not affect the kill ring."
812 ;; Defvars to avoid compilation warnings:
814 "Variable holding the name of the bookmark.
815 This is used in `bookmark-edit-annotation' to record the bookmark
820 "Return default annotation text for BOOKMARK-NAME.
821 The default annotation text is simply some text explaining how to use
822 annotations."
834 "Function to return default text to use for a bookmark annotation.
841 map)
846 "Mode for editing the annotation of bookmark BOOKMARK-NAME-OR-RECORD.
865 "Use buffer contents as annotation for a bookmark.
866 Lines beginning with `#' are ignored."
875 ;; Take no chances with text properties.
886 "Pop up a buffer for editing bookmark BOOKMARK-NAME-OR-RECORD's annotation."
892 "Insert into the bookmark name currently being set the value of
893 `bookmark-current-bookmark' in `bookmark-current-buffer', defaulting
894 to the buffer's file name if `bookmark-current-bookmark' is nil."
904 "Return the name of the current buffer in a form usable as a bookmark name.
905 If the buffer is associated with a file or directory, use that name."
907 ;; Or are we a file?
909 ;; Or are we a directory?
912 dired-directory
915 ;; Strip the trailing slash.
918 ;; Else return the current-buffer
920 ;; If all else fails, use the buffer's name.
926 "Get the next word from buffer `bookmark-current-buffer' and append
927 it to the name of the bookmark currently being set, advancing
928 `bookmark-yank-point' by one word."
940 "Return the current buffer's file in a way useful for bookmarks."
941 ;; Abbreviate the path, both so it's shorter and so it's more
942 ;; portable. E.g., the user's home dir might be a different
943 ;; path on different machines, but "~/" will still reach it.
949 dired-directory
955 "If bookmarks have not been loaded from the default place, load them."
960 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
961 ;; to be renamed.
965 bookmark-default-file))
966 ;; return t so the `and' will continue...
967 t)
975 "Return `bookmark-alist' for display.
976 If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist."
981 bookmark-alist))
985 "Hook run after `bookmark-jump' jumps to a bookmark.
989 "Handle BOOKMARK-NAME-OR-RECORD, then call DISPLAY-FUNCTION with
990 current buffer as argument.
992 After calling DISPLAY-FUNCTION, set window point to the point specified
993 by BOOKMARK-NAME-OR-RECORD, if necessary, run `bookmark-after-jump-hook',
994 and then show any annotations for this bookmark."
1000 ;; FIXME: we used to only run bookmark-after-jump-hook in
1001 ;; `bookmark-jump' itself, but in none of the other commands.
1004 ;; if there is an annotation for this bookmark,
1005 ;; show it in a buffer.
1009 ;;;###autoload
1011 "Jump to bookmark BOOKMARK (a point in some file).
1012 You may have a problem using this function if the value of variable
1013 `bookmark-alist' is nil. If that happens, you need to load in some
1014 bookmarks. See help on function `bookmark-load' for more about
1015 this.
1017 If the file pointed to by BOOKMARK no longer exists, you will be asked
1018 if you wish to give the bookmark a new location, and `bookmark-jump'
1019 will then jump to the new location, as well as recording it in place
1020 of the old one in the permanent bookmark record.
1022 BOOKMARK is usually a bookmark name (a string). It can also be a
1023 bookmark record, but this is usually only done by programmatic callers.
1025 If DISPLAY-FUNC is non-nil, it is a function to invoke to display the
1026 bookmark. It defaults to `switch-to-buffer'. A typical value for
1027 DISPLAY-FUNC would be `switch-to-buffer-other-window'."
1030 bookmark-current-bookmark)))
1037 ;;;###autoload
1039 "Jump to BOOKMARK in another window. See `bookmark-jump' for more."
1042 bookmark-current-bookmark)))
1047 "Return the location pointed to by BOOKMARK (see `bookmark-jump').
1048 The return value has the form (BUFFER . POINT).
1050 Note: this function is deprecated and is present for Emacs 22
1051 compatibility only."
1059 "Call BOOKMARK-NAME-OR-RECORD's handler or `bookmark-default-handler'
1060 if it has none. This changes current buffer and point and returns nil,
1061 or signals a `file-error'.
1063 If BOOKMARK-NAME-OR-RECORD has no file, this is a no-op. If
1064 BOOKMARK-NAME-OR-RECORD has a file, but that file no longer exists,
1065 then offer interactively to relocate BOOKMARK-NAME-OR-RECORD."
1071 ;; We were unable to find the marked file, so ask if user wants to
1072 ;; relocate the bookmark, else remind them to consider deletion.
1074 ;; `bookmark-name-or-record' can be either a bookmark name
1075 ;; (from `bookmark-alist') or a bookmark object. If it's an
1076 ;; object, we assume it's a bookmark used internally by some
1077 ;; other package.
1080 ;; If file is not a dir, directory-file-name just returns file.
1083 ;; Dialog boxes can accept a file target, but usually don't
1084 ;; know how to accept a directory target (at least, this
1085 ;; is true in Gnome on GNU/Linux, and Bug#4230 says it's
1086 ;; true on Windows as well). So we suppress file dialogs
1087 ;; when relocating.
1094 ;; Try again.
1099 "Bookmark not relocated; consider removing it (%s)."
1100 bookmark-name-or-record)
1102 ;; Added by db.
1105 nil)
1108 'error-conditions
1111 'error-message
1115 "Default handler to jump to a particular bookmark location.
1116 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
1117 Changes current buffer and point and returns nil, or signals a `file-error'."
1127 ;; No file found. See if buffer BUF have been created.
1132 ;; Go searching forward first. Then, if forward-str exists and
1133 ;; was found in the file, we can search backward for behind-str.
1134 ;; Rationale is that if text was inserted between the two in the
1135 ;; file, it's better to be put before it so you can read it,
1136 ;; rather than after and remain perhaps unaware of the changes.
1141 nil))
1143 ;;;###autoload
1145 "Relocate BOOKMARK-NAME to another file, reading file name with minibuffer.
1147 This makes an already existing bookmark point to that file, instead of
1148 the one it used to point at. Useful when a file has been renamed
1149 after a bookmark was set in it."
1167 ;;;###autoload
1169 "Insert the name of the file associated with BOOKMARK-NAME.
1171 Optional second arg NO-HISTORY means don't record this in the
1172 minibuffer history list `bookmark-history'."
1180 start
1185 follow-link t
1188 ;;;###autoload
1192 "Return a description of the location of BOOKMARK-NAME-OR-RECORD."
1194 ;; We could call the `handler' and ask for it to construct a description
1195 ;; dynamically: it would open up several new possibilities, but it
1196 ;; would have the major disadvantage of forcing to load each and
1197 ;; every handler when the user calls bookmark-menu.
1203 ;;;###autoload
1205 "Change the name of OLD-NAME bookmark to NEW-NAME name.
1206 If called from keyboard, prompt for OLD-NAME and NEW-NAME.
1207 If called from menubar, select OLD-NAME from a menu and prompt for NEW-NAME.
1209 If called from Lisp, prompt for NEW-NAME if only OLD-NAME was passed
1210 as an argument. If called with two strings, then no prompting is done.
1211 You must pass at least OLD-NAME when calling from Lisp.
1213 While you are entering the new name, consecutive C-w's insert
1214 consecutive words from the text of the buffer into the new bookmark
1215 name."
1225 "New name: "
1226 nil
1229 now-map)
1230 nil
1241 ;;;###autoload
1243 "Insert the text of the file pointed to by bookmark BOOKMARK-NAME.
1244 BOOKMARK-NAME is a bookmark name (a string), not a bookmark record.
1246 You may have a problem using this function if the value of variable
1247 `bookmark-alist' is nil. If that happens, you need to load in some
1248 bookmarks. See help on function `bookmark-load' for more about
1249 this."
1263 ;;;###autoload
1265 "Delete BOOKMARK-NAME from the bookmark list.
1267 Removes only the first instance of a bookmark with that name. If
1268 there are one or more other bookmarks with the same name, they will
1270 one most recently used in this file, if any).
1271 Optional second arg BATCH means don't update the bookmark list buffer,
1272 probably because we were called from there."
1275 bookmark-current-bookmark)))
1280 ;; Added by db, nil bookmark-current-bookmark if the last
1281 ;; occurrence has been deleted
1293 "Return t if it is time to save bookmarks to disk, nil otherwise.
1294 Optional argument FINAL-TIME means this is being called when Emacs
1295 is being killed, so save even if `bookmark-save-flag' is a number and
1296 is greater than `bookmark-alist-modification-count'."
1297 ;; By Gregory M. Saunders <saunders{_AT_}cis.ohio-state.edu>
1300 bookmark-save-flag))
1304 nil)))
1307 ;;;###autoload
1309 "Write bookmarks to a file (reading the file name with the minibuffer).
1310 Don't use this in Lisp programs; use `bookmark-save' instead."
1316 ;;;###autoload
1318 "Save currently defined bookmarks.
1319 Saves by default in the file defined by the variable
1320 `bookmark-default-file'. With a prefix arg, save it in file FILE
1321 \(second argument).
1323 If you are calling this from Lisp, the two arguments are PARG and
1324 FILE, and if you just want it to write to the default file, then
1325 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1326 instead. If you pass in one argument, and it is non-nil, then the
1327 user will be interactively queried for a file to save in.
1329 When you want to load in the bookmarks from a file, use
1331 for a file, defaulting to the file defined by variable
1332 `bookmark-default-file'."
1337 ;;whether interactive or not, write to default file
1340 ;;whether interactive or not, write to given file
1343 ;;have been called interactively w/ prefix arg
1348 ;; signal that we have synced the bookmark file by setting this to
1349 ;; 0. If there was an error at any point before, it will not get
1350 ;; set, which is what we want.
1354 \f
1356 "Write `bookmark-alist' to FILE."
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.
1385 "Add NEW-LIST of bookmarks to `bookmark-alist'.
1387 they conflict with existing bookmark names."
1396 "Rename bookmark FULL-RECORD if its current name is already used.
1397 This is a helper for `bookmark-import-new-list'."
1400 ;; We've got a conflict, so generate a new name
1409 ;;;###autoload
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
1427 method buffers use to resolve name collisions."
1431 bookmark-default-file)
1432 ;;Default might not be used often,
1433 ;;but there's no better default, and
1434 ;;I guess it's better than none at all.
1452 ;; else
1459 file)
1468 \f
1469 ;;; Code supporting the dired-like bookmark menu.
1470 ;; Prefix is "bookmark-bmenu" for "buffer-menu":
1509 map))
1511 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1512 ;; data.
1516 ;; todo: need to display whether or not bookmark exists as a buffer in
1517 ;; flag column.
1519 ;; Format:
1520 ;; FLAGS BOOKMARK [ LOCATION ]
1524 "Rebuild the Bookmark List if it exists.
1525 Don't affect the buffer ring order."
1532 ;;;###autoload
1534 "Display a list of existing bookmarks.
1535 The list is displayed in a buffer named `*Bookmark List*'.
1536 The leftmost column displays a D if the bookmark is flagged for
1537 deletion, or > if it is flagged for displaying."
1553 end)
1554 ;; if a bookmark has an annotation, prepend a "*"
1555 ;; in the list of bookmarks.
1558 name)
1566 follow-link t
1576 ;;;###autoload
1578 ;;;###autoload
1584 "Major mode for editing a list of bookmarks.
1585 Each line describes one of the bookmarks in Emacs.
1586 Letters do not insert themselves; instead, they are commands.
1591 Also show bookmarks marked using m in other windows.
1592 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1596 together with bookmark selected before this one in another window.
1599 so the bookmark menu bookmark remains visible in its window.
1605 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1607 With a prefix arg, prompts for a file to save in.
1610 With prefix argument, also move up one line.
1612 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1613 in another buffer.
1614 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1621 "Toggle whether filenames are shown in the bookmark list.
1622 Optional argument SHOW means show them unconditionally."
1638 "In an interactive bookmark list, show filenames along with bookmarks.
1639 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1640 mainly for debugging, and should not be necessary in normal use."
1642 nil ;already shown, so do nothing
1655 ;; Strip off `mouse-face' from the white spaces region.
1661 ;; Pass the NO-HISTORY arg:
1667 "In an interactive bookmark list, hide the filenames of the bookmarks.
1668 Non-nil FORCE forces a redisplay showing the filenames. FORCE is used
1669 mainly for debugging, and should not be necessary in normal use."
1671 ;; nothing to hide if above is nil
1690 highlight follow-link t help-echo
1696 "If point is not on a bookmark line, move it to one.
1697 If before the first bookmark line, move to the first; if after the
1698 last full line, move to the last full line. The return value is undefined."
1707 "Return the bookmark for this line in an interactive bookmark list buffer."
1716 "Display the annotation for BOOKMARK-NAME-OR-RECORD in a buffer,
1717 if an annotation exists."
1730 "Display the annotations for all bookmarks in a buffer."
1739 ;; insert the annotation, indented by 4 spaces.
1752 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1765 "Select this line's bookmark; also display bookmarks marked with `>'.
1771 tem)
1796 "Return non-nil if any bookmarks are marked in the marks column."
1806 nil)))
1810 "Save the current list into a bookmark file.
1811 With a prefix arg, prompts for a file to save them in."
1820 "Load the bookmark file and rebuild the bookmark menu-buffer."
1825 ;; This will call `bookmark-bmenu-list'
1830 "Select this line's bookmark, alone, in full frame."
1838 "Select this line's bookmark, with previous buffer in second window."
1850 "Select this line's bookmark in this window."
1856 "Select this line's bookmark in other window, leaving bookmark menu visible."
1863 "Make the other window select this line's bookmark.
1864 The current window remains selected."
1868 same-window-buffer-names
1869 same-window-regexps)
1873 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1882 "Show the annotation for the current bookmark in another window."
1889 "Show the annotation for all bookmarks in another window."
1895 "Edit the annotation for the current bookmark in another window."
1902 "Cancel all requested operations on bookmark on this line and move down.
1903 Optional BACKUP means move up."
1910 ;; any flags to reset according to circumstances? How about a
1911 ;; flag indicating whether this bookmark is being visited?
1912 ;; well, we don't have this now, so maybe later.
1919 "Move up and cancel all requested operations on bookmark on line above."
1929 "Mark bookmark on this line to be deleted.
1930 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1943 "Mark bookmark on this line to be deleted, then move up one line.
1944 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1954 "Delete bookmarks flagged `D'."
1979 ))
1983 "Rename bookmark on current line. Prompts for a new name."
1992 "Display location of this bookmark. Displays in the minibuffer."
1998 "Change the file path of the bookmark on the current line,
1999 prompting with completion for the new path."
2006 ;;; Bookmark-bmenu search
2008 ;; Store keyboard input for incremental search.
2012 "Read each keyboard input and add it to `bookmark-search-pattern'."
2014 ;; (inhibit-quit t) ; inhibit-quit is evil. Use it with extreme care!
2028 unread-command-events))
2029 nil))))
2035 "Filter `bookmark-alist' with bookmarks matching REGEXP and rebuild list."
2039 finally return new)))
2043 ;;;###autoload
2045 "Incremental search of bookmarks, hiding the non-matches as we go."
2050 bookmark-search-delay 'repeat
2053 bookmark-search-pattern)))))
2063 "Move point to bookmark with name NAME."
2070 \f
2071 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2074 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2075 That is, ENTRIES is a list of strings which appear as the choices
2076 in the menu.
2077 The number of panes depends on the number of entries.
2078 The visible entries are truncated to `bookmark-menu-length', but the
2079 strings returned are not."
2091 str)
2092 str)
2093 lst)
2100 pane-list)))
2102 ;; Popup the menu and return the string.
2107 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2108 ;; following works, and for explaining what to do to make it work.
2110 ;; We MUST autoload EACH form used to set up this variable's value, so
2111 ;; that the whole job is done in loaddefs.el.
2113 ;; Emacs menubar stuff.
2115 ;;;###autoload
2119 `(menu-item ,(purecopy "Load a Bookmark File...") bookmark-load
2120 :help ,(purecopy "Load bookmarks from a bookmark file)")))
2121 (define-key map [write]
2122 `(menu-item ,(purecopy "Save Bookmarks As...") bookmark-write
2123 :help ,(purecopy "Write bookmarks to a file (reading the file name with the minibuffer)")))
2124 (define-key map [save]
2125 `(menu-item ,(purecopy "Save Bookmarks") bookmark-save
2126 :help ,(purecopy "Save currently defined bookmarks")))
2127 (define-key map [edit]
2128 `(menu-item ,(purecopy "Edit Bookmark List") bookmark-bmenu-list
2129 :help ,(purecopy "Display a list of existing bookmarks")))
2130 (define-key map [delete]
2131 `(menu-item ,(purecopy "Delete Bookmark...") bookmark-delete
2132 :help ,(purecopy "Delete a bookmark from the bookmark list")))
2133 (define-key map [rename]
2134 `(menu-item ,(purecopy "Rename Bookmark...") bookmark-rename
2135 :help ,(purecopy "Change the name of a bookmark")))
2136 (define-key map [locate]
2137 `(menu-item ,(purecopy "Insert Location...") bookmark-locate
2138 :help ,(purecopy "Insert the name of the file associated with a bookmark")))
2139 (define-key map [insert]
2140 `(menu-item ,(purecopy "Insert Contents...") bookmark-insert
2141 :help ,(purecopy "Insert the text of the file pointed to by a bookmark")))
2142 (define-key map [set]
2143 `(menu-item ,(purecopy "Set Bookmark...") bookmark-set
2144 :help ,(purecopy "Set a bookmark named inside a file.")))
2145 (define-key map [jump]
2146 `(menu-item ,(purecopy "Jump to Bookmark...") bookmark-jump
2147 :help ,(purecopy "Jump to a bookmark (a point in some file)")))
2148 map))
2150 ;;;###autoload
2151 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2153 ;; make bookmarks appear toward the right side of the menu.
2154 (if (boundp 'menu-bar-final-items)
2155 (if menu-bar-final-items
2156 (push 'bookmark menu-bar-final-items))
2157 (setq menu-bar-final-items '(bookmark)))
2159 ;;;; end bookmark menu stuff ;;;;
2161 \f
2162 ;; Load Hook
2163 (defvar bookmark-load-hook nil
2164 "Hook run at the end of loading library `bookmark.el'.")
2166 ;; Exit Hook, called from kill-emacs-hook
2167 (define-obsolete-variable-alias 'bookmark-exit-hooks
2168 'bookmark-exit-hook "22.1")
2169 (defvar bookmark-exit-hook nil
2170 "Hook run when Emacs exits.")
2172 (defun bookmark-exit-hook-internal ()
2173 "Save bookmark state, if necessary, at Emacs exit time.
2174 This also runs `bookmark-exit-hook'."
2175 (run-hooks 'bookmark-exit-hook)
2176 (and bookmark-alist
2177 (bookmark-time-to-save-p t)
2178 (bookmark-save)))
2180 (unless noninteractive
2181 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal))
2183 (defun bookmark-unload-function ()
2184 "Unload the Bookmark library."
2185 (when bookmark-save-flag (bookmark-save))
2186 ;; continue standard unloading
2187 nil)
2190 (run-hooks 'bookmark-load-hook)
2192 (provide 'bookmark)
2194 ;;; bookmark.el ends here