| blob | 46e3841f3374a3a73060f15e3820552cf955a342 |
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))
353 "Return the annotation of BOOKMARK, or nil if none."
358 "Set the annotation of BOOKMARK to ANN."
367 "Return the full filename of BOOKMARK."
372 "Set the full filename of BOOKMARK to FILENAME."
385 "Return the position \(i.e.: point\) of BOOKMARK."
390 "Set the position \(i.e.: point\) of BOOKMARK to POSITION."
399 "Return the front-context-string of BOOKMARK."
404 "Set the front-context-string of BOOKMARK to STRING."
414 "Return the rear-context-string of BOOKMARK."
419 "Set the rear-context-string of BOOKMARK to STRING."
436 "Prompting with PROMPT, read a bookmark name in completion.
438 probably don't want to include one yourself.
439 Optional second arg DEFAULT is a string to return if the user enters
440 the empty string."
451 bookmark-alist
452 nil
453 0
454 nil
460 "Put STRING into the bookmark prompt history, if caller non-interactive.
461 We need this because sometimes bookmark functions are invoked from
462 menus, so `completing-read' never gets a chance to set `bookmark-history'."
468 "A function that should be called to return the name of the bookmark.
469 When called with an argument, the function should return a file
470 name -- or whatever is required to jump to the location. Modes
471 may set this variable buffer-locally to enable a default name to
475 "A function that should be called to create a bookmark record.
476 Modes may set this variable buffer-locally to enable bookmarking of
477 locations that should be treated specially, such as Info nodes,
478 news posts, images, pdf documents, etc.
480 The function will be called with one argument: ANNOTATION.
481 See `bookmark-make-record-for-text-file' for a description.
483 The returned record may contain a special cons (handler . SOME-FUNCTION)
484 which sets the handler function that should be used to open this
485 bookmark instead of `bookmark-default-handler'. The handler should
486 return an alist like the one that function returns, and (of course)
490 "Make a bookmark named NAME.
491 Optional second arg ANNOTATION gives it an annotation.
492 Optional third arg OVERWRITE means replace any existing bookmarks with
493 this name."
497 ;; XEmacs's `set-text-properties' doesn't work on
498 ;; free-standing strings, apparently.
501 ;; already existing bookmark under that name and
502 ;; no prefix arg means just overwrite old bookmark
506 ;; otherwise just cons it onto the front (either the bookmark
507 ;; doesn't exist already, or there is no prefix arg. In either
508 ;; case, we want the new bookmark consed onto the alist...)
514 bookmark-alist)))
516 ;; Added by db
525 "Return the record part of a new bookmark, given ANNOTATION.
526 Must be at the correct position in the buffer in which the bookmark is
527 being set (this might change someday)."
535 nil))
541 nil))
544 ;; Now fill in the optional parts:
546 ;; Take no chances with text properties
552 ;; Finally, return the completed record.
553 the-record))
556 \f
557 ;;; File format stuff
559 ;; The OLD format of the bookmark-alist was:
560 ;;
561 ;; ((bookmark-name (filename
562 ;; string-in-front
563 ;; string-behind
564 ;; point))
565 ;; ...)
566 ;;
567 ;; The NEW format of the bookmark-alist is:
568 ;;
569 ;; ((bookmark-name ((filename . FILENAME)
570 ;; (front-context-string . string-in-front)
571 ;; (rear-context-string . string-behind)
572 ;; (position . POINT)
573 ;; (annotation . annotation)
574 ;; (whatever . VALUE)
575 ;; ...
576 ;; ))
577 ;; ...)
578 ;;
579 ;;
580 ;; I switched to using an internal as well as external alist because I
581 ;; felt that would be a more flexible framework in which to add
582 ;; features. It means that the order in which values appear doesn't
583 ;; matter, and it means that arbitrary values can be added without
584 ;; risk of interfering with existing ones.
585 ;;
586 ;; BOOKMARK-NAME is the string the user gives the bookmark and
587 ;; accesses it by from then on.
588 ;;
589 ;; FILENAME is the location of the file in which the bookmark is set.
590 ;;
591 ;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
592 ;; context in front of the point at which the bookmark is set.
593 ;;
594 ;; STRING-BEHIND is the same thing, but after the point.
595 ;;
596 ;; The context strings exist so that modifications to a file don't
597 ;; necessarily cause a bookmark's position to be invalidated.
598 ;; bookmark-jump will search for STRING-BEHIND and STRING-IN-FRONT in
599 ;; case the file has changed since the bookmark was set. It will
600 ;; attempt to place the user before the changes, if there were any.
601 ;; ANNOTATION is the annotation for the bookmark; it may not exist
602 ;; (for backward compatibility), be nil (no annotation), or be a
603 ;; string.
607 "The current version of the format used by bookmark files.
617 "Return a `bookmark-alist' (in any format) from the current buffer.
618 The buffer must of course contain bookmark format information.
619 Does not care from where in the buffer it is called, and does not
620 affect point."
625 ;; Else we're dealing with format version 0
630 ;; Else no hope of getting information here.
635 "Upgrade a version 0 alist OLD-LIST to the current version."
646 name
652 old-list))
656 "Upgrade a bookmark file of format 0 (the original format) to format 1.
657 This expects to be called from `point-min' in a bookmark file."
659 bookmark-file-format-version)
668 bookmark-file-format-version)
669 )
673 "Return an integer which is the file-format version of this bookmark file.
674 This expects to be called from `point-min' in a bookmark file."
681 ;; Else this is format version 0, the original one, which didn't
682 ;; even have version stamps.
687 "Check the file-format version of this bookmark file.
688 If the version is not up-to-date, upgrade it automatically.
689 This expects to be called from `point-min' in a bookmark file."
701 "Insert text indicating current version of bookmark file format."
704 bookmark-file-format-version))
707 ";;; "
708 bookmark-end-of-version-stamp-marker))
711 ;;; end file-format stuff
713 \f
714 ;;; Generic helpers.
717 "Apply `message' to FMT and ARGS, but only if the display is fast enough."
721 \f
722 ;;; Core code:
724 ;;;###autoload
726 "Set a bookmark named NAME inside a file.
727 If name is nil, then the user will be prompted.
728 With prefix arg, will not overwrite a bookmark that has the same name
730 the new bookmark onto the bookmark alist. Thus the most recently set
731 bookmark with name NAME would be the one in effect at any given time,
732 but the others are still there, should you decide to delete the most
733 recent one.
735 To yank words from the text of the buffer and use them as part of the
736 bookmark name, type C-w while setting a bookmark. Successive C-w's
737 yank successive words.
739 Typing C-u inserts the name of the last bookmark used in the buffer
740 \(as an aid in using a single bookmark name to track your progress
741 through a large file\). If no bookmark was used, then C-u inserts the
742 name of the file being visited.
745 and it removes only the first instance of a bookmark with that name from
746 the list of bookmarks.\)"
764 nil
768 now-map))))
771 ;; Ask for an annotation buffer for this bookmark
781 "Kill from point to end of line.
782 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
783 Does not affect the kill ring."
790 ;; Defvars to avoid compilation warnings:
799 "Use buffer contents as the annotation for a bookmark.
800 Exclude lines that begin with `#'.
801 Store the annotation text in the bookmark list with
802 the bookmark (and file, and point) specified in buffer local variables."
816 ;; for bookmark-make-record-function to work, we need to be
817 ;; in the relevant buffer, at the relevant point.
818 ;; Actually, the bookmark-make-record-function spec should
819 ;; probably be changed to avoid this need. Should I handle the
820 ;; error if a buffer is killed between "C-x r m" and a "C-c C-c"
821 ;; in the annotation buffer?
842 "Function to return default text to use for a bookmark annotation.
846 "Mode for composing annotations for a bookmark.
847 Wants BUF, POINT, PARG, and BOOKMARK.
849 the annotation.
871 "Pop up a buffer for entering a bookmark annotation.
872 Text surrounding the bookmark is PARG; the bookmark name is BOOKMARK."
888 "Mode for editing the annotation of bookmark BOOKMARK.
907 "Use buffer contents as annotation for a bookmark.
908 Lines beginning with `#' are ignored."
926 "Pop up a buffer for editing bookmark BOOKMARK's annotation."
932 "Insert this buffer's value of `bookmark-current-bookmark'.
933 Default to file name if it's nil."
938 bookmark-current-bookmark)))
943 "Insert the current file name into the bookmark name being set.
944 The directory part of the file name is not used."
954 "Return the name of the current buffer's file, non-directory.
955 In Info, return the current node."
957 ;; Is the mode defining the bookmark buffer name?
960 ;; Or are we a file?
962 ;; Or are we a directory?
965 dired-directory
968 ;; Strip the trailing slash.
971 ;; Else return the current-buffer
973 ;; If all else fails, use the buffer's name.
980 ;; get the next word from the buffer and append it to the name of
981 ;; the bookmark currently being set.
996 "Return the current buffer's file in a way useful for bookmarks.
997 For example, if this is a Info buffer, return the Info file's name."
999 ;; Return the location the handler should jump to
1000 ;; E.g. the Info file name for the Info handler
1004 ;; Abbreviate the path, both so it's shorter and so it's more
1005 ;; portable. E.g., the user's home dir might be a different
1006 ;; path on different machines, but "~/" will still reach it.
1010 dired-directory
1019 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
1020 ;; to be renamed.
1025 ;; return t so the `and' will continue...
1026 t)
1034 ;;Return the bookmark-alist for display. If the bookmark-sort-flag
1035 ;;is non-nil, then return a sorted copy of the alist.
1040 bookmark-alist))
1044 "Hook run after `bookmark-jump' jumps to a bookmark.
1047 ;;;###autoload
1049 "Jump to bookmark BOOKMARK (a point in some file).
1050 You may have a problem using this function if the value of variable
1051 `bookmark-alist' is nil. If that happens, you need to load in some
1052 bookmarks. See help on function `bookmark-load' for more about
1053 this.
1055 If the file pointed to by BOOKMARK no longer exists, you will be asked
1056 if you wish to give the bookmark a new location, and `bookmark-jump'
1057 will then jump to the new location, as well as recording it in place
1058 of the old one in the permanent bookmark record."
1061 bookmark-current-bookmark)))
1071 ;; if there is an annotation for this bookmark,
1072 ;; show it in a buffer.
1076 ;;;###autoload
1078 "Jump to BOOKMARK (a point in some file) in another window.
1079 See `bookmark-jump'."
1082 bookmark-current-bookmark)))
1092 ;; if there is an annotation for this bookmark,
1093 ;; show it in a buffer.
1098 "Return FILE (a string) if it exists, or return a reasonable
1099 variation of FILE if that exists. Reasonable variations are checked
1100 by appending suffixes defined in `Info-suffix-list'. If cannot find FILE
1101 nor a reasonable variation thereof, then still return FILE if it can
1102 be retrieved from a VC backend, else return nil."
1104 file
1112 Info-suffix-list)
1113 nil))
1114 ;; Last possibility: try VC
1118 "Call BOOKMARK's handler or `bookmark-default-handler' if it has none."
1121 bookmark)))
1123 ;; Else unable to find the marked file, so ask if user wants to
1124 ;; relocate the bookmark, else remind them to consider deletion.
1131 bookmark
1135 ;; Try again.
1138 bookmark)))
1142 ;; Added by db.
1144 found)))
1147 ;; Helper for bookmark-jump. STR is a bookmark name, of the sort
1148 ;; accepted by `bookmark-get-bookmark'.
1149 ;;
1150 ;; Return an alist '((buffer BUFFER) (position POSITION) ...)
1151 ;; indicating the bookmarked point within the specied buffer. Any
1152 ;; elements not documented here should be ignored.
1158 ;; FIXME: bookmark-file-or-variation-thereof was needed for Info files,
1159 ;; but now that Info bookmarks are handled elsewhere it seems that we
1160 ;; should be able to get rid of it. --Stef
1165 ;; Go searching forward first. Then, if forward-str exists and
1166 ;; was found in the file, we can search backward for behind-str.
1167 ;; Rationale is that if text was inserted between the two in the
1168 ;; file, it's better to be put before it so you can read it,
1169 ;; rather than after and remain perhaps unaware of the changes.
1179 ;;;###autoload
1181 "Relocate BOOKMARK to another file (reading file name with minibuffer).
1182 This makes an already existing bookmark point to that file, instead of
1183 the one it used to point at. Useful when a file has been renamed
1184 after a bookmark was set in it."
1197 ;;;###autoload
1199 "Insert the name of the file associated with BOOKMARK.
1200 Optional second arg NO-HISTORY means don't record this in the
1201 minibuffer history list `bookmark-history'."
1209 start
1214 follow-link t
1217 ;;;###autoload
1221 "Return the name of the file associated with BOOKMARK."
1226 ;;;###autoload
1228 "Change the name of OLD bookmark to NEW name.
1229 If called from keyboard, prompt for OLD and NEW. If called from
1230 menubar, select OLD from a menu and prompt for NEW.
1232 If called from Lisp, prompt for NEW if only OLD was passed as an
1233 argument. If called with two strings, then no prompting is done. You
1234 must pass at least OLD when calling from Lisp.
1236 While you are entering the new name, consecutive C-w's insert
1237 consecutive words from the text of the buffer into the new bookmark
1238 name."
1249 "New name: "
1250 nil
1253 now-map)
1254 nil
1265 ;;;###autoload
1267 "Insert the text of the file pointed to by bookmark BOOKMARK.
1268 You may have a problem using this function if the value of variable
1269 `bookmark-alist' is nil. If that happens, you need to load in some
1270 bookmarks. See help on function `bookmark-load' for more about
1271 this."
1285 ;;;###autoload
1287 "Delete BOOKMARK from the bookmark list.
1288 Removes only the first instance of a bookmark with that name. If
1289 there are one or more other bookmarks with the same name, they will
1291 one most recently used in this file, if any\).
1292 Optional second arg BATCH means don't update the bookmark list buffer,
1293 probably because we were called from there."
1296 bookmark-current-bookmark)))
1301 ;; Added by db, nil bookmark-current-bookmark if the last
1302 ;; occurrence has been deleted
1305 ;; Don't rebuild the list
1307 nil
1316 ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu>
1317 ;; finds out whether it's time to save bookmarks to a file, by
1318 ;; examining the value of variable bookmark-save-flag, and maybe
1319 ;; bookmark-alist-modification-count. Returns t if they should be
1320 ;; saved, nil otherwise. if last-time is non-nil, then this is
1321 ;; being called when emacs is killed.
1324 bookmark-save-flag))
1328 nil)))
1331 ;;;###autoload
1333 "Write bookmarks to a file (reading the file name with the minibuffer).
1334 Don't use this in Lisp programs; use `bookmark-save' instead."
1340 ;;;###autoload
1342 "Save currently defined bookmarks.
1343 Saves by default in the file defined by the variable
1344 `bookmark-default-file'. With a prefix arg, save it in file FILE
1345 \(second argument\).
1347 If you are calling this from Lisp, the two arguments are PARG and
1348 FILE, and if you just want it to write to the default file, then
1349 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1350 instead. If you pass in one argument, and it is non-nil, then the
1351 user will be interactively queried for a file to save in.
1353 When you want to load in the bookmarks from a file, use
1355 for a file, defaulting to the file defined by variable
1356 `bookmark-default-file'."
1361 ;;whether interactive or not, write to default file
1364 ;;whether interactive or not, write to given file
1367 ;;have been called interactively w/ prefix arg
1372 ;; signal that we have synced the bookmark file by setting this to
1373 ;; 0. If there was an error at any point before, it will not get
1374 ;; set, which is what we want.
1378 \f
1396 t))))
1406 ;; Walk over the new list, adding each individual bookmark
1407 ;; carefully. "Carefully" means checking against the existing
1408 ;; bookmark-alist and renaming the new bookmarks with <N> extensions
1409 ;; as necessary.
1421 ;; just a helper for bookmark-import-new-list; it is only for
1422 ;; readability that this is not inlined.
1423 ;;
1424 ;; Once this has found a free name, it sets full-record to that
1425 ;; name.
1428 ;; We've got a conflict, so generate a new name
1437 ;;;###autoload
1439 "Load bookmarks from FILE (which must be in bookmark format).
1440 Appends loaded bookmarks to the front of the list of bookmarks. If
1441 optional second argument OVERWRITE is non-nil, existing bookmarks are
1442 destroyed. Optional third arg NO-MSG means don't display any messages
1443 while loading.
1445 If you load a file that doesn't contain a proper bookmark alist, you
1446 will corrupt Emacs's bookmark list. Generally, you should only load
1447 in files that were created with the bookmark functions in the first
1448 place. Your own personal bookmark file, `~/.emacs.bmk', is
1449 maintained automatically by Emacs; you shouldn't need to load it
1450 explicitly.
1452 If you load a file containing bookmarks with the same names as
1453 bookmarks already present in your Emacs, the new bookmarks will get
1455 method buffers use to resolve name collisions."
1459 bookmark-default-file)
1460 ;;Default might not be used often,
1461 ;;but there's no better default, and
1462 ;;I guess it's better than none at all.
1481 ;; else
1487 file)
1497 \f
1498 ;;; Code supporting the dired-like bookmark menu. Prefix is
1499 ;;; "bookmark-bmenu" for "buffer-menu":
1512 nil
1551 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1552 ;; data.
1556 ;; todo: need to display whether or not bookmark exists as a buffer in
1557 ;; flag column.
1559 ;; Format:
1560 ;; FLAGS BOOKMARK [ LOCATION ]
1564 "Rebuild the Bookmark List if it exists.
1565 Don't affect the buffer ring order."
1572 ;;;###autoload
1574 "Display a list of existing bookmarks.
1575 The list is displayed in a buffer named `*Bookmark List*'.
1576 The leftmost column displays a D if the bookmark is flagged for
1577 deletion, or > if it is flagged for displaying."
1590 ;; if a bookmark has an annotation, prepend a "*"
1591 ;; in the list of bookmarks.
1601 start
1606 follow-link t
1609 )))
1617 ;;;###autoload
1619 ;;;###autoload
1625 "Major mode for editing a list of bookmarks.
1626 Each line describes one of the bookmarks in Emacs.
1627 Letters do not insert themselves; instead, they are commands.
1632 Also show bookmarks marked using m in other windows.
1633 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1637 together with bookmark selected before this one in another window.
1640 so the bookmark menu bookmark remains visible in its window.
1646 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1648 With a prefix arg, prompts for a file to save in.
1651 With prefix argument, also move up one line.
1653 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1654 in another buffer.
1655 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1667 "Toggle whether filenames are shown in the bookmark list.
1668 Optional argument SHOW means show them unconditionally."
1685 nil ;already shown, so do nothing
1698 ;; Strip off `mouse-face' from the white spaces region.
1704 ;; Pass the NO-HISTORY arg:
1711 ;; nothing to hide if above is nil
1732 start
1737 follow-link t
1738 help-echo
1746 ;; Returns non-nil if on a line with a bookmark.
1747 ;; (The actual value returned is bookmark-alist).
1748 ;; Else reposition and try again, else return nil.
1752 bookmark-alist)
1755 bookmark-alist)
1757 bookmark-alist)))
1761 ;; return a string which is bookmark of this line.
1780 ;; well, this is certainly crystal-clear:
1786 "Display the annotation for bookmark named BOOKMARK in a buffer,
1787 if an annotation exists."
1794 ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n"))
1801 "Display the annotations for all bookmarks in a buffer."
1811 ;; insert the annotation, indented by 4 spaces.
1820 bookmark-alist)
1826 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1838 "Select this line's bookmark; also display bookmarks marked with `>'.
1845 tem)
1870 "Save the current list into a bookmark file.
1871 With a prefix arg, prompts for a file to save them in."
1879 "Load the bookmark file and rebuild the bookmark menu-buffer."
1884 ;; This will call `bookmark-bmenu-list'
1889 "Select this line's bookmark, alone, in full frame."
1899 "Select this line's bookmark, with previous buffer in second window."
1916 "Select this line's bookmark in this window."
1923 "Select this line's bookmark in other window, leaving bookmark menu visible."
1937 "Make the other window select this line's bookmark.
1938 The current window remains selected."
1942 same-window-buffer-names
1943 same-window-regexps)
1950 ;; save-excursion won't do
1958 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1968 "Show the annotation for the current bookmark in another window."
1976 "Show the annotation for all bookmarks in another window."
1982 "Edit the annotation for the current bookmark in another window."
1990 "Cancel all requested operations on bookmark on this line and move down.
1991 Optional BACKUP means move up."
1998 ;; any flags to reset according to circumstances? How about a
1999 ;; flag indicating whether this bookmark is being visited?
2000 ;; well, we don't have this now, so maybe later.
2007 "Move up and cancel all requested operations on bookmark on line above."
2018 "Mark bookmark on this line to be deleted.
2019 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2031 "Mark bookmark on this line to be deleted, then move up one line.
2032 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2050 nil
2078 ))
2082 "Rename bookmark on current line. Prompts for a new name."
2093 "Display location of this bookmark. Displays in the minibuffer."
2100 "Change the file path of the bookmark on the current line,
2101 prompting with completion for the new path."
2109 \f
2110 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2113 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2114 That is, ENTRIES is a list of strings which appear as the choices
2115 in the menu.
2116 The number of panes depends on the number of entries.
2117 The visible entries are truncated to `bookmark-menu-length', but the
2118 strings returned are not."
2130 str)
2131 str)
2132 lst)
2139 pane-list)))
2141 ;; Popup the menu and return the string.
2146 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2147 ;; following works, and for explaining what to do to make it work.
2149 ;; We MUST autoload EACH form used to set up this variable's value, so
2150 ;; that the whole job is done in loaddefs.el.
2152 ;; Emacs menubar stuff.
2154 ;;;###autoload
2158 (define-key map [write] '("Save Bookmarks As..." . bookmark-write))
2159 (define-key map [save] '("Save Bookmarks" . bookmark-save))
2160 (define-key map [edit] '("Edit Bookmark List" . bookmark-bmenu-list))
2161 (define-key map [delete] '("Delete Bookmark..." . bookmark-delete))
2162 (define-key map [rename] '("Rename Bookmark..." . bookmark-rename))
2163 (define-key map [locate] '("Insert Location..." . bookmark-locate))
2164 (define-key map [insert] '("Insert Contents..." . bookmark-insert))
2165 (define-key map [set] '("Set Bookmark..." . bookmark-set))
2166 (define-key map [jump] '("Jump to Bookmark..." . bookmark-jump))
2167 map))
2169 ;;;###autoload
2170 (defalias 'menu-bar-bookmark-map menu-bar-bookmark-map)
2172 ;; make bookmarks appear toward the right side of the menu.
2173 (if (boundp 'menu-bar-final-items)
2174 (if menu-bar-final-items
2175 (setq menu-bar-final-items
2176 (cons 'bookmark menu-bar-final-items)))
2177 (setq menu-bar-final-items '(bookmark)))
2179 ;;;; end bookmark menu stuff ;;;;
2181 \f
2182 ;;; Load Hook
2183 (defvar bookmark-load-hook nil
2184 "Hook run at the end of loading bookmark.")
2186 ;;; Exit Hook, called from kill-emacs-hook
2187 (defvar bookmark-exit-hook nil
2188 "Hook run when Emacs exits.")
2190 (define-obsolete-variable-alias 'bookmark-exit-hooks 'bookmark-exit-hook "22.1")
2192 (defun bookmark-exit-hook-internal ()
2193 "Save bookmark state, if necessary, at Emacs exit time.
2194 This also runs `bookmark-exit-hook'."
2195 (run-hooks 'bookmark-exit-hook)
2196 (and bookmark-alist
2197 (bookmark-time-to-save-p t)
2198 (bookmark-save)))
2200 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal)
2203 (run-hooks 'bookmark-load-hook)
2205 (provide 'bookmark)
2207 ;; arch-tag: 139f519a-dd0c-4b8d-8b5d-f9fcf53ca8f6
2208 ;;; bookmark.el ends here