| blob | ec8e20d2c7acbf34fe5ba23841777890dedfeb95 |
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 of the License, or
16 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This package is for setting "bookmarks" in files. A bookmark
29 ;; associates a string with a location in a certain file. Thus, you
30 ;; can navigate your way to that location by providing the string.
31 ;; See the "User Variables" section for customizations.
33 ;; Thanks to David Bremner <bremner@cs.sfu.ca> for thinking of and
34 ;; then implementing the bookmark-current-bookmark idea. He even
35 ;; sent *patches*, bless his soul...
37 ;; Thanks to Gregory M. Saunders <saunders@cis.ohio-state.edu> for
38 ;; fixing and improving bookmark-time-to-save-p.
40 ;; Thanks go to Andrew V. Klein <avk@cig.mot.com> for the code that
41 ;; sorts the alist before presenting it to the user (in bookmark-bmenu-list
42 ;; and the menu-bar).
44 ;; And much thanks to David Hughes <djh@harston.cv.com> for many small
45 ;; suggestions and the code to implement them (like
46 ;; bookmark-bmenu-check-position, and some of the Lucid compatibility
47 ;; stuff).
49 ;; Kudos (whatever they are) go to Jim Blandy <jimb@red-bean.com>
50 ;; for his eminently sensible suggestion to separate bookmark-jump
51 ;; into bookmark-jump and bookmark-jump-noselect, which made many
52 ;; other things cleaner as well.
54 ;; Thanks to Roland McGrath for encouragement and help with defining
55 ;; autoloads on the menu-bar.
57 ;; Jonathan Stigelman <stig@hackvan.com> gave patches for default
58 ;; values in bookmark-jump and bookmark-set. Everybody please keep
59 ;; all the keystrokes they save thereby and send them to him at the
60 ;; end of each year :-) (No, seriously, thanks Jonathan!)
62 ;; Buckets of gratitude to John Grabowski <johng@media.mit.edu> for
63 ;; thinking up the annotations feature and implementing it so well.
65 ;; Based on info-bookmark.el, by Karl Fogel and Ken Olstad
66 ;; <olstad@msc.edu>.
68 ;; Thanks to Mikio Nakajima <PBC01764@niftyserve.or.jp> for many bugs
69 ;; reported and fixed.
71 ;; Thank you, Michael Kifer, for contributing the XEmacs support.
73 ;; Enough with the credits already, get on to the good stuff:
75 ;; FAVORITE CHINESE RESTAURANT:
76 ;; Boy, that's a tough one. Probably Hong Min, or maybe Emperor's
77 ;; Choice (both in Chicago's Chinatown). Well, both. How about you?
78 \f
79 ;;; Code:
83 ;;; Misc comments:
84 ;;
85 ;; If variable bookmark-use-annotations is non-nil, an annotation is
86 ;; queried for when setting a bookmark.
87 ;;
88 ;; The bookmark list is sorted lexically by default, but you can turn
89 ;; this off by setting bookmark-sort-flag to nil. If it is nil, then
90 ;; the list will be presented in the order it is recorded
91 ;; (chronologically), which is actually fairly useful as well.
93 ;;; User Variables
96 "Setting, annotation and jumping to bookmarks."
101 "If non-nil, saving a bookmark queries for an annotation in a buffer."
107 "Controls when Emacs saves bookmarks to a file.
108 --> nil means never save bookmarks, except when `bookmark-save' is
110 --> t means save bookmarks when Emacs is killed.
111 --> Otherwise, it should be a number that is the frequency with which
112 the bookmark list is saved \(i.e.: the number of times which
113 Emacs' bookmark list may be modified before it is automatically
114 saved.\). If it is a number, Emacs will also automatically save
115 bookmarks when it is killed.
117 Therefore, the way to get it to save every time you make or delete a
118 bookmark is to set this variable to 1 \(or 0, which produces the same
119 behavior.\)
121 To specify the file in which to save them, modify the variable
122 `bookmark-default-file', which is `~/.emacs.bmk' by default."
131 ;; defvarred to avoid a compilation warning:
137 ;; In case user set `bookmark-file' in her .emacs:
138 bookmark-file
140 "File in which to save bookmarks by default."
146 "Whether or not to make numbered backups of the bookmark file.
147 It can have four values: t, nil, `never', and `nospecial'.
148 The first three have the same meaning that they do for the
149 variable `version-control', and the final value `nospecial' means just
150 use the value of `version-control'."
157 "Non-nil means bookmark functions ignore case in completion."
163 "Non-nil means that bookmarks will be displayed sorted by bookmark name.
164 Otherwise they will be displayed in LIFO order (that is, most
165 recently set ones come first, oldest ones come last)."
171 "Non-nil means show annotations when jumping to a bookmark."
177 "Column at which to display filenames in a buffer listing bookmarks.
178 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
184 "Non-nil means show filenames when listing bookmarks.
185 This may result in truncated bookmark names. To disable this, put the
186 following in your `.emacs' file:
188 \(setq bookmark-bmenu-toggle-filenames nil\)"
194 "Maximum length of a bookmark name displayed on a popup menu."
201 "Face used to highlight the heading in bookmark menu buffers."
206 ;;; No user-serviceable parts beyond this point.
208 ;; Added for lucid emacs compatibility, db
211 ;; suggested for lucid compatibility by david hughes:
214 \f
215 ;;; Keymap stuff:
217 ;; Set up these bindings dumping time *only*;
218 ;; if the user alters them, don't override the user when loading bookmark.el.
220 ;;;###autoload (define-key ctl-x-map "rb" 'bookmark-jump)
221 ;;;###autoload (define-key ctl-x-map "rm" 'bookmark-set)
222 ;;;###autoload (define-key ctl-x-map "rl" 'bookmark-bmenu-list)
224 ;;;###autoload
227 ;; Read the help on all of these functions for details...
241 map)
242 "Keymap containing bindings to bookmark functions.
243 It is not bound to any key by default: to bind it
244 so that you have a bookmark prefix, just use `global-set-key' and bind a
245 key of your choice to `bookmark-map'. All interactive bookmark
248 ;;;###autoload (fset 'bookmark-map bookmark-map)
250 \f
251 ;;; Core variables and data structures:
253 "Association list of bookmarks and their records.
254 You probably don't want to change the value of this alist yourself;
255 instead, let the various bookmark functions do it for you.
257 The format of the alist is
259 \(BOOKMARK1 BOOKMARK2 ...\)
261 where each BOOKMARK is typically of the form
263 \(NAME
264 (filename . FILE)
265 (front-context-string . FRONT-STR)
266 (rear-context-string . REAR-STR)
267 (position . POS)
268 (annotation . ANNOTATION))
276 ;; more stuff added by db.
279 "Name of bookmark most recently used in the current file.
280 It is buffer local, used to make moving a bookmark forward
299 \f
300 ;; Helper functions.
302 ;; Only functions on this page and the next one (file formats) need to
303 ;; know anything about the format of bookmark-alist entries.
304 ;; Everyone else should go through them.
308 "Return name of FULL-RECORD \(an alist element instead of a string\)."
313 "Return a list of all current bookmark names."
318 bookmark-alist))
322 "Return the full entry for BOOKMARK in `bookmark-alist'.
323 If BOOKMARK is not a string, return nil."
329 "Return the guts of the entry for BOOKMARK in `bookmark-alist'.
330 That is, all information but the name."
335 "Set BOOKMARK's name to NEWNAME."
338 newname))
341 "Return the property PROP of BOOKMARK, or nil if none."
345 "Set the property PROP of BOOKMARK to VAL."
353 "Return the annotation of BOOKMARK, or nil if none."
357 "Set the annotation of BOOKMARK to ANN."
362 "Return the full filename of BOOKMARK."
367 "Set the full filename of BOOKMARK to FILENAME."
376 "Return the position \(i.e.: point\) of BOOKMARK."
381 "Set the position \(i.e.: point\) of BOOKMARK to POSITION."
386 "Return the front-context-string of BOOKMARK."
391 "Set the front-context-string of BOOKMARK to STRING."
396 "Return the rear-context-string of BOOKMARK."
401 "Set the rear-context-string of BOOKMARK to STRING."
413 "Prompting with PROMPT, read a bookmark name in completion.
415 probably don't want to include one yourself.
416 Optional second arg DEFAULT is a string to return if the user enters
417 the empty string."
428 bookmark-alist
429 nil
430 0
431 nil
437 "Put STRING into the bookmark prompt history, if caller non-interactive.
438 We need this because sometimes bookmark functions are invoked from
439 menus, so `completing-read' never gets a chance to set `bookmark-history'."
445 "A function that should be called to create a bookmark record.
446 Modes may set this variable buffer-locally to enable bookmarking of
447 locations that should be treated specially, such as Info nodes,
448 news posts, images, pdf documents, etc.
450 The function will be called with no arguments.
452 The returned record should be a cons cell of the form (NAME . ALIST)
453 where ALIST is as described in `bookmark-alist' and may typically contain
454 a special cons (handler . SOME-FUNCTION) which sets the handler function
455 that should be used to open this bookmark instead of
456 `bookmark-default-handler'. The handler should return an alist like the
457 one that function returns, and (of course) should likewise
458 not select the buffer.
459 It should signal a user error if it is unable to construct a record for the current
460 location.
462 NAME is a suggested name for the constructed bookmark. It can be nil
466 "Return a new bookmark record (NAME . ALIST) for the current location."
468 ;; Set up default name.
470 ;; The function already provided a default name.
471 record
474 record)))
477 "Store the bookmark NAME with data ALIST.
478 If NO-OVERWRITE is non-nil and another bookmark of the same name already
479 exists in `bookmark-alist', record the new bookmark without throwing away the
480 old one."
484 ;; XEmacs's `set-text-properties' doesn't work on
485 ;; free-standing strings, apparently.
488 ;; already existing bookmark under that name and
489 ;; 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 ;; Added by db
509 "Return the record describing the location of a new bookmark.
510 Must be at the correct position in the buffer in which the bookmark is
511 being set (this might change someday)."
518 nil))
524 nil))
527 \f
528 ;;; File format stuff
530 ;; The OLD format of the bookmark-alist was:
531 ;;
532 ;; ((BOOKMARK-NAME . (FILENAME
533 ;; STRING-IN-FRONT
534 ;; STRING-BEHIND
535 ;; POINT))
536 ;; ...)
537 ;;
538 ;; The NEW format of the bookmark-alist is:
539 ;;
540 ;; ((BOOKMARK-NAME (filename . FILENAME)
541 ;; (front-context-string . STRING-IN-FRONT)
542 ;; (rear-context-string . STRING-BEHIND)
543 ;; (position . POINT)
544 ;; (annotation . ANNOTATION)
545 ;; (whatever . VALUE)
546 ;; ...
547 ;; ))
548 ;; ...)
549 ;;
550 ;;
551 ;; I switched to using an internal as well as external alist because I
552 ;; felt that would be a more flexible framework in which to add
553 ;; features. It means that the order in which values appear doesn't
554 ;; matter, and it means that arbitrary values can be added without
555 ;; risk of interfering with existing ones.
556 ;;
557 ;; BOOKMARK-NAME is the string the user gives the bookmark and
558 ;; accesses it by from then on.
559 ;;
560 ;; FILENAME is the location of the file in which the bookmark is set.
561 ;;
562 ;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
563 ;; context in front of the point at which the bookmark is set.
564 ;;
565 ;; STRING-BEHIND is the same thing, but after the point.
566 ;;
567 ;; The context strings exist so that modifications to a file don't
568 ;; necessarily cause a bookmark's position to be invalidated.
569 ;; bookmark-jump will search for STRING-BEHIND and STRING-IN-FRONT in
570 ;; case the file has changed since the bookmark was set. It will
571 ;; attempt to place the user before the changes, if there were any.
572 ;; ANNOTATION is the annotation for the bookmark; it may not exist
573 ;; (for backward compatibility), be nil (no annotation), or be a
574 ;; string.
578 "The current version of the format used by bookmark files.
588 "Return a `bookmark-alist' (in any format) from the current buffer.
589 The buffer must of course contain bookmark format information.
590 Does not care from where in the buffer it is called, and does not
591 affect point."
596 ;; Else we're dealing with format version 0
601 ;; Else no hope of getting information here.
606 "Upgrade a version 0 alist OLD-LIST to the current version."
617 name
623 old-list))
627 "Upgrade a bookmark file of format 0 (the original format) to format 1.
628 This expects to be called from `point-min' in a bookmark file."
630 bookmark-file-format-version)
639 bookmark-file-format-version)
640 )
644 "Return an integer which is the file-format version of this bookmark file.
645 This expects to be called from `point-min' in a bookmark file."
652 ;; Else this is format version 0, the original one, which didn't
653 ;; even have version stamps.
658 "Check the file-format version of this bookmark file.
659 If the version is not up-to-date, upgrade it automatically.
660 This expects to be called from `point-min' in a bookmark file."
672 "Insert text indicating current version of bookmark file format."
675 bookmark-file-format-version))
678 ";;; "
679 bookmark-end-of-version-stamp-marker))
682 ;;; end file-format stuff
684 \f
685 ;;; Generic helpers.
688 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
692 \f
693 ;;; Core code:
699 ;; This C-u binding might not be very useful any more now that we
700 ;; provide access to the default via the standard M-n binding.
701 ;; Maybe we should just remove it? --Stef-08
703 map))
705 ;;;###autoload
707 "Set a bookmark named NAME inside a file.
708 If name is nil, then the user will be prompted.
709 With prefix arg, will not overwrite a bookmark that has the same name
711 the new bookmark onto the bookmark alist. Thus the most recently set
712 bookmark with name NAME would be the one in effect at any given time,
713 but the others are still there, should you decide to delete the most
714 recent one.
716 To yank words from the text of the buffer and use them as part of the
717 bookmark name, type C-w while setting a bookmark. Successive C-w's
718 yank successive words.
720 Typing C-u inserts the name of the last bookmark used in the buffer
721 \(as an aid in using a single bookmark name to track your progress
722 through a large file\). If no bookmark was used, then C-u inserts the
723 name of the file being visited.
726 and it removes only the first instance of a bookmark with that name from
727 the list of bookmarks.\)"
742 nil
743 bookmark-minibuffer-read-name-map
744 nil nil default))))
748 ;; Ask for an annotation buffer for this bookmark
754 "Kill from point to end of line.
755 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
756 Does not affect the kill ring."
763 ;; Defvars to avoid compilation warnings:
765 "Variable holding the name of the bookmark.
766 This is used in `bookmark-edit-annotation' to record the bookmark
780 "Function to return default text to use for a bookmark annotation.
789 map)
794 "Mode for editing the annotation of bookmark BOOKMARK.
813 "Use buffer contents as annotation for a bookmark.
814 Lines beginning with `#' are ignored."
823 ;; Take no chances with text properties.
833 "Pop up a buffer for editing bookmark BOOKMARK's annotation."
839 "Insert this buffer's value of `bookmark-current-bookmark'.
840 Default to file name if it's nil."
850 "Return the name of the current buffer's file, non-directory."
852 ;; Or are we a file?
854 ;; Or are we a directory?
857 dired-directory
860 ;; Strip the trailing slash.
863 ;; Else return the current-buffer
865 ;; If all else fails, use the buffer's name.
872 ;; get the next word from the buffer and append it to the name of
873 ;; the bookmark currently being set.
885 "Return the current buffer's file in a way useful for bookmarks."
888 ;; Abbreviate the path, both so it's shorter and so it's more
889 ;; portable. E.g., the user's home dir might be a different
890 ;; path on different machines, but "~/" will still reach it.
894 dired-directory
904 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
905 ;; to be renamed.
910 ;; return t so the `and' will continue...
911 t)
919 ;;Return the bookmark-alist for display. If the bookmark-sort-flag
920 ;;is non-nil, then return a sorted copy of the alist.
925 bookmark-alist))
929 "Hook run after `bookmark-jump' jumps to a bookmark.
932 ;;;###autoload
934 "Jump to bookmark BOOKMARK (a point in some file).
935 You may have a problem using this function if the value of variable
936 `bookmark-alist' is nil. If that happens, you need to load in some
937 bookmarks. See help on function `bookmark-load' for more about
938 this.
940 If the file pointed to by BOOKMARK no longer exists, you will be asked
941 if you wish to give the bookmark a new location, and `bookmark-jump'
942 will then jump to the new location, as well as recording it in place
943 of the old one in the permanent bookmark record."
946 bookmark-current-bookmark)))
956 ;; if there is an annotation for this bookmark,
957 ;; show it in a buffer.
961 ;;;###autoload
963 "Jump to BOOKMARK (a point in some file) in another window.
964 See `bookmark-jump'."
967 bookmark-current-bookmark)))
977 ;; if there is an annotation for this bookmark,
978 ;; show it in a buffer.
983 "Return FILE (a string) if it exists, or return a reasonable
984 variation of FILE if that exists. Reasonable variations are checked
985 by appending suffixes defined in `Info-suffix-list'. If cannot find FILE
986 nor a reasonable variation thereof, then still return FILE if it can
987 be retrieved from a VC backend, else return nil."
989 file
997 Info-suffix-list)
998 nil))
999 ;; Last possibility: try VC
1003 "Call BOOKMARK's handler or `bookmark-default-handler' if it has none."
1006 bookmark)))
1008 ;; Else unable to find the marked file, so ask if user wants to
1009 ;; relocate the bookmark, else remind them to consider deletion.
1016 bookmark
1020 ;; Try again.
1023 bookmark)))
1027 ;; Added by db.
1029 found)))
1032 ;; Helper for bookmark-jump. STR is a bookmark name, of the sort
1033 ;; accepted by `bookmark-get-bookmark'.
1034 ;;
1035 ;; Return an alist '((buffer BUFFER) (position POSITION) ...)
1036 ;; indicating the bookmarked point within the specied buffer. Any
1037 ;; elements not documented here should be ignored.
1043 ;; FIXME: bookmark-file-or-variation-thereof was needed for Info files,
1044 ;; but now that Info bookmarks are handled elsewhere it seems that we
1045 ;; should be able to get rid of it. --Stef
1050 ;; Go searching forward first. Then, if forward-str exists and
1051 ;; was found in the file, we can search backward for behind-str.
1052 ;; Rationale is that if text was inserted between the two in the
1053 ;; file, it's better to be put before it so you can read it,
1054 ;; rather than after and remain perhaps unaware of the changes.
1064 ;;;###autoload
1066 "Relocate BOOKMARK to another file (reading file name with minibuffer).
1067 This makes an already existing bookmark point to that file, instead of
1068 the one it used to point at. Useful when a file has been renamed
1069 after a bookmark was set in it."
1082 ;;;###autoload
1084 "Insert the name of the file associated with BOOKMARK.
1085 Optional second arg NO-HISTORY means don't record this in the
1086 minibuffer history list `bookmark-history'."
1094 start
1099 follow-link t
1102 ;;;###autoload
1106 "Return the name of the file associated with BOOKMARK."
1111 ;;;###autoload
1113 "Change the name of OLD bookmark to NEW name.
1114 If called from keyboard, prompt for OLD and NEW. If called from
1115 menubar, select OLD from a menu and prompt for NEW.
1117 If called from Lisp, prompt for NEW if only OLD was passed as an
1118 argument. If called with two strings, then no prompting is done. You
1119 must pass at least OLD when calling from Lisp.
1121 While you are entering the new name, consecutive C-w's insert
1122 consecutive words from the text of the buffer into the new bookmark
1123 name."
1134 "New name: "
1135 nil
1138 now-map)
1139 nil
1150 ;;;###autoload
1152 "Insert the text of the file pointed to by bookmark BOOKMARK.
1153 You may have a problem using this function if the value of variable
1154 `bookmark-alist' is nil. If that happens, you need to load in some
1155 bookmarks. See help on function `bookmark-load' for more about
1156 this."
1170 ;;;###autoload
1172 "Delete BOOKMARK from the bookmark list.
1173 Removes only the first instance of a bookmark with that name. If
1174 there are one or more other bookmarks with the same name, they will
1176 one most recently used in this file, if any\).
1177 Optional second arg BATCH means don't update the bookmark list buffer,
1178 probably because we were called from there."
1181 bookmark-current-bookmark)))
1186 ;; Added by db, nil bookmark-current-bookmark if the last
1187 ;; occurrence has been deleted
1190 ;; Don't rebuild the list
1192 nil
1201 ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu>
1202 ;; finds out whether it's time to save bookmarks to a file, by
1203 ;; examining the value of variable bookmark-save-flag, and maybe
1204 ;; bookmark-alist-modification-count. Returns t if they should be
1205 ;; saved, nil otherwise. if last-time is non-nil, then this is
1206 ;; being called when emacs is killed.
1209 bookmark-save-flag))
1213 nil)))
1216 ;;;###autoload
1218 "Write bookmarks to a file (reading the file name with the minibuffer).
1219 Don't use this in Lisp programs; use `bookmark-save' instead."
1225 ;;;###autoload
1227 "Save currently defined bookmarks.
1228 Saves by default in the file defined by the variable
1229 `bookmark-default-file'. With a prefix arg, save it in file FILE
1230 \(second argument\).
1232 If you are calling this from Lisp, the two arguments are PARG and
1233 FILE, and if you just want it to write to the default file, then
1234 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1235 instead. If you pass in one argument, and it is non-nil, then the
1236 user will be interactively queried for a file to save in.
1238 When you want to load in the bookmarks from a file, use
1240 for a file, defaulting to the file defined by variable
1241 `bookmark-default-file'."
1246 ;;whether interactive or not, write to default file
1249 ;;whether interactive or not, write to given file
1252 ;;have been called interactively w/ prefix arg
1257 ;; signal that we have synced the bookmark file by setting this to
1258 ;; 0. If there was an error at any point before, it will not get
1259 ;; set, which is what we want.
1263 \f
1281 t))))
1291 ;; Walk over the new list, adding each individual bookmark
1292 ;; carefully. "Carefully" means checking against the existing
1293 ;; bookmark-alist and renaming the new bookmarks with <N> extensions
1294 ;; as necessary.
1306 ;; just a helper for bookmark-import-new-list; it is only for
1307 ;; readability that this is not inlined.
1308 ;;
1309 ;; Once this has found a free name, it sets full-record to that
1310 ;; name.
1313 ;; We've got a conflict, so generate a new name
1322 ;;;###autoload
1324 "Load bookmarks from FILE (which must be in bookmark format).
1325 Appends loaded bookmarks to the front of the list of bookmarks. If
1326 optional second argument OVERWRITE is non-nil, existing bookmarks are
1327 destroyed. Optional third arg NO-MSG means don't display any messages
1328 while loading.
1330 If you load a file that doesn't contain a proper bookmark alist, you
1331 will corrupt Emacs's bookmark list. Generally, you should only load
1332 in files that were created with the bookmark functions in the first
1333 place. Your own personal bookmark file, `~/.emacs.bmk', is
1334 maintained automatically by Emacs; you shouldn't need to load it
1335 explicitly.
1337 If you load a file containing bookmarks with the same names as
1338 bookmarks already present in your Emacs, the new bookmarks will get
1340 method buffers use to resolve name collisions."
1344 bookmark-default-file)
1345 ;;Default might not be used often,
1346 ;;but there's no better default, and
1347 ;;I guess it's better than none at all.
1366 ;; else
1372 file)
1382 \f
1383 ;;; Code supporting the dired-like bookmark menu. Prefix is
1384 ;;; "bookmark-bmenu" for "buffer-menu":
1397 nil
1436 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1437 ;; data.
1441 ;; todo: need to display whether or not bookmark exists as a buffer in
1442 ;; flag column.
1444 ;; Format:
1445 ;; FLAGS BOOKMARK [ LOCATION ]
1449 "Rebuild the Bookmark List if it exists.
1450 Don't affect the buffer ring order."
1457 ;;;###autoload
1459 "Display a list of existing bookmarks.
1460 The list is displayed in a buffer named `*Bookmark List*'.
1461 The leftmost column displays a D if the bookmark is flagged for
1462 deletion, or > if it is flagged for displaying."
1475 ;; if a bookmark has an annotation, prepend a "*"
1476 ;; in the list of bookmarks.
1486 start
1491 follow-link t
1494 )))
1502 ;;;###autoload
1504 ;;;###autoload
1510 "Major mode for editing a list of bookmarks.
1511 Each line describes one of the bookmarks in Emacs.
1512 Letters do not insert themselves; instead, they are commands.
1517 Also show bookmarks marked using m in other windows.
1518 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1522 together with bookmark selected before this one in another window.
1525 so the bookmark menu bookmark remains visible in its window.
1531 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1533 With a prefix arg, prompts for a file to save in.
1536 With prefix argument, also move up one line.
1538 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1539 in another buffer.
1540 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1552 "Toggle whether filenames are shown in the bookmark list.
1553 Optional argument SHOW means show them unconditionally."
1570 nil ;already shown, so do nothing
1583 ;; Strip off `mouse-face' from the white spaces region.
1589 ;; Pass the NO-HISTORY arg:
1596 ;; nothing to hide if above is nil
1617 start
1622 follow-link t
1623 help-echo
1631 ;; Returns non-nil if on a line with a bookmark.
1632 ;; (The actual value returned is bookmark-alist).
1633 ;; Else reposition and try again, else return nil.
1637 bookmark-alist)
1640 bookmark-alist)
1642 bookmark-alist)))
1646 ;; return a string which is bookmark of this line.
1665 ;; well, this is certainly crystal-clear:
1671 "Display the annotation for bookmark named BOOKMARK in a buffer,
1672 if an annotation exists."
1679 ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n"))
1686 "Display the annotations for all bookmarks in a buffer."
1696 ;; insert the annotation, indented by 4 spaces.
1705 bookmark-alist)
1711 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1723 "Select this line's bookmark; also display bookmarks marked with `>'.
1730 tem)
1755 "Save the current list into a bookmark file.
1756 With a prefix arg, prompts for a file to save them in."
1764 "Load the bookmark file and rebuild the bookmark menu-buffer."
1769 ;; This will call `bookmark-bmenu-list'
1774 "Select this line's bookmark, alone, in full frame."
1784 "Select this line's bookmark, with previous buffer in second window."
1801 "Select this line's bookmark in this window."
1808 "Select this line's bookmark in other window, leaving bookmark menu visible."
1822 "Make the other window select this line's bookmark.
1823 The current window remains selected."
1827 same-window-buffer-names
1828 same-window-regexps)
1835 ;; save-excursion won't do
1843 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1853 "Show the annotation for the current bookmark in another window."
1861 "Show the annotation for all bookmarks in another window."
1867 "Edit the annotation for the current bookmark in another window."
1875 "Cancel all requested operations on bookmark on this line and move down.
1876 Optional BACKUP means move up."
1883 ;; any flags to reset according to circumstances? How about a
1884 ;; flag indicating whether this bookmark is being visited?
1885 ;; well, we don't have this now, so maybe later.
1892 "Move up and cancel all requested operations on bookmark on line above."
1903 "Mark bookmark on this line to be deleted.
1904 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1916 "Mark bookmark on this line to be deleted, then move up one line.
1917 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1935 nil
1963 ))
1967 "Rename bookmark on current line. Prompts for a new name."
1978 "Display location of this bookmark. Displays in the minibuffer."
1985 "Change the file path of the bookmark on the current line,
1986 prompting with completion for the new path."
1994 \f
1995 ;;; Menu bar stuff. Prefix is "bookmark-menu".
1998 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
1999 That is, ENTRIES is a list of strings which appear as the choices
2000 in the menu.
2001 The number of panes depends on the number of entries.
2002 The visible entries are truncated to `bookmark-menu-length', but the
2003 strings returned are not."
2015 str)
2016 str)
2017 lst)
2024 pane-list)))
2026 ;; Popup the menu and return the string.
2031 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2032 ;; following works, and for explaining what to do to make it work.
2034 ;; We MUST autoload EACH form used to set up this variable's value, so
2035 ;; that the whole job is done in loaddefs.el.
2037 ;; Emacs menubar stuff.
2039 ;;;###autoload
2043 (define-key map [write] '("Save Bookmarks As..." . bookmark-write))
2044 (define-key map [save] '("Save Bookmarks" . bookmark-save))
2045 (define-key map [edit] '("Edit Bookmark List" . bookmark-bmenu-list))
2046 (define-key map [delete] '("Delete Bookmark..." . bookmark-delete))
2047 (define-key map [rename] '("Rename Bookmark..." . bookmark-rename))
2048 (define-key map [locate] '("Insert Location..." . bookmark-locate))
2049 (define-key map [insert] '("Insert Contents..." . bookmark-insert))
2050 (define-key map [set] '("Set Bookmark..." . bookmark-set))
2051 (define-key map [jump] '("Jump to Bookmark..." . bookmark-jump))
2052 map))
2054 ;;;###autoload
2055 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2057 ;; make bookmarks appear toward the right side of the menu.
2058 (if (boundp 'menu-bar-final-items)
2059 (if menu-bar-final-items
2060 (setq menu-bar-final-items
2061 (cons 'bookmark menu-bar-final-items)))
2062 (setq menu-bar-final-items '(bookmark)))
2064 ;;;; end bookmark menu stuff ;;;;
2066 \f
2067 ;;; Load Hook
2068 (defvar bookmark-load-hook nil
2069 "Hook run at the end of loading bookmark.")
2071 ;;; Exit Hook, called from kill-emacs-hook
2072 (defvar bookmark-exit-hook nil
2073 "Hook run when Emacs exits.")
2075 (define-obsolete-variable-alias 'bookmark-exit-hooks 'bookmark-exit-hook "22.1")
2077 (defun bookmark-exit-hook-internal ()
2078 "Save bookmark state, if necessary, at Emacs exit time.
2079 This also runs `bookmark-exit-hook'."
2080 (run-hooks 'bookmark-exit-hook)
2081 (and bookmark-alist
2082 (bookmark-time-to-save-p t)
2083 (bookmark-save)))
2085 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal)
2088 (run-hooks 'bookmark-load-hook)
2090 (provide 'bookmark)
2092 ;; arch-tag: 139f519a-dd0c-4b8d-8b5d-f9fcf53ca8f6
2093 ;;; bookmark.el ends here