| blob | 7a3e4d9a12a35c1026ac7d630a97b5aa21246cf1 |
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 \f
253 ;;; Core variables and data structures:
255 "Association list of bookmarks and their records.
256 You probably don't want to change the value of this alist yourself;
257 instead, let the various bookmark functions do it for you.
259 The format of the alist is
261 \(BOOKMARK1 BOOKMARK2 ...\)
263 where each BOOKMARK is typically of the form
265 \(NAME
266 (filename . FILE)
267 (front-context-string . FRONT-STR)
268 (rear-context-string . REAR-STR)
269 (position . POS)
270 (annotation . ANNOTATION))
278 ;; more stuff added by db.
281 "Name of bookmark most recently used in the current file.
282 It is buffer local, used to make moving a bookmark forward
301 \f
302 ;; Helper functions.
304 ;; Only functions on this page and the next one (file formats) need to
305 ;; know anything about the format of bookmark-alist entries.
306 ;; Everyone else should go through them.
310 "Return name of FULL-RECORD \(an alist element instead of a string\)."
315 "Return a list of all current bookmark names."
320 bookmark-alist))
324 "Return the full entry for BOOKMARK in `bookmark-alist'.
325 If BOOKMARK is not a string, return nil."
331 "Return the guts of the entry for BOOKMARK in `bookmark-alist'.
332 That is, all information but the name."
337 "Set BOOKMARK's name to NEWNAME."
340 newname))
343 "Return the property PROP of BOOKMARK, or nil if none."
347 "Set the property PROP of BOOKMARK to VAL."
355 "Return the annotation of BOOKMARK, or nil if none."
359 "Set the annotation of BOOKMARK to ANN."
364 "Return the full filename of BOOKMARK."
369 "Set the full filename of BOOKMARK to FILENAME."
378 "Return the position \(i.e.: point\) of BOOKMARK."
383 "Set the position \(i.e.: point\) of BOOKMARK to POSITION."
388 "Return the front-context-string of BOOKMARK."
393 "Set the front-context-string of BOOKMARK to STRING."
398 "Return the rear-context-string of BOOKMARK."
403 "Set the rear-context-string of BOOKMARK to STRING."
415 "Prompting with PROMPT, read a bookmark name in completion.
417 probably don't want to include one yourself.
418 Optional second arg DEFAULT is a string to return if the user enters
419 the empty string."
430 bookmark-alist
431 nil
432 0
433 nil
439 "Put STRING into the bookmark prompt history, if caller non-interactive.
440 We need this because sometimes bookmark functions are invoked from
441 menus, so `completing-read' never gets a chance to set `bookmark-history'."
447 "A function that should be called to create a bookmark record.
448 Modes may set this variable buffer-locally to enable bookmarking of
449 locations that should be treated specially, such as Info nodes,
450 news posts, images, pdf documents, etc.
452 The function will be called with no arguments.
454 The returned record should be a cons cell of the form (NAME . ALIST)
455 where ALIST is as described in `bookmark-alist' and may typically contain
456 a special cons (handler . SOME-FUNCTION) which sets the handler function
457 that should be used to open this bookmark instead of
458 `bookmark-default-handler'. The handler should return an alist like the
459 one that function returns, and (of course) should likewise
460 not select the buffer.
461 It should signal a user error if it is unable to construct a record for the current
462 location.
464 NAME is a suggested name for the constructed bookmark. It can be nil
468 "Return a new bookmark record (NAME . ALIST) for the current location."
470 ;; Set up default name.
472 ;; The function already provided a default name.
473 record
476 record)))
479 "Store the bookmark NAME with data ALIST.
480 If NO-OVERWRITE is non-nil and another bookmark of the same name already
481 exists in `bookmark-alist', record the new bookmark without throwing away the
482 old one."
486 ;; XEmacs's `set-text-properties' doesn't work on
487 ;; free-standing strings, apparently.
490 ;; already existing bookmark under that name and
491 ;; no prefix arg means just overwrite old bookmark
494 ;; otherwise just cons it onto the front (either the bookmark
495 ;; doesn't exist already, or there is no prefix arg. In either
496 ;; case, we want the new bookmark consed onto the alist...)
500 ;; Added by db
511 "Return the record describing the location of a new bookmark.
512 Must be at the correct position in the buffer in which the bookmark is
513 being set (this might change someday)."
520 nil))
526 nil))
529 \f
530 ;;; File format stuff
532 ;; The OLD format of the bookmark-alist was:
533 ;;
534 ;; ((BOOKMARK-NAME . (FILENAME
535 ;; STRING-IN-FRONT
536 ;; STRING-BEHIND
537 ;; POINT))
538 ;; ...)
539 ;;
540 ;; The NEW format of the bookmark-alist is:
541 ;;
542 ;; ((BOOKMARK-NAME (filename . FILENAME)
543 ;; (front-context-string . STRING-IN-FRONT)
544 ;; (rear-context-string . STRING-BEHIND)
545 ;; (position . POINT)
546 ;; (annotation . ANNOTATION)
547 ;; (whatever . VALUE)
548 ;; ...
549 ;; ))
550 ;; ...)
551 ;;
552 ;;
553 ;; I switched to using an internal as well as external alist because I
554 ;; felt that would be a more flexible framework in which to add
555 ;; features. It means that the order in which values appear doesn't
556 ;; matter, and it means that arbitrary values can be added without
557 ;; risk of interfering with existing ones.
558 ;;
559 ;; BOOKMARK-NAME is the string the user gives the bookmark and
560 ;; accesses it by from then on.
561 ;;
562 ;; FILENAME is the location of the file in which the bookmark is set.
563 ;;
564 ;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
565 ;; context in front of the point at which the bookmark is set.
566 ;;
567 ;; STRING-BEHIND is the same thing, but after the point.
568 ;;
569 ;; The context strings exist so that modifications to a file don't
570 ;; necessarily cause a bookmark's position to be invalidated.
571 ;; bookmark-jump will search for STRING-BEHIND and STRING-IN-FRONT in
572 ;; case the file has changed since the bookmark was set. It will
573 ;; attempt to place the user before the changes, if there were any.
574 ;; ANNOTATION is the annotation for the bookmark; it may not exist
575 ;; (for backward compatibility), be nil (no annotation), or be a
576 ;; string.
580 "The current version of the format used by bookmark files.
590 "Return a `bookmark-alist' (in any format) from the current buffer.
591 The buffer must of course contain bookmark format information.
592 Does not care from where in the buffer it is called, and does not
593 affect point."
598 ;; Else we're dealing with format version 0
603 ;; Else no hope of getting information here.
608 "Upgrade a version 0 alist OLD-LIST to the current version."
619 name
625 old-list))
629 "Upgrade a bookmark file of format 0 (the original format) to format 1.
630 This expects to be called from `point-min' in a bookmark file."
632 bookmark-file-format-version)
641 bookmark-file-format-version)
642 )
646 "Return an integer which is the file-format version of this bookmark file.
647 This expects to be called from `point-min' in a bookmark file."
654 ;; Else this is format version 0, the original one, which didn't
655 ;; even have version stamps.
660 "Check the file-format version of this bookmark file.
661 If the version is not up-to-date, upgrade it automatically.
662 This expects to be called from `point-min' in a bookmark file."
674 "Insert text indicating current version of bookmark file format."
677 bookmark-file-format-version))
680 ";;; "
681 bookmark-end-of-version-stamp-marker))
684 ;;; end file-format stuff
686 \f
687 ;;; Generic helpers.
690 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
694 \f
695 ;;; Core code:
701 ;; This C-u binding might not be very useful any more now that we
702 ;; provide access to the default via the standard M-n binding.
703 ;; Maybe we should just remove it? --Stef-08
705 map))
707 ;;;###autoload
709 "Set a bookmark named NAME inside a file.
710 If name is nil, then the user will be prompted.
711 With prefix arg, will not overwrite a bookmark that has the same name
713 the new bookmark onto the bookmark alist. Thus the most recently set
714 bookmark with name NAME would be the one in effect at any given time,
715 but the others are still there, should you decide to delete the most
716 recent one.
718 To yank words from the text of the buffer and use them as part of the
719 bookmark name, type C-w while setting a bookmark. Successive C-w's
720 yank successive words.
722 Typing C-u inserts the name of the last bookmark used in the buffer
723 \(as an aid in using a single bookmark name to track your progress
724 through a large file\). If no bookmark was used, then C-u inserts the
725 name of the file being visited.
728 and it removes only the first instance of a bookmark with that name from
729 the list of bookmarks.\)"
744 nil
745 bookmark-minibuffer-read-name-map
746 nil nil default))))
750 ;; Ask for an annotation buffer for this bookmark
756 "Kill from point to end of line.
757 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
758 Does not affect the kill ring."
765 ;; Defvars to avoid compilation warnings:
767 "Variable holding the name of the bookmark.
768 This is used in `bookmark-edit-annotation' to record the bookmark
782 "Function to return default text to use for a bookmark annotation.
791 map)
796 "Mode for editing the annotation of bookmark BOOKMARK.
815 "Use buffer contents as annotation for a bookmark.
816 Lines beginning with `#' are ignored."
825 ;; Take no chances with text properties.
835 "Pop up a buffer for editing bookmark BOOKMARK's annotation."
841 "Insert this buffer's value of `bookmark-current-bookmark'.
842 Default to file name if it's nil."
852 "Return the name of the current buffer's file, non-directory."
854 ;; Or are we a file?
856 ;; Or are we a directory?
859 dired-directory
862 ;; Strip the trailing slash.
865 ;; Else return the current-buffer
867 ;; If all else fails, use the buffer's name.
874 ;; get the next word from the buffer and append it to the name of
875 ;; the bookmark currently being set.
887 "Return the current buffer's file in a way useful for bookmarks."
890 ;; Abbreviate the path, both so it's shorter and so it's more
891 ;; portable. E.g., the user's home dir might be a different
892 ;; path on different machines, but "~/" will still reach it.
896 dired-directory
906 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
907 ;; to be renamed.
912 ;; return t so the `and' will continue...
913 t)
921 ;;Return the bookmark-alist for display. If the bookmark-sort-flag
922 ;;is non-nil, then return a sorted copy of the alist.
927 bookmark-alist))
931 "Hook run after `bookmark-jump' jumps to a bookmark.
934 ;;;###autoload
936 "Jump to bookmark BOOKMARK (a point in some file).
937 You may have a problem using this function if the value of variable
938 `bookmark-alist' is nil. If that happens, you need to load in some
939 bookmarks. See help on function `bookmark-load' for more about
940 this.
942 If the file pointed to by BOOKMARK no longer exists, you will be asked
943 if you wish to give the bookmark a new location, and `bookmark-jump'
944 will then jump to the new location, as well as recording it in place
945 of the old one in the permanent bookmark record."
948 bookmark-current-bookmark)))
958 ;; if there is an annotation for this bookmark,
959 ;; show it in a buffer.
963 ;;;###autoload
965 "Jump to BOOKMARK (a point in some file) in another window.
966 See `bookmark-jump'."
969 bookmark-current-bookmark)))
979 ;; if there is an annotation for this bookmark,
980 ;; show it in a buffer.
985 "Return FILE (a string) if it exists, or return a reasonable
986 variation of FILE if that exists. Reasonable variations are checked
987 by appending suffixes defined in `Info-suffix-list'. If cannot find FILE
988 nor a reasonable variation thereof, then still return FILE if it can
989 be retrieved from a VC backend, else return nil."
991 file
999 Info-suffix-list)
1000 nil))
1001 ;; Last possibility: try VC
1005 "Call BOOKMARK's handler or `bookmark-default-handler' if it has none."
1008 bookmark)))
1010 ;; Else unable to find the marked file, so ask if user wants to
1011 ;; relocate the bookmark, else remind them to consider deletion.
1018 bookmark
1022 ;; Try again.
1025 bookmark)))
1029 ;; Added by db.
1031 found)))
1034 ;; Helper for bookmark-jump. STR is a bookmark name, of the sort
1035 ;; accepted by `bookmark-get-bookmark'.
1036 ;;
1037 ;; Return an alist '((buffer BUFFER) (position POSITION) ...)
1038 ;; indicating the bookmarked point within the specied buffer. Any
1039 ;; elements not documented here should be ignored.
1045 ;; FIXME: bookmark-file-or-variation-thereof was needed for Info files,
1046 ;; but now that Info bookmarks are handled elsewhere it seems that we
1047 ;; should be able to get rid of it. --Stef
1052 ;; Go searching forward first. Then, if forward-str exists and
1053 ;; was found in the file, we can search backward for behind-str.
1054 ;; Rationale is that if text was inserted between the two in the
1055 ;; file, it's better to be put before it so you can read it,
1056 ;; rather than after and remain perhaps unaware of the changes.
1066 ;;;###autoload
1068 "Relocate BOOKMARK to another file (reading file name with minibuffer).
1069 This makes an already existing bookmark point to that file, instead of
1070 the one it used to point at. Useful when a file has been renamed
1071 after a bookmark was set in it."
1084 ;;;###autoload
1086 "Insert the name of the file associated with BOOKMARK.
1087 Optional second arg NO-HISTORY means don't record this in the
1088 minibuffer history list `bookmark-history'."
1096 start
1101 follow-link t
1104 ;;;###autoload
1108 "Return the name of the file associated with BOOKMARK."
1113 ;;;###autoload
1115 "Change the name of OLD bookmark to NEW name.
1116 If called from keyboard, prompt for OLD and NEW. If called from
1117 menubar, select OLD from a menu and prompt for NEW.
1119 If called from Lisp, prompt for NEW if only OLD was passed as an
1120 argument. If called with two strings, then no prompting is done. You
1121 must pass at least OLD when calling from Lisp.
1123 While you are entering the new name, consecutive C-w's insert
1124 consecutive words from the text of the buffer into the new bookmark
1125 name."
1136 "New name: "
1137 nil
1140 now-map)
1141 nil
1152 ;;;###autoload
1154 "Insert the text of the file pointed to by bookmark BOOKMARK.
1155 You may have a problem using this function if the value of variable
1156 `bookmark-alist' is nil. If that happens, you need to load in some
1157 bookmarks. See help on function `bookmark-load' for more about
1158 this."
1172 ;;;###autoload
1174 "Delete BOOKMARK from the bookmark list.
1175 Removes only the first instance of a bookmark with that name. If
1176 there are one or more other bookmarks with the same name, they will
1178 one most recently used in this file, if any\).
1179 Optional second arg BATCH means don't update the bookmark list buffer,
1180 probably because we were called from there."
1183 bookmark-current-bookmark)))
1188 ;; Added by db, nil bookmark-current-bookmark if the last
1189 ;; occurrence has been deleted
1192 ;; Don't rebuild the list
1194 nil
1203 ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu>
1204 ;; finds out whether it's time to save bookmarks to a file, by
1205 ;; examining the value of variable bookmark-save-flag, and maybe
1206 ;; bookmark-alist-modification-count. Returns t if they should be
1207 ;; saved, nil otherwise. if last-time is non-nil, then this is
1208 ;; being called when emacs is killed.
1211 bookmark-save-flag))
1215 nil)))
1218 ;;;###autoload
1220 "Write bookmarks to a file (reading the file name with the minibuffer).
1221 Don't use this in Lisp programs; use `bookmark-save' instead."
1227 ;;;###autoload
1229 "Save currently defined bookmarks.
1230 Saves by default in the file defined by the variable
1231 `bookmark-default-file'. With a prefix arg, save it in file FILE
1232 \(second argument\).
1234 If you are calling this from Lisp, the two arguments are PARG and
1235 FILE, and if you just want it to write to the default file, then
1236 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1237 instead. If you pass in one argument, and it is non-nil, then the
1238 user will be interactively queried for a file to save in.
1240 When you want to load in the bookmarks from a file, use
1242 for a file, defaulting to the file defined by variable
1243 `bookmark-default-file'."
1248 ;;whether interactive or not, write to default file
1251 ;;whether interactive or not, write to given file
1254 ;;have been called interactively w/ prefix arg
1259 ;; signal that we have synced the bookmark file by setting this to
1260 ;; 0. If there was an error at any point before, it will not get
1261 ;; set, which is what we want.
1265 \f
1283 t))))
1293 ;; Walk over the new list, adding each individual bookmark
1294 ;; carefully. "Carefully" means checking against the existing
1295 ;; bookmark-alist and renaming the new bookmarks with <N> extensions
1296 ;; as necessary.
1308 ;; just a helper for bookmark-import-new-list; it is only for
1309 ;; readability that this is not inlined.
1310 ;;
1311 ;; Once this has found a free name, it sets full-record to that
1312 ;; name.
1315 ;; We've got a conflict, so generate a new name
1324 ;;;###autoload
1326 "Load bookmarks from FILE (which must be in bookmark format).
1327 Appends loaded bookmarks to the front of the list of bookmarks. If
1328 optional second argument OVERWRITE is non-nil, existing bookmarks are
1329 destroyed. Optional third arg NO-MSG means don't display any messages
1330 while loading.
1332 If you load a file that doesn't contain a proper bookmark alist, you
1333 will corrupt Emacs's bookmark list. Generally, you should only load
1334 in files that were created with the bookmark functions in the first
1335 place. Your own personal bookmark file, `~/.emacs.bmk', is
1336 maintained automatically by Emacs; you shouldn't need to load it
1337 explicitly.
1339 If you load a file containing bookmarks with the same names as
1340 bookmarks already present in your Emacs, the new bookmarks will get
1342 method buffers use to resolve name collisions."
1346 bookmark-default-file)
1347 ;;Default might not be used often,
1348 ;;but there's no better default, and
1349 ;;I guess it's better than none at all.
1368 ;; else
1374 file)
1384 \f
1385 ;;; Code supporting the dired-like bookmark menu. Prefix is
1386 ;;; "bookmark-bmenu" for "buffer-menu":
1399 nil
1438 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1439 ;; data.
1443 ;; todo: need to display whether or not bookmark exists as a buffer in
1444 ;; flag column.
1446 ;; Format:
1447 ;; FLAGS BOOKMARK [ LOCATION ]
1451 "Rebuild the Bookmark List if it exists.
1452 Don't affect the buffer ring order."
1459 ;;;###autoload
1461 "Display a list of existing bookmarks.
1462 The list is displayed in a buffer named `*Bookmark List*'.
1463 The leftmost column displays a D if the bookmark is flagged for
1464 deletion, or > if it is flagged for displaying."
1477 ;; if a bookmark has an annotation, prepend a "*"
1478 ;; in the list of bookmarks.
1488 start
1493 follow-link t
1496 )))
1504 ;;;###autoload
1506 ;;;###autoload
1512 "Major mode for editing a list of bookmarks.
1513 Each line describes one of the bookmarks in Emacs.
1514 Letters do not insert themselves; instead, they are commands.
1519 Also show bookmarks marked using m in other windows.
1520 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1524 together with bookmark selected before this one in another window.
1527 so the bookmark menu bookmark remains visible in its window.
1533 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1535 With a prefix arg, prompts for a file to save in.
1538 With prefix argument, also move up one line.
1540 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1541 in another buffer.
1542 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1554 "Toggle whether filenames are shown in the bookmark list.
1555 Optional argument SHOW means show them unconditionally."
1572 nil ;already shown, so do nothing
1585 ;; Strip off `mouse-face' from the white spaces region.
1591 ;; Pass the NO-HISTORY arg:
1598 ;; nothing to hide if above is nil
1619 start
1624 follow-link t
1625 help-echo
1633 ;; Returns non-nil if on a line with a bookmark.
1634 ;; (The actual value returned is bookmark-alist).
1635 ;; Else reposition and try again, else return nil.
1639 bookmark-alist)
1642 bookmark-alist)
1644 bookmark-alist)))
1648 ;; return a string which is bookmark of this line.
1667 ;; well, this is certainly crystal-clear:
1673 "Display the annotation for bookmark named BOOKMARK in a buffer,
1674 if an annotation exists."
1681 ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n"))
1688 "Display the annotations for all bookmarks in a buffer."
1698 ;; insert the annotation, indented by 4 spaces.
1707 bookmark-alist)
1713 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1725 "Select this line's bookmark; also display bookmarks marked with `>'.
1732 tem)
1757 "Save the current list into a bookmark file.
1758 With a prefix arg, prompts for a file to save them in."
1766 "Load the bookmark file and rebuild the bookmark menu-buffer."
1771 ;; This will call `bookmark-bmenu-list'
1776 "Select this line's bookmark, alone, in full frame."
1786 "Select this line's bookmark, with previous buffer in second window."
1803 "Select this line's bookmark in this window."
1810 "Select this line's bookmark in other window, leaving bookmark menu visible."
1824 "Make the other window select this line's bookmark.
1825 The current window remains selected."
1829 same-window-buffer-names
1830 same-window-regexps)
1837 ;; save-excursion won't do
1845 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1855 "Show the annotation for the current bookmark in another window."
1863 "Show the annotation for all bookmarks in another window."
1869 "Edit the annotation for the current bookmark in another window."
1877 "Cancel all requested operations on bookmark on this line and move down.
1878 Optional BACKUP means move up."
1885 ;; any flags to reset according to circumstances? How about a
1886 ;; flag indicating whether this bookmark is being visited?
1887 ;; well, we don't have this now, so maybe later.
1894 "Move up and cancel all requested operations on bookmark on line above."
1905 "Mark bookmark on this line to be deleted.
1906 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1918 "Mark bookmark on this line to be deleted, then move up one line.
1919 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1937 nil
1965 ))
1969 "Rename bookmark on current line. Prompts for a new name."
1980 "Display location of this bookmark. Displays in the minibuffer."
1987 "Change the file path of the bookmark on the current line,
1988 prompting with completion for the new path."
1996 \f
1997 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2000 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2001 That is, ENTRIES is a list of strings which appear as the choices
2002 in the menu.
2003 The number of panes depends on the number of entries.
2004 The visible entries are truncated to `bookmark-menu-length', but the
2005 strings returned are not."
2017 str)
2018 str)
2019 lst)
2026 pane-list)))
2028 ;; Popup the menu and return the string.
2033 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2034 ;; following works, and for explaining what to do to make it work.
2036 ;; We MUST autoload EACH form used to set up this variable's value, so
2037 ;; that the whole job is done in loaddefs.el.
2039 ;; Emacs menubar stuff.
2041 ;;;###autoload
2045 (define-key map [write] '("Save Bookmarks As..." . bookmark-write))
2046 (define-key map [save] '("Save Bookmarks" . bookmark-save))
2047 (define-key map [edit] '("Edit Bookmark List" . bookmark-bmenu-list))
2048 (define-key map [delete] '("Delete Bookmark..." . bookmark-delete))
2049 (define-key map [rename] '("Rename Bookmark..." . bookmark-rename))
2050 (define-key map [locate] '("Insert Location..." . bookmark-locate))
2051 (define-key map [insert] '("Insert Contents..." . bookmark-insert))
2052 (define-key map [set] '("Set Bookmark..." . bookmark-set))
2053 (define-key map [jump] '("Jump to Bookmark..." . bookmark-jump))
2054 map))
2056 ;;;###autoload
2057 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2059 ;; make bookmarks appear toward the right side of the menu.
2060 (if (boundp 'menu-bar-final-items)
2061 (if menu-bar-final-items
2062 (setq menu-bar-final-items
2063 (cons 'bookmark menu-bar-final-items)))
2064 (setq menu-bar-final-items '(bookmark)))
2066 ;;;; end bookmark menu stuff ;;;;
2068 \f
2069 ;;; Load Hook
2070 (defvar bookmark-load-hook nil
2071 "Hook run at the end of loading bookmark.")
2073 ;;; Exit Hook, called from kill-emacs-hook
2074 (defvar bookmark-exit-hook nil
2075 "Hook run when Emacs exits.")
2077 (define-obsolete-variable-alias 'bookmark-exit-hooks 'bookmark-exit-hook "22.1")
2079 (defun bookmark-exit-hook-internal ()
2080 "Save bookmark state, if necessary, at Emacs exit time.
2081 This also runs `bookmark-exit-hook'."
2082 (run-hooks 'bookmark-exit-hook)
2083 (and bookmark-alist
2084 (bookmark-time-to-save-p t)
2085 (bookmark-save)))
2087 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal)
2090 (run-hooks 'bookmark-load-hook)
2092 (provide 'bookmark)
2094 ;; arch-tag: 139f519a-dd0c-4b8d-8b5d-f9fcf53ca8f6
2095 ;;; bookmark.el ends here