| blob | ada3f0345801725c983a8048fd4dc60f40f30bbf |
1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Karl Fogel <kfogel@red-bean.com>
7 ;; Maintainer: Karl Fogel <kfogel@red-bean.com>
8 ;; Created: July, 1993
9 ;; Keywords: bookmarks, placeholders, annotations
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; This package is for setting "bookmarks" in files. A bookmark
31 ;; associates a string with a location in a certain file. Thus, you
32 ;; can navigate your way to that location by providing the string.
33 ;; See the "User Variables" section for customizations.
35 ;; Thanks to David Bremner <bremner@cs.sfu.ca> for thinking of and
36 ;; then implementing the bookmark-current-bookmark idea. He even
37 ;; sent *patches*, bless his soul...
39 ;; Thanks to Gregory M. Saunders <saunders@cis.ohio-state.edu> for
40 ;; fixing and improving bookmark-time-to-save-p.
42 ;; Thanks go to Andrew V. Klein <avk@cig.mot.com> for the code that
43 ;; sorts the alist before presenting it to the user (in bookmark-bmenu-list
44 ;; and the menu-bar).
46 ;; And much thanks to David Hughes <djh@harston.cv.com> for many small
47 ;; suggestions and the code to implement them (like
48 ;; bookmark-bmenu-check-position, and some of the Lucid compatibility
49 ;; stuff).
51 ;; Kudos (whatever they are) go to Jim Blandy <jimb@red-bean.com>
52 ;; for his eminently sensible suggestion to separate bookmark-jump
53 ;; into bookmark-jump and bookmark-jump-noselect, which made many
54 ;; other things cleaner as well.
56 ;; Thanks to Roland McGrath for encouragement and help with defining
57 ;; autoloads on the menu-bar.
59 ;; Jonathan Stigelman <stig@hackvan.com> gave patches for default
60 ;; values in bookmark-jump and bookmark-set. Everybody please keep
61 ;; all the keystrokes they save thereby and send them to him at the
62 ;; end of each year :-) (No, seriously, thanks Jonathan!)
64 ;; Buckets of gratitude to John Grabowski <johng@media.mit.edu> for
65 ;; thinking up the annotations feature and implementing it so well.
67 ;; Based on info-bookmark.el, by Karl Fogel and Ken Olstad
68 ;; <olstad@msc.edu>.
70 ;; Thanks to Mikio Nakajima <PBC01764@niftyserve.or.jp> for many bugs
71 ;; reported and fixed.
73 ;; Thank you, Michael Kifer, for contributing the XEmacs support.
75 ;; Enough with the credits already, get on to the good stuff:
77 ;; FAVORITE CHINESE RESTAURANT:
78 ;; Boy, that's a tough one. Probably Hong Min, or maybe Emperor's
79 ;; Choice (both in Chicago's Chinatown). Well, both. How about you?
80 \f
81 ;;; Code:
85 ;;; Misc comments:
86 ;;
87 ;; If variable bookmark-use-annotations is non-nil, an annotation is
88 ;; queried for when setting a bookmark.
89 ;;
90 ;; The bookmark list is sorted lexically by default, but you can turn
91 ;; this off by setting bookmark-sort-flag to nil. If it is nil, then
92 ;; the list will be presented in the order it is recorded
93 ;; (chronologically), which is actually fairly useful as well.
95 ;;; User Variables
98 "Setting, annotation and jumping to bookmarks."
103 "If non-nil, saving a bookmark queries for an annotation in a buffer."
109 "Controls when Emacs saves bookmarks to a file.
110 --> nil means never save bookmarks, except when `bookmark-save' is
112 --> t means save bookmarks when Emacs is killed.
113 --> Otherwise, it should be a number that is the frequency with which
114 the bookmark list is saved \(i.e.: the number of times which
115 Emacs' bookmark list may be modified before it is automatically
116 saved.\). If it is a number, Emacs will also automatically save
117 bookmarks when it is killed.
119 Therefore, the way to get it to save every time you make or delete a
120 bookmark is to set this variable to 1 \(or 0, which produces the same
121 behavior.\)
123 To specify the file in which to save them, modify the variable
124 `bookmark-default-file', which is `~/.emacs.bmk' by default."
133 ;; defvarred to avoid a compilation warning:
139 ;; In case user set `bookmark-file' in her .emacs:
140 bookmark-file
142 "File in which to save bookmarks by default."
148 "Whether or not to make numbered backups of the bookmark file.
149 It can have four values: t, nil, `never', and `nospecial'.
150 The first three have the same meaning that they do for the
151 variable `version-control', and the final value `nospecial' means just
152 use the value of `version-control'."
159 "Non-nil means bookmark functions ignore case in completion."
165 "Non-nil means that bookmarks will be displayed sorted by bookmark name.
166 Otherwise they will be displayed in LIFO order (that is, most
167 recently set ones come first, oldest ones come last)."
173 "Non-nil means show annotations when jumping to a bookmark."
179 "Column at which to display filenames in a buffer listing bookmarks.
180 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
186 "Non-nil means show filenames when listing bookmarks.
187 This may result in truncated bookmark names. To disable this, put the
188 following in your `.emacs' file:
190 \(setq bookmark-bmenu-toggle-filenames nil\)"
196 "Maximum length of a bookmark name displayed on a popup menu."
203 "Face used to highlight the heading in bookmark menu buffers."
208 ;;; No user-serviceable parts beyond this point.
210 ;; Added for lucid emacs compatibility, db
213 ;; suggested for lucid compatibility by david hughes:
216 \f
217 ;;; Keymap stuff:
219 ;; Set up these bindings dumping time *only*;
220 ;; if the user alters them, don't override the user when loading bookmark.el.
222 ;;;###autoload (define-key ctl-x-map "rb" 'bookmark-jump)
223 ;;;###autoload (define-key ctl-x-map "rm" 'bookmark-set)
224 ;;;###autoload (define-key ctl-x-map "rl" 'bookmark-bmenu-list)
226 ;;;###autoload
229 ;; Read the help on all of these functions for details...
243 map)
244 "Keymap containing bindings to bookmark functions.
245 It is not bound to any key by default: to bind it
246 so that you have a bookmark prefix, just use `global-set-key' and bind a
247 key of your choice to `bookmark-map'. All interactive bookmark
250 ;;;###autoload (fset 'bookmark-map bookmark-map)
252 ;;; The annotation maps.
257 map)
260 \f
261 ;;; Core variables and data structures:
263 "Association list of bookmarks and their records.
264 You probably don't want to change the value of this alist yourself;
265 instead, let the various bookmark functions do it for you.
267 The format of the alist is
269 \(BOOKMARK1 BOOKMARK2 ...\)
271 where each BOOKMARK is typically of the form
273 \(NAME
274 (\(filename . FILE\)
275 \(front-context-string . FRONT-STR\)
276 \(rear-context-string . REAR-STR\)
277 \(position . POS\)
278 \(annotation . ANNOTATION\)\))
286 ;; more stuff added by db.
289 "Name of bookmark most recently used in the current file.
290 It is buffer local, used to make moving a bookmark forward
310 \f
311 ;; Helper functions.
313 ;; Only functions on this page and the next one (file formats) need to
314 ;; know anything about the format of bookmark-alist entries.
315 ;; Everyone else should go through them.
319 "Return name of FULL-RECORD \(an alist element instead of a string\)."
324 "Return a list of all current bookmark names."
329 bookmark-alist))
333 "Return the full entry for BOOKMARK in `bookmark-alist'.
334 If BOOKMARK is not a string, return nil."
340 "Return the guts of the entry for BOOKMARK in `bookmark-alist'.
341 That is, all information but the name."
346 "Set BOOKMARK's name to NEWNAME."
349 newname))
352 "Return the property PROP of BOOKMARK, or nil if none."
356 "Set the property PROP of BOOKMARK to VAL."
364 "Return the annotation of BOOKMARK, or nil if none."
368 "Set the annotation of BOOKMARK to ANN."
373 "Return the full filename of BOOKMARK."
378 "Set the full filename of BOOKMARK to FILENAME."
387 "Return the position \(i.e.: point\) of BOOKMARK."
392 "Set the position \(i.e.: point\) of BOOKMARK to POSITION."
397 "Return the front-context-string of BOOKMARK."
402 "Set the front-context-string of BOOKMARK to STRING."
407 "Return the rear-context-string of BOOKMARK."
412 "Set the rear-context-string of BOOKMARK to STRING."
424 "Prompting with PROMPT, read a bookmark name in completion.
426 probably don't want to include one yourself.
427 Optional second arg DEFAULT is a string to return if the user enters
428 the empty string."
439 bookmark-alist
440 nil
441 0
442 nil
448 "Put STRING into the bookmark prompt history, if caller non-interactive.
449 We need this because sometimes bookmark functions are invoked from
450 menus, so `completing-read' never gets a chance to set `bookmark-history'."
456 "A function that should be called to return the name of the bookmark.
457 When called with an argument, the function should return a file
458 name -- or whatever is required to jump to the location. Modes
459 may set this variable buffer-locally to enable a default name to
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 The returned record may contain a special cons (handler . SOME-FUNCTION)
470 which sets the handler function that should be used to open this
471 bookmark instead of `bookmark-default-handler'. The handler should
472 return an alist like the one that function returns, and (of course)
476 "Make a bookmark named NAME.
477 Optional second arg ANNOTATION gives it an annotation.
478 Optional third arg OVERWRITE means replace any existing bookmarks with
479 this name."
483 ;; XEmacs's `set-text-properties' doesn't work on
484 ;; free-standing strings, apparently.
487 ;; already existing bookmark under that name and
488 ;; no prefix arg means just overwrite old bookmark
492 ;; otherwise just cons it onto the front (either the bookmark
493 ;; doesn't exist already, or there is no prefix arg. In either
494 ;; case, we want the new bookmark consed onto the alist...)
498 bookmark-alist))
501 ;; Take no chances with text properties.
505 ;; Added by db
514 "Return the record describing the location of a new bookmark.
515 Must be at the correct position in the buffer in which the bookmark is
516 being set (this might change someday)."
523 nil))
529 nil))
532 \f
533 ;;; File format stuff
535 ;; The OLD format of the bookmark-alist was:
536 ;;
537 ;; ((bookmark-name (filename
538 ;; string-in-front
539 ;; string-behind
540 ;; point))
541 ;; ...)
542 ;;
543 ;; The NEW format of the bookmark-alist is:
544 ;;
545 ;; ((bookmark-name ((filename . FILENAME)
546 ;; (front-context-string . string-in-front)
547 ;; (rear-context-string . string-behind)
548 ;; (position . POINT)
549 ;; (annotation . annotation)
550 ;; (whatever . VALUE)
551 ;; ...
552 ;; ))
553 ;; ...)
554 ;;
555 ;;
556 ;; I switched to using an internal as well as external alist because I
557 ;; felt that would be a more flexible framework in which to add
558 ;; features. It means that the order in which values appear doesn't
559 ;; matter, and it means that arbitrary values can be added without
560 ;; risk of interfering with existing ones.
561 ;;
562 ;; BOOKMARK-NAME is the string the user gives the bookmark and
563 ;; accesses it by from then on.
564 ;;
565 ;; FILENAME is the location of the file in which the bookmark is set.
566 ;;
567 ;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
568 ;; context in front of the point at which the bookmark is set.
569 ;;
570 ;; STRING-BEHIND is the same thing, but after the point.
571 ;;
572 ;; The context strings exist so that modifications to a file don't
573 ;; necessarily cause a bookmark's position to be invalidated.
574 ;; bookmark-jump will search for STRING-BEHIND and STRING-IN-FRONT in
575 ;; case the file has changed since the bookmark was set. It will
576 ;; attempt to place the user before the changes, if there were any.
577 ;; ANNOTATION is the annotation for the bookmark; it may not exist
578 ;; (for backward compatibility), be nil (no annotation), or be a
579 ;; string.
583 "The current version of the format used by bookmark files.
593 "Return a `bookmark-alist' (in any format) from the current buffer.
594 The buffer must of course contain bookmark format information.
595 Does not care from where in the buffer it is called, and does not
596 affect point."
601 ;; Else we're dealing with format version 0
606 ;; Else no hope of getting information here.
611 "Upgrade a version 0 alist OLD-LIST to the current version."
622 name
628 old-list))
632 "Upgrade a bookmark file of format 0 (the original format) to format 1.
633 This expects to be called from `point-min' in a bookmark file."
635 bookmark-file-format-version)
644 bookmark-file-format-version)
645 )
649 "Return an integer which is the file-format version of this bookmark file.
650 This expects to be called from `point-min' in a bookmark file."
657 ;; Else this is format version 0, the original one, which didn't
658 ;; even have version stamps.
663 "Check the file-format version of this bookmark file.
664 If the version is not up-to-date, upgrade it automatically.
665 This expects to be called from `point-min' in a bookmark file."
677 "Insert text indicating current version of bookmark file format."
680 bookmark-file-format-version))
683 ";;; "
684 bookmark-end-of-version-stamp-marker))
687 ;;; end file-format stuff
689 \f
690 ;;; Generic helpers.
693 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
697 \f
698 ;;; Core code:
704 ;; This C-u binding might not be very useful any more now that we
705 ;; provide access to the default via the standard M-n binding.
706 ;; Maybe we should just remove it? --Stef-08
708 map))
710 ;;;###autoload
712 "Set a bookmark named NAME inside a file.
713 If name is nil, then the user will be prompted.
714 With prefix arg, will not overwrite a bookmark that has the same name
716 the new bookmark onto the bookmark alist. Thus the most recently set
717 bookmark with name NAME would be the one in effect at any given time,
718 but the others are still there, should you decide to delete the most
719 recent one.
721 To yank words from the text of the buffer and use them as part of the
722 bookmark name, type C-w while setting a bookmark. Successive C-w's
723 yank successive words.
725 Typing C-u inserts the name of the last bookmark used in the buffer
726 \(as an aid in using a single bookmark name to track your progress
727 through a large file\). If no bookmark was used, then C-u inserts the
728 name of the file being visited.
731 and it removes only the first instance of a bookmark with that name from
732 the list of bookmarks.\)"
750 nil
751 bookmark-minibuffer-read-name-map
752 nil nil default)))
755 ;; Ask for an annotation buffer for this bookmark
765 "Kill from point to end of line.
766 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
767 Does not affect the kill ring."
774 ;; Defvars to avoid compilation warnings:
783 "Use buffer contents as the annotation for a bookmark.
784 Exclude lines that begin with `#'.
785 Store the annotation text in the bookmark list with
786 the bookmark (and file, and point) specified in buffer local variables."
800 ;; for bookmark-make-record-function to work, we need to be
801 ;; in the relevant buffer, at the relevant point.
802 ;; Actually, the bookmark-make-record-function spec should
803 ;; probably be changed to avoid this need. Should I handle the
804 ;; error if a buffer is killed between "C-x r m" and a "C-c C-c"
805 ;; in the annotation buffer?
826 "Function to return default text to use for a bookmark annotation.
830 "Mode for composing annotations for a bookmark.
831 Wants BUF, POINT, PARG, and BOOKMARK.
833 the annotation.
855 "Pop up a buffer for entering a bookmark annotation.
856 Text surrounding the bookmark is PARG; the bookmark name is BOOKMARK."
872 "Mode for editing the annotation of bookmark BOOKMARK.
891 "Use buffer contents as annotation for a bookmark.
892 Lines beginning with `#' are ignored."
901 ;; Take no chances with text properties.
911 "Pop up a buffer for editing bookmark BOOKMARK's annotation."
917 "Insert this buffer's value of `bookmark-current-bookmark'.
918 Default to file name if it's nil."
928 "Return the name of the current buffer's file, non-directory.
929 In Info, return the current node."
931 ;; Is the mode defining the bookmark buffer name?
934 ;; Or are we a file?
936 ;; Or are we a directory?
939 dired-directory
942 ;; Strip the trailing slash.
945 ;; Else return the current-buffer
947 ;; If all else fails, use the buffer's name.
954 ;; get the next word from the buffer and append it to the name of
955 ;; the bookmark currently being set.
970 "Return the current buffer's file in a way useful for bookmarks.
971 For example, if this is a Info buffer, return the Info file's name."
973 ;; Return the location the handler should jump to
974 ;; E.g. the Info file name for the Info handler
978 ;; Abbreviate the path, both so it's shorter and so it's more
979 ;; portable. E.g., the user's home dir might be a different
980 ;; path on different machines, but "~/" will still reach it.
984 dired-directory
994 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
995 ;; to be renamed.
1000 ;; return t so the `and' will continue...
1001 t)
1009 ;;Return the bookmark-alist for display. If the bookmark-sort-flag
1010 ;;is non-nil, then return a sorted copy of the alist.
1015 bookmark-alist))
1019 "Hook run after `bookmark-jump' jumps to a bookmark.
1022 ;;;###autoload
1024 "Jump to bookmark BOOKMARK (a point in some file).
1025 You may have a problem using this function if the value of variable
1026 `bookmark-alist' is nil. If that happens, you need to load in some
1027 bookmarks. See help on function `bookmark-load' for more about
1028 this.
1030 If the file pointed to by BOOKMARK no longer exists, you will be asked
1031 if you wish to give the bookmark a new location, and `bookmark-jump'
1032 will then jump to the new location, as well as recording it in place
1033 of the old one in the permanent bookmark record."
1036 bookmark-current-bookmark)))
1046 ;; if there is an annotation for this bookmark,
1047 ;; show it in a buffer.
1051 ;;;###autoload
1053 "Jump to BOOKMARK (a point in some file) in another window.
1054 See `bookmark-jump'."
1057 bookmark-current-bookmark)))
1067 ;; if there is an annotation for this bookmark,
1068 ;; show it in a buffer.
1073 "Return FILE (a string) if it exists, or return a reasonable
1074 variation of FILE if that exists. Reasonable variations are checked
1075 by appending suffixes defined in `Info-suffix-list'. If cannot find FILE
1076 nor a reasonable variation thereof, then still return FILE if it can
1077 be retrieved from a VC backend, else return nil."
1079 file
1087 Info-suffix-list)
1088 nil))
1089 ;; Last possibility: try VC
1093 "Call BOOKMARK's handler or `bookmark-default-handler' if it has none."
1096 bookmark)))
1098 ;; Else unable to find the marked file, so ask if user wants to
1099 ;; relocate the bookmark, else remind them to consider deletion.
1106 bookmark
1110 ;; Try again.
1113 bookmark)))
1117 ;; Added by db.
1119 found)))
1122 ;; Helper for bookmark-jump. STR is a bookmark name, of the sort
1123 ;; accepted by `bookmark-get-bookmark'.
1124 ;;
1125 ;; Return an alist '((buffer BUFFER) (position POSITION) ...)
1126 ;; indicating the bookmarked point within the specied buffer. Any
1127 ;; elements not documented here should be ignored.
1133 ;; FIXME: bookmark-file-or-variation-thereof was needed for Info files,
1134 ;; but now that Info bookmarks are handled elsewhere it seems that we
1135 ;; should be able to get rid of it. --Stef
1140 ;; Go searching forward first. Then, if forward-str exists and
1141 ;; was found in the file, we can search backward for behind-str.
1142 ;; Rationale is that if text was inserted between the two in the
1143 ;; file, it's better to be put before it so you can read it,
1144 ;; rather than after and remain perhaps unaware of the changes.
1154 ;;;###autoload
1156 "Relocate BOOKMARK to another file (reading file name with minibuffer).
1157 This makes an already existing bookmark point to that file, instead of
1158 the one it used to point at. Useful when a file has been renamed
1159 after a bookmark was set in it."
1172 ;;;###autoload
1174 "Insert the name of the file associated with BOOKMARK.
1175 Optional second arg NO-HISTORY means don't record this in the
1176 minibuffer history list `bookmark-history'."
1184 start
1189 follow-link t
1192 ;;;###autoload
1196 "Return the name of the file associated with BOOKMARK."
1201 ;;;###autoload
1203 "Change the name of OLD bookmark to NEW name.
1204 If called from keyboard, prompt for OLD and NEW. If called from
1205 menubar, select OLD from a menu and prompt for NEW.
1207 If called from Lisp, prompt for NEW if only OLD was passed as an
1208 argument. If called with two strings, then no prompting is done. You
1209 must pass at least OLD when calling from Lisp.
1211 While you are entering the new name, consecutive C-w's insert
1212 consecutive words from the text of the buffer into the new bookmark
1213 name."
1224 "New name: "
1225 nil
1228 now-map)
1229 nil
1240 ;;;###autoload
1242 "Insert the text of the file pointed to by bookmark BOOKMARK.
1243 You may have a problem using this function if the value of variable
1244 `bookmark-alist' is nil. If that happens, you need to load in some
1245 bookmarks. See help on function `bookmark-load' for more about
1246 this."
1260 ;;;###autoload
1262 "Delete BOOKMARK from the bookmark list.
1263 Removes only the first instance of a bookmark with that name. If
1264 there are one or more other bookmarks with the same name, they will
1266 one most recently used in this file, if any\).
1267 Optional second arg BATCH means don't update the bookmark list buffer,
1268 probably because we were called from there."
1271 bookmark-current-bookmark)))
1276 ;; Added by db, nil bookmark-current-bookmark if the last
1277 ;; occurrence has been deleted
1280 ;; Don't rebuild the list
1282 nil
1291 ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu>
1292 ;; finds out whether it's time to save bookmarks to a file, by
1293 ;; examining the value of variable bookmark-save-flag, and maybe
1294 ;; bookmark-alist-modification-count. Returns t if they should be
1295 ;; saved, nil otherwise. if last-time is non-nil, then this is
1296 ;; being called when emacs is killed.
1299 bookmark-save-flag))
1303 nil)))
1306 ;;;###autoload
1308 "Write bookmarks to a file (reading the file name with the minibuffer).
1309 Don't use this in Lisp programs; use `bookmark-save' instead."
1315 ;;;###autoload
1317 "Save currently defined bookmarks.
1318 Saves by default in the file defined by the variable
1319 `bookmark-default-file'. With a prefix arg, save it in file FILE
1320 \(second argument\).
1322 If you are calling this from Lisp, the two arguments are PARG and
1323 FILE, and if you just want it to write to the default file, then
1324 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1325 instead. If you pass in one argument, and it is non-nil, then the
1326 user will be interactively queried for a file to save in.
1328 When you want to load in the bookmarks from a file, use
1330 for a file, defaulting to the file defined by variable
1331 `bookmark-default-file'."
1336 ;;whether interactive or not, write to default file
1339 ;;whether interactive or not, write to given file
1342 ;;have been called interactively w/ prefix arg
1347 ;; signal that we have synced the bookmark file by setting this to
1348 ;; 0. If there was an error at any point before, it will not get
1349 ;; set, which is what we want.
1353 \f
1371 t))))
1381 ;; Walk over the new list, adding each individual bookmark
1382 ;; carefully. "Carefully" means checking against the existing
1383 ;; bookmark-alist and renaming the new bookmarks with <N> extensions
1384 ;; as necessary.
1396 ;; just a helper for bookmark-import-new-list; it is only for
1397 ;; readability that this is not inlined.
1398 ;;
1399 ;; Once this has found a free name, it sets full-record to that
1400 ;; name.
1403 ;; We've got a conflict, so generate a new name
1412 ;;;###autoload
1414 "Load bookmarks from FILE (which must be in bookmark format).
1415 Appends loaded bookmarks to the front of the list of bookmarks. If
1416 optional second argument OVERWRITE is non-nil, existing bookmarks are
1417 destroyed. Optional third arg NO-MSG means don't display any messages
1418 while loading.
1420 If you load a file that doesn't contain a proper bookmark alist, you
1421 will corrupt Emacs's bookmark list. Generally, you should only load
1422 in files that were created with the bookmark functions in the first
1423 place. Your own personal bookmark file, `~/.emacs.bmk', is
1424 maintained automatically by Emacs; you shouldn't need to load it
1425 explicitly.
1427 If you load a file containing bookmarks with the same names as
1428 bookmarks already present in your Emacs, the new bookmarks will get
1430 method buffers use to resolve name collisions."
1434 bookmark-default-file)
1435 ;;Default might not be used often,
1436 ;;but there's no better default, and
1437 ;;I guess it's better than none at all.
1456 ;; else
1462 file)
1472 \f
1473 ;;; Code supporting the dired-like bookmark menu. Prefix is
1474 ;;; "bookmark-bmenu" for "buffer-menu":
1487 nil
1526 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1527 ;; data.
1531 ;; todo: need to display whether or not bookmark exists as a buffer in
1532 ;; flag column.
1534 ;; Format:
1535 ;; FLAGS BOOKMARK [ LOCATION ]
1539 "Rebuild the Bookmark List if it exists.
1540 Don't affect the buffer ring order."
1547 ;;;###autoload
1549 "Display a list of existing bookmarks.
1550 The list is displayed in a buffer named `*Bookmark List*'.
1551 The leftmost column displays a D if the bookmark is flagged for
1552 deletion, or > if it is flagged for displaying."
1565 ;; if a bookmark has an annotation, prepend a "*"
1566 ;; in the list of bookmarks.
1576 start
1581 follow-link t
1584 )))
1592 ;;;###autoload
1594 ;;;###autoload
1600 "Major mode for editing a list of bookmarks.
1601 Each line describes one of the bookmarks in Emacs.
1602 Letters do not insert themselves; instead, they are commands.
1607 Also show bookmarks marked using m in other windows.
1608 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1612 together with bookmark selected before this one in another window.
1615 so the bookmark menu bookmark remains visible in its window.
1621 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1623 With a prefix arg, prompts for a file to save in.
1626 With prefix argument, also move up one line.
1628 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1629 in another buffer.
1630 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1642 "Toggle whether filenames are shown in the bookmark list.
1643 Optional argument SHOW means show them unconditionally."
1660 nil ;already shown, so do nothing
1673 ;; Strip off `mouse-face' from the white spaces region.
1679 ;; Pass the NO-HISTORY arg:
1686 ;; nothing to hide if above is nil
1707 start
1712 follow-link t
1713 help-echo
1721 ;; Returns non-nil if on a line with a bookmark.
1722 ;; (The actual value returned is bookmark-alist).
1723 ;; Else reposition and try again, else return nil.
1727 bookmark-alist)
1730 bookmark-alist)
1732 bookmark-alist)))
1736 ;; return a string which is bookmark of this line.
1755 ;; well, this is certainly crystal-clear:
1761 "Display the annotation for bookmark named BOOKMARK in a buffer,
1762 if an annotation exists."
1769 ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n"))
1776 "Display the annotations for all bookmarks in a buffer."
1786 ;; insert the annotation, indented by 4 spaces.
1795 bookmark-alist)
1801 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1813 "Select this line's bookmark; also display bookmarks marked with `>'.
1820 tem)
1845 "Save the current list into a bookmark file.
1846 With a prefix arg, prompts for a file to save them in."
1854 "Load the bookmark file and rebuild the bookmark menu-buffer."
1859 ;; This will call `bookmark-bmenu-list'
1864 "Select this line's bookmark, alone, in full frame."
1874 "Select this line's bookmark, with previous buffer in second window."
1891 "Select this line's bookmark in this window."
1898 "Select this line's bookmark in other window, leaving bookmark menu visible."
1912 "Make the other window select this line's bookmark.
1913 The current window remains selected."
1917 same-window-buffer-names
1918 same-window-regexps)
1925 ;; save-excursion won't do
1933 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1943 "Show the annotation for the current bookmark in another window."
1951 "Show the annotation for all bookmarks in another window."
1957 "Edit the annotation for the current bookmark in another window."
1965 "Cancel all requested operations on bookmark on this line and move down.
1966 Optional BACKUP means move up."
1973 ;; any flags to reset according to circumstances? How about a
1974 ;; flag indicating whether this bookmark is being visited?
1975 ;; well, we don't have this now, so maybe later.
1982 "Move up and cancel all requested operations on bookmark on line above."
1993 "Mark bookmark on this line to be deleted.
1994 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2006 "Mark bookmark on this line to be deleted, then move up one line.
2007 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2025 nil
2053 ))
2057 "Rename bookmark on current line. Prompts for a new name."
2068 "Display location of this bookmark. Displays in the minibuffer."
2075 "Change the file path of the bookmark on the current line,
2076 prompting with completion for the new path."
2084 \f
2085 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2088 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2089 That is, ENTRIES is a list of strings which appear as the choices
2090 in the menu.
2091 The number of panes depends on the number of entries.
2092 The visible entries are truncated to `bookmark-menu-length', but the
2093 strings returned are not."
2105 str)
2106 str)
2107 lst)
2114 pane-list)))
2116 ;; Popup the menu and return the string.
2121 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2122 ;; following works, and for explaining what to do to make it work.
2124 ;; We MUST autoload EACH form used to set up this variable's value, so
2125 ;; that the whole job is done in loaddefs.el.
2127 ;; Emacs menubar stuff.
2129 ;;;###autoload
2133 (define-key map [write] '("Save Bookmarks As..." . bookmark-write))
2134 (define-key map [save] '("Save Bookmarks" . bookmark-save))
2135 (define-key map [edit] '("Edit Bookmark List" . bookmark-bmenu-list))
2136 (define-key map [delete] '("Delete Bookmark..." . bookmark-delete))
2137 (define-key map [rename] '("Rename Bookmark..." . bookmark-rename))
2138 (define-key map [locate] '("Insert Location..." . bookmark-locate))
2139 (define-key map [insert] '("Insert Contents..." . bookmark-insert))
2140 (define-key map [set] '("Set Bookmark..." . bookmark-set))
2141 (define-key map [jump] '("Jump to Bookmark..." . bookmark-jump))
2142 map))
2144 ;;;###autoload
2145 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2147 ;; make bookmarks appear toward the right side of the menu.
2148 (if (boundp 'menu-bar-final-items)
2149 (if menu-bar-final-items
2150 (setq menu-bar-final-items
2151 (cons 'bookmark menu-bar-final-items)))
2152 (setq menu-bar-final-items '(bookmark)))
2154 ;;;; end bookmark menu stuff ;;;;
2156 \f
2157 ;;; Load Hook
2158 (defvar bookmark-load-hook nil
2159 "Hook run at the end of loading bookmark.")
2161 ;;; Exit Hook, called from kill-emacs-hook
2162 (defvar bookmark-exit-hook nil
2163 "Hook run when Emacs exits.")
2165 (define-obsolete-variable-alias 'bookmark-exit-hooks 'bookmark-exit-hook "22.1")
2167 (defun bookmark-exit-hook-internal ()
2168 "Save bookmark state, if necessary, at Emacs exit time.
2169 This also runs `bookmark-exit-hook'."
2170 (run-hooks 'bookmark-exit-hook)
2171 (and bookmark-alist
2172 (bookmark-time-to-save-p t)
2173 (bookmark-save)))
2175 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal)
2178 (run-hooks 'bookmark-load-hook)
2180 (provide 'bookmark)
2182 ;; arch-tag: 139f519a-dd0c-4b8d-8b5d-f9fcf53ca8f6
2183 ;;; bookmark.el ends here