| blob | 53939f92ca6950421e4d829eb486d1a6eba8d260 |
1 ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 2001 Free Software Foundation
5 ;; Author: Karl Fogel <kfogel@red-bean.com>
6 ;; Maintainer: Karl Fogel <kfogel@red-bean.com>
7 ;; Created: July, 1993
8 ;; Keywords: bookmarks, placeholders, annotations
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This package is for setting "bookmarks" in files. A bookmark
30 ;; associates a string with a location in a certain file. Thus, you
31 ;; can navigate your way to that location by providing the string.
32 ;; See the "User Variables" section for customizations.
34 ;; Thanks to David Bremner <bremner@cs.sfu.ca> for thinking of and
35 ;; then implementing the bookmark-current-bookmark idea. He even
36 ;; sent *patches*, bless his soul...
38 ;; Thanks to Gregory M. Saunders <saunders@cis.ohio-state.edu> for
39 ;; fixing and improving bookmark-time-to-save-p.
41 ;; Thanks go to Andrew V. Klein <avk@cig.mot.com> for the code that
42 ;; sorts the alist before presenting it to the user (in bookmark-bmenu-list
43 ;; and the menu-bar).
45 ;; And much thanks to David Hughes <djh@harston.cv.com> for many small
46 ;; suggestions and the code to implement them (like
47 ;; bookmark-bmenu-check-position, and some of the Lucid compatibility
48 ;; stuff).
50 ;; Kudos (whatever they are) go to Jim Blandy <jimb@red-bean.com>
51 ;; for his eminently sensible suggestion to separate bookmark-jump
52 ;; into bookmark-jump and bookmark-jump-noselect, which made many
53 ;; other things cleaner as well.
55 ;; Thanks to Roland McGrath for encouragement and help with defining
56 ;; autoloads on the menu-bar.
58 ;; Jonathan Stigelman <stig@hackvan.com> gave patches for default
59 ;; values in bookmark-jump and bookmark-set. Everybody please keep
60 ;; all the keystrokes they save thereby and send them to him at the
61 ;; end of each year :-) (No, seriously, thanks Jonathan!)
63 ;; Buckets of gratitude to John Grabowski <johng@media.mit.edu> for
64 ;; thinking up the annotations feature and implementing it so well.
66 ;; Based on info-bookmark.el, by Karl Fogel and Ken Olstad
67 ;; <olstad@msc.edu>.
69 ;; Thanks to Mikio Nakajima <PBC01764@niftyserve.or.jp> for many bugs
70 ;; reported and fixed.
72 ;; Thank you, Michael Kifer, for contributing the XEmacs support.
74 ;; Enough with the credits already, get on to the good stuff:
76 ;; FAVORITE CHINESE RESTAURANT:
77 ;; Boy, that's a tough one. Probably Hong Min, or maybe Emperor's
78 ;; Choice (both in Chicago's Chinatown). Well, both. How about you?
79 \f
80 ;;; Code:
84 ;;; Misc comments:
85 ;;
86 ;; If variable bookmark-use-annotations is non-nil, an annotation is
87 ;; queried for when setting a bookmark.
88 ;;
89 ;; The bookmark list is sorted lexically by default, but you can turn
90 ;; this off by setting bookmark-sort-flag to nil. If it is nil, then
91 ;; the list will be presented in the order it is recorded
92 ;; (chronologically), which is actually fairly useful as well.
94 ;;; User Variables
97 "Setting, annotation and jumping to bookmarks."
102 "*If non-nil, saving a bookmark queries for an annotation in a buffer."
108 "*Controls when Emacs saves bookmarks to a file.
109 --> nil means never save bookmarks, except when `bookmark-save' is
111 --> t means save bookmarks when Emacs is killed.
112 --> Otherwise, it should be a number that is the frequency with which
113 the bookmark list is saved \(i.e.: the number of times which
114 Emacs' bookmark list may be modified before it is automatically
115 saved.\). If it is a number, Emacs will also automatically save
116 bookmarks when it is killed.
118 Therefore, the way to get it to save every time you make or delete a
119 bookmark is to set this variable to 1 \(or 0, which produces the same
120 behavior.\)
122 To specify the file in which to save them, modify the variable
123 `bookmark-default-file', which is `~/.emacs.bmk' by default."
132 ;; defvarred to avoid a compilation warning:
138 ;; In case user set `bookmark-file' in her .emacs:
139 bookmark-file
141 "*File in which to save bookmarks by default."
147 "*Whether or not to make numbered backups of the bookmark file.
148 It can have four values: t, nil, `never', and `nospecial'.
149 The first three have the same meaning that they do for the
150 variable `version-control', and the final value `nospecial' means just
151 use the value of `version-control'."
158 "*Non-nil means bookmark functions ignore case in completion."
164 "*Non-nil means that bookmarks will be displayed sorted by bookmark name.
165 Otherwise they will be displayed in LIFO order (that is, most
166 recently set ones come first, oldest ones come last)."
172 "*nil means don't show annotations when jumping to a bookmark."
178 "*Column at which to display filenames in a buffer listing bookmarks.
179 You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]."
185 "*Non-nil means show filenames when listing bookmarks.
186 This may result in truncated bookmark names. To disable this, put the
187 following in your `.emacs' file:
189 \(setq bookmark-bmenu-toggle-filenames nil\)"
195 "*Maximum length of a bookmark name displayed on a popup menu."
200 ;;; No user-serviceable parts beyond this point.
202 ;; Is it XEmacs?
207 ;; Added for lucid emacs compatibility, db
210 ;; suggested for lucid compatibility by david hughes:
213 ;; This variable is probably obsolete now...
215 ;; some random value higher than 9600
219 \f
220 ;;; Keymap stuff:
222 ;; Set up these bindings dumping time *only*;
223 ;; if the user alters them, don't override the user when loading bookmark.el.
225 ;;;###autoload (define-key ctl-x-map "rb" 'bookmark-jump)
226 ;;;###autoload (define-key ctl-x-map "rm" 'bookmark-set)
227 ;;;###autoload (define-key ctl-x-map "rl" 'bookmark-bmenu-list)
229 ;;;###autoload
231 "Keymap containing bindings to bookmark functions.
232 It is not bound to any key by default: to bind it
233 so that you have a bookmark prefix, just use `global-set-key' and bind a
234 key of your choice to `bookmark-map'. All interactive bookmark
237 ;;;###autoload
240 ;; Read the help on all of these functions for details...
241 ;;;###autoload
243 ;;;###autoload
245 ;;;###autoload
247 ;;;###autoload
249 ;;;###autoload
251 ;;;###autoload
253 ;;;###autoload
255 ;;;###autoload
257 ;;;###autoload
259 ;;;###autoload
261 ;;;###autoload
263 ;;;###autoload
267 ;;; The annotation maps.
275 \f
276 ;;; Core variables and data structures:
278 "Association list of bookmarks and their records.
279 You probably don't want to change the value of this alist yourself;
280 instead, let the various bookmark functions do it for you.
282 The format of the alist is
284 \(BOOKMARK1 BOOKMARK2 ...\)
286 where each BOOKMARK is of the form
288 \(NAME
289 \(filename . FILE\)
290 \(front-context-string . FRONT-STR\)
291 \(rear-context-string . REAR-STR\)
292 \(position . POS\)
293 \(info-node . POS\)
294 \(annotation . ANNOTATION\)\)
296 So the cdr of each bookmark is an alist too.
303 ;; more stuff added by db.
306 "Name of bookmark most recently used in the current file.
307 It is buffer local, used to make moving a bookmark forward
326 \f
327 ;; Helper functions.
329 ;; Only functions on this page and the next one (file formats) need to
330 ;; know anything about the format of bookmark-alist entries.
331 ;; Everyone else should go through them.
334 "Return name of FULL-RECORD \(an alist element instead of a string\)."
339 "Return a list of all current bookmark names."
344 bookmark-alist))
348 "Return the full entry for BOOKMARK in bookmark-alist.
349 If BOOKMARK is not a string, return nil."
352 #'assoc-ignore-case
358 "Return the guts of the entry for BOOKMARK in bookmark-alist.
359 That is, all information but the name."
364 "Set BOOKMARK's name to NEWNAME."
367 newname))
371 "Return the annotation of BOOKMARK, or nil if none."
376 "Set the annotation of BOOKMARK to ANN."
385 "Return the full filename of BOOKMARK."
390 "Set the full filename of BOOKMARK to FILENAME."
399 "Return the position \(i.e.: point\) of BOOKMARK."
404 "Set the position \(i.e.: point\) of BOOKMARK to POSITION."
413 "Return the front-context-string of BOOKMARK."
418 "Set the front-context-string of BOOKMARK to STRING."
428 "Return the rear-context-string of BOOKMARK."
433 "Set the rear-context-string of BOOKMARK to STRING."
443 "Get the info node associated with BOOKMARK."
448 "Set the Info node of BOOKMARK to NODE."
458 )
466 "Prompting with PROMPT, read a bookmark name in completion.
468 probably don't want to include one yourself.
469 Optional second arg DEFAULT is a string to return if the user enters
470 the empty string."
479 bookmark-alist
480 nil
481 0
482 nil
490 "Put STRING into the bookmark prompt history, if caller non-interactive.
491 We need this because sometimes bookmark functions are invoked from
492 menus, so `completing-read' never gets a chance to set `bookmark-history'."
499 "Make a bookmark named NAME.
500 Optional second arg ANNOTATION gives it an annotation.
501 Optional third arg OVERWRITE means replace any existing bookmarks with
502 this name.
503 Optional fourth arg INFO-NODE means this bookmark is at info node
504 INFO-NODE, so record this fact in the bookmark's entry."
508 ;; XEmacs's `set-text-properties' doesn't work on
509 ;; free-standing strings, apparently.
512 ;; already existing bookmark under that name and
513 ;; no prefix arg means just overwrite old bookmark
517 ;; otherwise just cons it onto the front (either the bookmark
518 ;; doesn't exist already, or there is no prefix arg. In either
519 ;; case, we want the new bookmark consed onto the alist...)
525 bookmark-alist)))
527 ;; Added by db
536 "Return the record part of a new bookmark, given ANNOTATION.
537 Must be at the correct position in the buffer in which the bookmark is
538 being set. This might change someday.
539 Optional second arg INFO-NODE means this bookmark is at info node
540 INFO-NODE, so record this fact in the bookmark's entry."
548 nil))
554 nil))
557 ;; Now fill in the optional parts:
559 ;; Take no chances with text properties
568 ;; Finally, return the completed record.
569 the-record))
572 \f
573 ;;; File format stuff
575 ;; The OLD format of the bookmark-alist was:
576 ;;
577 ;; ((bookmark-name (filename
578 ;; string-in-front
579 ;; string-behind
580 ;; point))
581 ;; ...)
582 ;;
583 ;; The NEW format of the bookmark-alist is:
584 ;;
585 ;; ((bookmark-name ((filename . FILENAME)
586 ;; (front-context-string . string-in-front)
587 ;; (rear-context-string . string-behind)
588 ;; (position . POINT)
589 ;; (annotation . annotation)
590 ;; (whatever . VALUE)
591 ;; ...
592 ;; ))
593 ;; ...)
594 ;;
595 ;;
596 ;; I switched to using an internal as well as external alist because I
597 ;; felt that would be a more flexible framework in which to add
598 ;; features. It means that the order in which values appear doesn't
599 ;; matter, and it means that arbitrary values can be added without
600 ;; risk of interfering with existing ones.
601 ;;
602 ;; BOOKMARK-NAME is the string the user gives the bookmark and
603 ;; accesses it by from then on.
604 ;;
605 ;; FILENAME is the location of the file in which the bookmark is set.
606 ;;
607 ;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
608 ;; context in front of the point at which the bookmark is set.
609 ;;
610 ;; STRING-BEHIND is the same thing, but after the point.
611 ;;
612 ;; The context strings exist so that modifications to a file don't
613 ;; necessarily cause a bookmark's position to be invalidated.
614 ;; bookmark-jump will search for STRING-BEHIND and STRING-IN-FRONT in
615 ;; case the file has changed since the bookmark was set. It will
616 ;; attempt to place the user before the changes, if there were any.
617 ;; ANNOTATION is the annotation for the bookmark; it may not exist
618 ;; (for backward compatibility), be nil (no annotation), or be a
619 ;; string.
623 "The current version of the format used by bookmark files.
633 "Return a bookmark-alist (in any format) from the current buffer.
634 The buffer must of course contain bookmark format information.
635 Does not care from where in the buffer it is called, and does not
636 affect point."
641 ;; Else we're dealing with format version 0
646 ;; Else no hope of getting information here.
651 "Upgrade a version 0 alist OLD-LIST to the current version."
662 name
668 old-list))
672 "Upgrade a bookmark file of format 0 (the original format) to format 1.
673 This expects to be called from point-min in a bookmark file."
675 bookmark-file-format-version)
684 bookmark-file-format-version)
685 )
689 "Return an integer which is the file-format version of this bookmark file.
690 This expects to be called from point-min in a bookmark file."
697 ;; Else this is format version 0, the original one, which didn't
698 ;; even have version stamps.
703 "Check the file-format version of this bookmark file.
704 If the version is not up-to-date, upgrade it automatically.
705 This expects to be called from point-min in a bookmark file."
717 "Insert text indicating current version of bookmark file format."
720 bookmark-file-format-version))
723 ";;; "
724 bookmark-end-of-version-stamp-marker))
727 ;;; end file-format stuff
729 \f
730 ;;; Core code:
732 ;;;###autoload
734 "Set a bookmark named NAME inside a file.
735 If name is nil, then the user will be prompted.
736 With prefix arg, will not overwrite a bookmark that has the same name
738 the new bookmark onto the bookmark alist. Thus the most recently set
739 bookmark with name NAME would be the one in effect at any given time,
740 but the others are still there, should you decide to delete the most
741 recent one.
743 To yank words from the text of the buffer and use them as part of the
744 bookmark name, type C-w while setting a bookmark. Successive C-w's
745 yank successive words.
747 Typing C-u inserts the name of the last bookmark used in the buffer
748 \(as an aid in using a single bookmark name to track your progress
749 through a large file\). If no bookmark was used, then C-u inserts the
750 name of the file being visited.
753 and it removes only the first instance of a bookmark with that name from
754 the list of bookmarks.\)"
772 nil
776 now-map))))
779 ;; Ask for an annotation buffer for this bookmark
789 "If in Info-mode, return current node name (a string), else nil."
791 Info-current-node))
795 "Kill from point to end of line.
796 If optional arg NEWLINE-TOO is non-nil, delete the newline too.
797 Does not affect the kill-ring."
804 ;; Defvars to avoid compilation warnings:
813 "Use buffer contents as the annotation for a bookmark.
814 Exclude lines that begin with `#'.
815 Store the annotation text in the bookmark list with
816 the bookmark (and file, and point) specified in buffer local variables."
830 ;; for bookmark-make-cell to work, we need to be
831 ;; in the relevant buffer, at the relevant point.
832 ;; Actually, bookmark-make-cell should probably be re-written,
833 ;; to avoid this need. Should I handle the error if a buffer is
834 ;; killed between "C-x r m" and a "C-c C-c" in the annotation buffer?
855 "Function to return default text to use for a bookmark annotation.
859 "Mode for composing annotations for a bookmark.
860 Wants BUF POINT PARG and BOOKMARK.
862 the annotation.
865 "
885 "Pop up a buffer for entering a bookmark annotation.
886 Text surrounding the bookmark is PARG; the bookmark name is BOOKMARK."
902 "Mode for editing the annotation of bookmark BOOKMARK.
906 "
921 "Use buffer contents (minus beginning with `#' as annotation for a bookmark."
939 "Pop up a buffer for editing bookmark BOOKMARK's annotation."
947 "Insert this buffer's value of bookmark-current-bookmark.
948 Default to file name if it's nil."
953 bookmark-current-bookmark)))
958 "Insert the current file name into the bookmark name being set.
959 The directory part of the file name is not used."
969 "Return the name of the current buffer's file, non-directory.
970 In Info, return the current node."
972 ;; Are we in Info?
974 ;; Or are we a file?
976 ;; Or are we a directory?
979 dired-directory
982 ;; Strip the trailing slash.
985 ;; Else return the current-buffer
987 ;; If all else fails, use the buffer's name.
994 ;; get the next word from the buffer and append it to the name of
995 ;; the bookmark currently being set.
1008 "Return the current buffer's file in a way useful for bookmarks.
1009 For example, if this is a Info buffer, return the Info file's name."
1011 Info-current-file
1013 buffer-file-name
1016 dired-directory
1025 ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs
1026 ;; to be renamed.
1031 ;; return t so the `and' will continue...
1032 t)
1040 ;;Return the bookmark-alist for display. If the bookmark-sort-flag
1041 ;;is non-nil, then return a sorted copy of the alist.
1049 ;;;###autoload
1051 "Jump to bookmark BOOKMARK (a point in some file).
1052 You may have a problem using this function if the value of variable
1053 `bookmark-alist' is nil. If that happens, you need to load in some
1054 bookmarks. See help on function `bookmark-load' for more about
1055 this.
1057 If the file pointed to by BOOKMARK no longer exists, you will be asked
1058 if you wish to give the bookmark a new location, and bookmark-jump
1059 will then jump to the new location, as well as recording it in place
1060 of the old one in the permanent bookmark record."
1069 ;; if there is an annotation for this bookmark,
1070 ;; show it in a buffer.
1075 "Return FILE (a string) if it exists in any reasonable variation, else nil.
1076 Reasonable variations are FILE.gz, FILE.Z, FILE.info, FILE.info.gz, etc."
1091 ;; a leetle helper for bookmark-jump :-)
1092 ;; returns (BUFFER . POINT)
1100 )
1105 ;; Info nodes must be visited with care.
1109 ;; Else no Info. Can do an ordinary find-file:
1113 ;; Go searching forward first. Then, if forward-str exists and
1114 ;; was found in the file, we can search backward for behind-str.
1115 ;; Rationale is that if text was inserted between the two in the
1116 ;; file, it's better to be put before it so you can read it,
1117 ;; rather than after and remain perhaps unaware of the changes.
1124 ;; added by db
1128 ;; Else unable to find the marked file, so ask if user wants to
1129 ;; relocate the bookmark, else remind them to consider deletion.
1133 str
1137 ;; gasp! It's a recursive function call in Emacs Lisp!
1141 nil))))
1144 ;;;###autoload
1146 "Relocate BOOKMARK to another file (reading file name with minibuffer).
1147 This makes an already existing bookmark point to that file, instead of
1148 the one it used to point at. Useful when a file has been renamed
1149 after a bookmark was set in it."
1162 ;;;###autoload
1164 "Insert the name of the file associated with BOOKMARK.
1165 Optional second arg NO-HISTORY means don't record this in the
1166 minibuffer history list `bookmark-history'."
1180 ;;;###autoload
1184 "Return the name of the file associated with BOOKMARK."
1189 ;;;###autoload
1191 "Change the name of OLD bookmark to NEW name.
1192 If called from keyboard, prompt for OLD and NEW. If called from
1193 menubar, select OLD from a menu and prompt for NEW.
1195 If called from Lisp, prompt for NEW if only OLD was passed as an
1196 argument. If called with two strings, then no prompting is done. You
1197 must pass at least OLD when calling from Lisp.
1199 While you are entering the new name, consecutive C-w's insert
1200 consecutive words from the text of the buffer into the new bookmark
1201 name."
1212 "New name: "
1213 nil
1216 now-map)
1217 nil
1228 ;;;###autoload
1230 "Insert the text of the file pointed to by bookmark BOOKMARK.
1231 You may have a problem using this function if the value of variable
1232 `bookmark-alist' is nil. If that happens, you need to load in some
1233 bookmarks. See help on function `bookmark-load' for more about
1234 this."
1248 ;;;###autoload
1250 "Delete BOOKMARK from the bookmark list.
1251 Removes only the first instance of a bookmark with that name. If
1252 there are one or more other bookmarks with the same name, they will
1254 one most recently used in this file, if any\).
1255 Optional second arg BATCH means don't update the bookmark list buffer,
1256 probably because we were called from there."
1263 ;; Added by db, nil bookmark-current-bookmark if the last
1264 ;; occurrence has been deleted
1267 ;; Don't rebuild the list
1269 nil
1278 ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu>
1279 ;; finds out whether it's time to save bookmarks to a file, by
1280 ;; examining the value of variable bookmark-save-flag, and maybe
1281 ;; bookmark-alist-modification-count. Returns t if they should be
1282 ;; saved, nil otherwise. if last-time is non-nil, then this is
1283 ;; being called when emacs is killed.
1286 bookmark-save-flag))
1290 nil)))
1293 ;;;###autoload
1295 "Write bookmarks to a file (reading the file name with the minibuffer).
1296 Don't use this in Lisp programs; use `bookmark-save' instead."
1302 ;;;###autoload
1304 "Save currently defined bookmarks.
1305 Saves by default in the file defined by the variable
1306 `bookmark-default-file'. With a prefix arg, save it in file FILE
1307 \(second argument\).
1309 If you are calling this from Lisp, the two arguments are PREFIX-ARG
1310 and FILE, and if you just want it to write to the default file, then
1311 pass no arguments. Or pass in nil and FILE, and it will save in FILE
1312 instead. If you pass in one argument, and it is non-nil, then the
1313 user will be interactively queried for a file to save in.
1315 When you want to load in the bookmarks from a file, use
1317 for a file, defaulting to the file defined by variable
1318 `bookmark-default-file'."
1323 ;;whether interactive or not, write to default file
1326 ;;whether interactive or not, write to given file
1329 ;;have been called interactively w/ prefix arg
1334 ;; signal that we have synced the bookmark file by setting this to
1335 ;; 0. If there was an error at any point before, it will not get
1336 ;; set, which is what we want.
1340 \f
1360 t))))
1368 ;; Walk over the new list, adding each individual bookmark
1369 ;; carefully. "Carefully" means checking against the existing
1370 ;; bookmark-alist and renaming the new bookmarks with <N> extensions
1371 ;; as necessary.
1383 ;; just a helper for bookmark-import-new-list; it is only for
1384 ;; readability that this is not inlined.
1385 ;;
1386 ;; Once this has found a free name, it sets full-record to that
1387 ;; name.
1390 ;; We've got a conflict, so generate a new name
1399 ;;;###autoload
1401 "Load bookmarks from FILE (which must be in bookmark format).
1402 Appends loaded bookmarks to the front of the list of bookmarks. If
1403 optional second argument OVERWRITE is non-nil, existing bookmarks are
1404 destroyed. Optional third arg NO-MSG means don't display any messages
1405 while loading.
1407 If you load a file that doesn't contain a proper bookmark alist, you
1408 will corrupt Emacs's bookmark list. Generally, you should only load
1409 in files that were created with the bookmark functions in the first
1410 place. Your own personal bookmark file, `~/.emacs.bmk', is
1411 maintained automatically by Emacs; you shouldn't need to load it
1412 explicitly.
1414 If you load a file containing bookmarks with the same names as
1415 bookmarks already present in your Emacs, the new bookmarks will get
1417 method buffers use to resolve name collisions."
1421 bookmark-default-file)
1422 ;;Default might not be used often,
1423 ;;but there's no better default, and
1424 ;;I guess it's better than none at all.
1443 ;; else
1449 file)
1459 \f
1460 ;;; Code supporting the dired-like bookmark menu. Prefix is
1461 ;;; "bookmark-bmenu" for "buffer-menu":
1474 nil
1512 ;; Bookmark Buffer Menu mode is suitable only for specially formatted
1513 ;; data.
1517 ;; todo: need to display whether or not bookmark exists as a buffer in
1518 ;; flag column.
1520 ;; Format:
1521 ;; FLAGS BOOKMARK [ LOCATION ]
1525 "Rebuild the Bookmark List if it exists.
1526 Don't affect the buffer ring order."
1533 ;;;###autoload
1535 "Display a list of existing bookmarks.
1536 The list is displayed in a buffer named `*Bookmark List*'.
1537 The leftmost column displays a D if the bookmark is flagged for
1538 deletion, or > if it is flagged for displaying."
1551 ;; if a bookmark has an annotation, prepend a "*"
1552 ;; in the list of bookmarks.
1568 )))
1569 bookmark-alist))
1576 ;;;###autoload
1578 ;;;###autoload
1584 "Major mode for editing a list of bookmarks.
1585 Each line describes one of the bookmarks in Emacs.
1586 Letters do not insert themselves; instead, they are commands.
1591 Also show bookmarks marked using m in other windows.
1592 \\[bookmark-bmenu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
1596 together with bookmark selected before this one in another window.
1599 so the bookmark menu bookmark remains visible in its window.
1604 \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'.
1606 With a prefix arg, prompts for a file to save in.
1609 With prefix argument, also move up one line.
1611 \\[bookmark-bmenu-show-annotation] -- show the annotation, if it exists, for the current bookmark
1612 in another buffer.
1613 \\[bookmark-bmenu-show-all-annotations] -- show the annotations of all bookmarks in another buffer.
1625 "Toggle whether filenames are shown in the bookmark list.
1626 Optional argument SHOW means show them unconditionally."
1643 nil ;already shown, so do nothing
1656 ;; Strip off `mouse-face' from the white spaces region.
1662 ;; Pass the NO-HISTORY arg:
1669 ;; nothing to hide if above is nil
1694 help-echo
1702 ;; Returns non-nil if on a line with a bookmark.
1703 ;; (The actual value returned is bookmark-alist).
1704 ;; Else reposition and try again, else return nil.
1708 bookmark-alist)
1711 bookmark-alist)
1713 bookmark-alist)))
1717 ;; return a string which is bookmark of this line.
1736 ;; well, this is certainly crystal-clear:
1742 "Display the annotation for bookmark named BOOKMARK in a buffer,
1743 if an annotation exists."
1750 ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n"))
1757 "Display the annotations for all bookmarks in a buffer."
1767 ;; insert the annotation, indented by 4 spaces.
1775 bookmark-alist)
1781 "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]."
1793 "Select this line's bookmark; also display bookmarks marked with `>'.
1800 tem)
1825 "Save the current list into a bookmark file.
1826 With a prefix arg, prompts for a file to save them in."
1834 "Load the bookmark file and rebuild the bookmark menu-buffer."
1839 ;; This will call `bookmark-bmenu-list'
1844 "Select this line's bookmark, alone, in full frame."
1854 "Select this line's bookmark, with previous buffer in second window."
1871 "Select this line's bookmark in this window."
1878 "Select this line's bookmark in other window, leaving bookmark menu visible."
1892 "Make the other window select this line's bookmark.
1893 The current window remains selected."
1897 same-window-buffer-names
1898 same-window-regexps)
1905 ;; save-excursion won't do
1913 "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible."
1923 "Show the annotation for the current bookmark in another window."
1931 "Show the annotation for all bookmarks in another window."
1937 "Edit the annotation for the current bookmark in another window."
1945 "Cancel all requested operations on bookmark on this line and move down.
1946 Optional BACKUP means move up."
1953 ;; any flags to reset according to circumstances? How about a
1954 ;; flag indicating whether this bookmark is being visited?
1955 ;; well, we don't have this now, so maybe later.
1962 "Move up and cancel all requested operations on bookmark on line above."
1973 "Mark bookmark on this line to be deleted.
1974 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
1986 "Mark bookmark on this line to be deleted, then move up one line.
1987 To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-execute-deletions]."
2005 nil
2033 ))
2037 "Rename bookmark on current line. Prompts for a new name."
2048 "Display location of this bookmark. Displays in the minibuffer."
2055 \f
2056 ;;; Menu bar stuff. Prefix is "bookmark-menu".
2059 "Build a multi-paned menu named NAME from the strings in ENTRIES.
2060 That is, ENTRIES is a list of strings which appear as the choices
2061 in the menu. The number of panes depends on the number of entries.
2062 The visible entries are truncated to `bookmark-menu-length', but the
2063 strings returned are not."
2077 str)
2078 str)
2079 lst))
2084 temp-pane-list
2089 temp-pane-list))))
2092 ;; Return the menu:
2097 "Pop up multi-paned menu at EVENT, return string chosen from ENTRIES.
2098 That is, ENTRIES is a list of strings which appear as the choices
2099 in the menu.
2100 The number of panes depends on the number of entries."
2106 "Pop up menu of bookmarks, return chosen bookmark.
2107 Pop up at EVENT, menu's name is NAME.
2108 The number of panes depends on the number of bookmarks."
2113 ;; help function for making menus that need to apply a bookmark
2114 ;; function to a string.
2116 event menu-label)))
2120 ;;;###autoload
2122 "Insert the text of the file pointed to by bookmark BOOKMARK.
2123 You may have a problem using this function if the value of variable
2124 `bookmark-alist' is nil. If that happens, you need to load in some
2125 bookmarks. See help on function `bookmark-load' for more about
2126 this.
2128 Warning: this function only takes an EVENT as argument. Use the
2129 corresponding bookmark function from Lisp \(the one without the
2136 ;;;###autoload
2138 "Jump to bookmark BOOKMARK (a point in some file).
2139 You may have a problem using this function if the value of variable
2140 `bookmark-alist' is nil. If that happens, you need to load in some
2141 bookmarks. See help on function `bookmark-load' for more about
2142 this.
2144 Warning: this function only takes an EVENT as argument. Use the
2145 corresponding bookmark function from Lisp \(the one without the
2152 ;;;###autoload
2154 "Insert the name of the file associated with BOOKMARK.
2155 \(This is not the same as the contents of that file\).
2157 Warning: this function only takes an EVENT as argument. Use the
2158 corresponding bookmark function from Lisp \(the one without the
2165 ;;;###autoload
2167 "Change the name of OLD-BOOKMARK to NEWNAME.
2168 If called from keyboard, prompts for OLD-BOOKMARK and NEWNAME.
2169 If called from menubar, OLD-BOOKMARK is selected from a menu, and
2170 prompts for NEWNAME.
2171 If called from Lisp, prompts for NEWNAME if only OLD-BOOKMARK was
2172 passed as an argument. If called with two strings, then no prompting
2173 is done. You must pass at least OLD-BOOKMARK when calling from Lisp.
2175 While you are entering the new name, consecutive C-w's insert
2176 consecutive words from the text of the buffer into the new bookmark
2177 name.
2179 Warning: this function only takes an EVENT as argument. Use the
2180 corresponding bookmark function from Lisp \(the one without the
2187 ;;;###autoload
2189 "Delete the bookmark named NAME from the bookmark list.
2190 Removes only the first instance of a bookmark with that name. If
2191 there are one or more other bookmarks with the same name, they will
2193 one most recently used in this file, if any\).
2195 Warning: this function only takes an EVENT as argument. Use the
2196 corresponding bookmark function from Lisp \(the one without the
2203 ;; Thanks to Roland McGrath for fixing menubar.el so that the
2204 ;; following works, and for explaining what to do to make it work.
2206 ;; We MUST autoload EACH form used to set up this variable's value, so
2207 ;; that the whole job is done in loaddefs.el.
2209 ;; Emacs menubar stuff.
2211 ;;;###autoload
2214 ;;;###autoload
2217 ;; make bookmarks appear toward the right side of the menu.
2224 ;;;###autoload
2226 '("Load a Bookmark File..." . bookmark-load))
2228 ;;;###autoload
2229 (define-key menu-bar-bookmark-map [write]
2230 '("Save Bookmarks As..." . bookmark-write))
2232 ;;;###autoload
2233 (define-key menu-bar-bookmark-map [save]
2234 '("Save Bookmarks" . bookmark-save))
2236 ;;;###autoload
2237 (define-key menu-bar-bookmark-map [edit]
2238 '("Edit Bookmark List" . bookmark-bmenu-list))
2240 ;;;###autoload
2241 (define-key menu-bar-bookmark-map [delete]
2242 '("Delete Bookmark" . bookmark-menu-delete))
2244 ;;;###autoload
2245 (define-key menu-bar-bookmark-map [rename]
2246 '("Rename Bookmark" . bookmark-menu-rename))
2248 ;;;###autoload
2249 (define-key menu-bar-bookmark-map [locate]
2250 '("Insert Location" . bookmark-menu-locate))
2252 ;;;###autoload
2253 (define-key menu-bar-bookmark-map [insert]
2254 '("Insert Contents" . bookmark-menu-insert))
2256 ;;;###autoload
2257 (define-key menu-bar-bookmark-map [set]
2258 '("Set Bookmark" . bookmark-set))
2260 ;;;###autoload
2261 (define-key menu-bar-bookmark-map [jump]
2262 '("Jump to Bookmark" . bookmark-menu-jump))
2264 ;;;; end bookmark menu stuff ;;;;
2266 \f
2267 ;;; Load Hook
2268 (defvar bookmark-load-hook nil
2269 "Hook to run at the end of loading bookmark.")
2271 ;;; Exit Hook, called from kill-emacs-hook
2272 (defvar bookmark-exit-hook nil
2273 "Hook to run when emacs exits")
2275 (defun bookmark-exit-hook-internal ()
2276 "Save bookmark state, if necessary, at Emacs exit time.
2277 This also runs `bookmark-exit-hooks'."
2278 (and
2279 (progn (run-hooks 'bookmark-exit-hooks) t)
2280 bookmark-alist
2281 (bookmark-time-to-save-p t)
2282 (bookmark-save)))
2284 (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal)
2287 (run-hooks 'bookmark-load-hook)
2289 (provide 'bookmark)
2291 ;;; bookmark.el ends here