Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; bookmark.el --- set bookmarks, maybe annotate them, jump to them later |
b3bf02fa | 2 | |
7e726492 | 3 | ;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 2001 Free Software Foundation |
b3bf02fa | 4 | |
60d0378e KF |
5 | ;; Author: Karl Fogel <kfogel@red-bean.com> |
6 | ;; Maintainer: Karl Fogel <kfogel@red-bean.com> | |
b3bf02fa | 7 | ;; Created: July, 1993 |
e3437989 | 8 | ;; Keywords: bookmarks, placeholders, annotations |
b3bf02fa RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
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. | |
16 | ||
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. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
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. | |
26 | ||
27 | ;;; Commentary: | |
28 | ||
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. | |
b3bf02fa RS |
33 | |
34 | ;; Thanks to David Bremner <bremner@cs.sfu.ca> for thinking of and | |
35 | ;; then implementing the bookmark-current-bookmark idea. He even | |
d23e2c3f | 36 | ;; sent *patches*, bless his soul... |
b3bf02fa RS |
37 | |
38 | ;; Thanks to Gregory M. Saunders <saunders@cis.ohio-state.edu> for | |
39 | ;; fixing and improving bookmark-time-to-save-p. | |
40 | ||
e3437989 RS |
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 | |
d23e2c3f KF |
43 | ;; and the menu-bar). |
44 | ||
d22d6453 RS |
45 | ;; And much thanks to David Hughes <djh@harston.cv.com> for many small |
46 | ;; suggestions and the code to implement them (like | |
e3437989 | 47 | ;; bookmark-bmenu-check-position, and some of the Lucid compatibility |
d22d6453 RS |
48 | ;; stuff). |
49 | ||
60d0378e | 50 | ;; Kudos (whatever they are) go to Jim Blandy <jimb@red-bean.com> |
d23e2c3f KF |
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. | |
54 | ||
d22d6453 RS |
55 | ;; Thanks to Roland McGrath for encouragement and help with defining |
56 | ;; autoloads on the menu-bar. | |
57 | ||
2b911848 | 58 | ;; Jonathan Stigelman <stig@hackvan.com> gave patches for default |
d23e2c3f KF |
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!) | |
62 | ||
e3437989 RS |
63 | ;; Buckets of gratitude to John Grabowski <johng@media.mit.edu> for |
64 | ;; thinking up the annotations feature and implementing it so well. | |
65 | ||
b3bf02fa RS |
66 | ;; Based on info-bookmark.el, by Karl Fogel and Ken Olstad |
67 | ;; <olstad@msc.edu>. | |
68 | ||
4eadcdf8 RS |
69 | ;; Thanks to Mikio Nakajima <PBC01764@niftyserve.or.jp> for many bugs |
70 | ;; reported and fixed. | |
71 | ||
09fd6588 KF |
72 | ;; Thank you, Michael Kifer, for contributing the XEmacs support. |
73 | ||
d22d6453 | 74 | ;; Enough with the credits already, get on to the good stuff: |
b3bf02fa | 75 | |
dbe99ae9 | 76 | ;; FAVORITE CHINESE RESTAURANT: |
b3bf02fa RS |
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? | |
e3437989 | 79 | \f |
e8af40ee | 80 | ;;; Code: |
b3bf02fa | 81 | |
b578f267 EN |
82 | (require 'pp) |
83 | ||
e3437989 | 84 | ;;; Misc comments: |
b3bf02fa | 85 | ;; |
e3437989 | 86 | ;; If variable bookmark-use-annotations is non-nil, an annotation is |
dbe99ae9 | 87 | ;; queried for when setting a bookmark. |
11eb4275 | 88 | ;; |
d22d6453 RS |
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. | |
b3bf02fa | 93 | |
4eadcdf8 RS |
94 | ;;; User Variables |
95 | ||
bbf5eb28 | 96 | (defgroup bookmark nil |
9848f0ca | 97 | "Setting, annotation and jumping to bookmarks." |
bbf5eb28 RS |
98 | :group 'matching) |
99 | ||
100 | ||
101 | (defcustom bookmark-use-annotations nil | |
9848f0ca | 102 | "*If non-nil, saving a bookmark queries for an annotation in a buffer." |
bbf5eb28 RS |
103 | :type 'boolean |
104 | :group 'bookmark) | |
4eadcdf8 RS |
105 | |
106 | ||
bbf5eb28 | 107 | (defcustom bookmark-save-flag t |
4eadcdf8 | 108 | "*Controls when Emacs saves bookmarks to a file. |
9848f0ca | 109 | --> nil means never save bookmarks, except when `bookmark-save' is |
4eadcdf8 RS |
110 | explicitly called \(\\[bookmark-save]\). |
111 | --> t means save bookmarks when Emacs is killed. | |
3b526bae | 112 | --> Otherwise, it should be a number that is the frequency with which |
4eadcdf8 RS |
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. | |
117 | ||
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.\) | |
121 | ||
122 | To specify the file in which to save them, modify the variable | |
9848f0ca | 123 | `bookmark-default-file', which is `~/.emacs.bmk' by default." |
31fa1bd1 | 124 | :type '(choice (const nil) integer (other t)) |
bbf5eb28 | 125 | :group 'bookmark) |
4eadcdf8 RS |
126 | |
127 | ||
128 | (defconst bookmark-old-default-file "~/.emacs-bkmrks" | |
9848f0ca | 129 | "*The `.emacs.bmk' file used to be called this name.") |
4eadcdf8 RS |
130 | |
131 | ||
132 | ;; defvarred to avoid a compilation warning: | |
133 | (defvar bookmark-file nil | |
134 | "Old name for `bookmark-default-file'.") | |
135 | ||
bbf5eb28 | 136 | (defcustom bookmark-default-file |
4eadcdf8 RS |
137 | (if bookmark-file |
138 | ;; In case user set `bookmark-file' in her .emacs: | |
139 | bookmark-file | |
88fb0aaa | 140 | (convert-standard-filename "~/.emacs.bmk")) |
bbf5eb28 RS |
141 | "*File in which to save bookmarks by default." |
142 | :type 'file | |
143 | :group 'bookmark) | |
4eadcdf8 RS |
144 | |
145 | ||
bbf5eb28 | 146 | (defcustom bookmark-version-control 'nospecial |
4eadcdf8 RS |
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 | |
bbf5eb28 | 151 | use the value of `version-control'." |
31fa1bd1 AS |
152 | :type '(choice (const nil) (const never) (const nospecial) |
153 | (other t)) | |
bbf5eb28 | 154 | :group 'bookmark) |
4eadcdf8 RS |
155 | |
156 | ||
bbf5eb28 RS |
157 | (defcustom bookmark-completion-ignore-case t |
158 | "*Non-nil means bookmark functions ignore case in completion." | |
159 | :type 'boolean | |
160 | :group 'bookmark) | |
4eadcdf8 RS |
161 | |
162 | ||
bbf5eb28 | 163 | (defcustom bookmark-sort-flag t |
9848f0ca RS |
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 | |
bbf5eb28 RS |
166 | recently set ones come first, oldest ones come last)." |
167 | :type 'boolean | |
168 | :group 'bookmark) | |
4eadcdf8 RS |
169 | |
170 | ||
bbf5eb28 | 171 | (defcustom bookmark-automatically-show-annotations t |
f0529b5b | 172 | "*nil means don't show annotations when jumping to a bookmark." |
bbf5eb28 RS |
173 | :type 'boolean |
174 | :group 'bookmark) | |
4eadcdf8 RS |
175 | |
176 | ||
bbf5eb28 | 177 | (defcustom bookmark-bmenu-file-column 30 |
4eadcdf8 | 178 | "*Column at which to display filenames in a buffer listing bookmarks. |
bbf5eb28 RS |
179 | You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-toggle-filenames]." |
180 | :type 'integer | |
181 | :group 'bookmark) | |
4eadcdf8 RS |
182 | |
183 | ||
bbf5eb28 | 184 | (defcustom bookmark-bmenu-toggle-filenames t |
4eadcdf8 RS |
185 | "*Non-nil means show filenames when listing bookmarks. |
186 | This may result in truncated bookmark names. To disable this, put the | |
9848f0ca | 187 | following in your `.emacs' file: |
4eadcdf8 | 188 | |
bbf5eb28 RS |
189 | \(setq bookmark-bmenu-toggle-filenames nil\)" |
190 | :type 'boolean | |
191 | :group 'bookmark) | |
4eadcdf8 RS |
192 | |
193 | ||
bbf5eb28 RS |
194 | (defcustom bookmark-menu-length 70 |
195 | "*Maximum length of a bookmark name displayed on a popup menu." | |
196 | :type 'integer | |
197 | :group 'boolean) | |
4eadcdf8 RS |
198 | |
199 | ||
200 | ;;; No user-serviceable parts beyond this point. | |
b3bf02fa | 201 | |
09fd6588 KF |
202 | ;; Is it XEmacs? |
203 | (defconst bookmark-xemacsp | |
204 | (string-match "\\(Lucid\\|Xemacs\\)" emacs-version)) | |
205 | ||
206 | ||
b3bf02fa RS |
207 | ;; Added for lucid emacs compatibility, db |
208 | (or (fboundp 'defalias) (fset 'defalias 'fset)) | |
209 | ||
d22d6453 | 210 | ;; suggested for lucid compatibility by david hughes: |
4eadcdf8 | 211 | (or (fboundp 'frame-height) (defalias 'frame-height 'screen-height)) |
d22d6453 | 212 | |
09fd6588 KF |
213 | ;; This variable is probably obsolete now... |
214 | (or (boundp 'baud-rate) | |
dbe99ae9 | 215 | ;; some random value higher than 9600 |
09fd6588 KF |
216 | (setq baud-rate 19200)) |
217 | ||
e3437989 RS |
218 | |
219 | \f | |
220 | ;;; Keymap stuff: | |
b3bf02fa | 221 | |
77bc05c7 RS |
222 | ;; Set up these bindings dumping time *only*; |
223 | ;; if the user alters them, don't override the user when loading bookmark.el. | |
224 | ||
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) | |
b3bf02fa | 228 | |
d22d6453 | 229 | ;;;###autoload |
9aef3b21 RS |
230 | (defvar bookmark-map nil |
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 | |
b3bf02fa RS |
235 | functions have a binding in this keymap.") |
236 | ||
d22d6453 | 237 | ;;;###autoload |
b3bf02fa RS |
238 | (define-prefix-command 'bookmark-map) |
239 | ||
240 | ;; Read the help on all of these functions for details... | |
d22d6453 | 241 | ;;;###autoload |
b3bf02fa | 242 | (define-key bookmark-map "x" 'bookmark-set) |
d22d6453 RS |
243 | ;;;###autoload |
244 | (define-key bookmark-map "m" 'bookmark-set) ; "m" for "mark" | |
245 | ;;;###autoload | |
b3bf02fa | 246 | (define-key bookmark-map "j" 'bookmark-jump) |
d22d6453 RS |
247 | ;;;###autoload |
248 | (define-key bookmark-map "g" 'bookmark-jump) ; "g" for "go" | |
249 | ;;;###autoload | |
b3bf02fa | 250 | (define-key bookmark-map "i" 'bookmark-insert) |
d22d6453 RS |
251 | ;;;###autoload |
252 | (define-key bookmark-map "e" 'edit-bookmarks) | |
253 | ;;;###autoload | |
e3437989 | 254 | (define-key bookmark-map "f" 'bookmark-insert-location) ; "f" for "find" |
d22d6453 | 255 | ;;;###autoload |
9aef3b21 | 256 | (define-key bookmark-map "r" 'bookmark-rename) |
d22d6453 | 257 | ;;;###autoload |
b3bf02fa | 258 | (define-key bookmark-map "d" 'bookmark-delete) |
d22d6453 | 259 | ;;;###autoload |
b3bf02fa | 260 | (define-key bookmark-map "l" 'bookmark-load) |
d22d6453 RS |
261 | ;;;###autoload |
262 | (define-key bookmark-map "w" 'bookmark-write) | |
263 | ;;;###autoload | |
b3bf02fa RS |
264 | (define-key bookmark-map "s" 'bookmark-save) |
265 | ||
e3437989 RS |
266 | |
267 | ;;; The annotation maps. | |
268 | (defvar bookmark-read-annotation-mode-map (copy-keymap text-mode-map) | |
269 | "Keymap for composing an annotation for a bookmark.") | |
270 | ||
271 | (define-key bookmark-read-annotation-mode-map "\C-c\C-c" | |
272 | 'bookmark-send-annotation) | |
273 | ||
274 | ||
275 | \f | |
276 | ;;; Core variables and data structures: | |
7e2d009d | 277 | (defvar bookmark-alist () |
e3437989 | 278 | "Association list of bookmarks and their records. |
7e2d009d | 279 | You probably don't want to change the value of this alist yourself; |
4eadcdf8 RS |
280 | instead, let the various bookmark functions do it for you. |
281 | ||
282 | The format of the alist is | |
283 | ||
284 | \(BOOKMARK1 BOOKMARK2 ...\) | |
285 | ||
286 | where each BOOKMARK is of the form | |
287 | ||
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\)\) | |
295 | ||
296 | So the cdr of each bookmark is an alist too. | |
297 | `info-node' is optional, by the way.") | |
7e2d009d | 298 | |
e3437989 | 299 | |
d22d6453 RS |
300 | (defvar bookmarks-already-loaded nil) |
301 | ||
e3437989 | 302 | |
b3bf02fa | 303 | ;; more stuff added by db. |
d22d6453 | 304 | |
dbe99ae9 | 305 | (defvar bookmark-current-bookmark nil |
9aef3b21 RS |
306 | "Name of bookmark most recently used in the current file. |
307 | It is buffer local, used to make moving a bookmark forward | |
8027e2ad | 308 | through a file easier.") |
b3bf02fa RS |
309 | |
310 | (make-variable-buffer-local 'bookmark-current-bookmark) | |
311 | ||
e3437989 | 312 | |
b3bf02fa | 313 | (defvar bookmark-alist-modification-count 0 |
9aef3b21 | 314 | "Number of modifications to bookmark list since it was last saved.") |
b3bf02fa | 315 | |
e3437989 | 316 | |
e3437989 | 317 | (defvar bookmark-search-size 16 |
9aef3b21 | 318 | "Length of the context strings recorded on either side of a bookmark.") |
b3bf02fa | 319 | |
e3437989 | 320 | |
b3bf02fa RS |
321 | (defvar bookmark-current-point 0) |
322 | (defvar bookmark-yank-point 0) | |
323 | (defvar bookmark-current-buffer nil) | |
324 | ||
e3437989 RS |
325 | |
326 | \f | |
327 | ;; Helper functions. | |
328 | ||
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. | |
332 | ||
333 | (defun bookmark-name-from-full-record (full-record) | |
4eadcdf8 | 334 | "Return name of FULL-RECORD \(an alist element instead of a string\)." |
e3437989 RS |
335 | (car full-record)) |
336 | ||
337 | ||
338 | (defun bookmark-all-names () | |
339 | "Return a list of all current bookmark names." | |
340 | (bookmark-maybe-load-default-file) | |
341 | (mapcar | |
342 | (lambda (full-record) | |
343 | (bookmark-name-from-full-record full-record)) | |
344 | bookmark-alist)) | |
345 | ||
346 | ||
347 | (defun bookmark-get-bookmark (bookmark) | |
28d80dea GM |
348 | "Return the full entry for BOOKMARK in bookmark-alist. |
349 | If BOOKMARK is not a string, return nil." | |
350 | (when (stringp bookmark) | |
351 | (apply (if bookmark-completion-ignore-case | |
352 | #'assoc-ignore-case | |
353 | #'assoc) | |
354 | (list bookmark bookmark-alist)))) | |
e3437989 RS |
355 | |
356 | ||
357 | (defun bookmark-get-bookmark-record (bookmark) | |
358 | "Return the guts of the entry for BOOKMARK in bookmark-alist. | |
359 | That is, all information but the name." | |
360 | (car (cdr (bookmark-get-bookmark bookmark)))) | |
361 | ||
362 | ||
363 | (defun bookmark-set-name (bookmark newname) | |
364 | "Set BOOKMARK's name to NEWNAME." | |
91169ba7 RS |
365 | (setcar |
366 | (if (stringp bookmark) (bookmark-get-bookmark bookmark) bookmark) | |
367 | newname)) | |
e3437989 RS |
368 | |
369 | ||
370 | (defun bookmark-get-annotation (bookmark) | |
371 | "Return the annotation of BOOKMARK, or nil if none." | |
372 | (cdr (assq 'annotation (bookmark-get-bookmark-record bookmark)))) | |
373 | ||
374 | ||
375 | (defun bookmark-set-annotation (bookmark ann) | |
4eadcdf8 | 376 | "Set the annotation of BOOKMARK to ANN." |
e3437989 RS |
377 | (let ((cell (assq 'annotation (bookmark-get-bookmark-record bookmark)))) |
378 | (if cell | |
379 | (setcdr cell ann) | |
380 | (nconc (bookmark-get-bookmark-record bookmark) | |
381 | (list (cons 'annotation ann)))))) | |
382 | ||
383 | ||
384 | (defun bookmark-get-filename (bookmark) | |
385 | "Return the full filename of BOOKMARK." | |
386 | (cdr (assq 'filename (bookmark-get-bookmark-record bookmark)))) | |
387 | ||
388 | ||
389 | (defun bookmark-set-filename (bookmark filename) | |
390 | "Set the full filename of BOOKMARK to FILENAME." | |
391 | (let ((cell (assq 'filename (bookmark-get-bookmark-record bookmark)))) | |
392 | (if cell | |
393 | (setcdr cell filename) | |
394 | (nconc (bookmark-get-bookmark-record bookmark) | |
395 | (list (cons 'filename filename)))))) | |
396 | ||
397 | ||
398 | (defun bookmark-get-position (bookmark) | |
399 | "Return the position \(i.e.: point\) of BOOKMARK." | |
400 | (cdr (assq 'position (bookmark-get-bookmark-record bookmark)))) | |
401 | ||
402 | ||
403 | (defun bookmark-set-position (bookmark position) | |
404 | "Set the position \(i.e.: point\) of BOOKMARK to POSITION." | |
405 | (let ((cell (assq 'position (bookmark-get-bookmark-record bookmark)))) | |
406 | (if cell | |
407 | (setcdr cell position) | |
408 | (nconc (bookmark-get-bookmark-record bookmark) | |
409 | (list (cons 'position position)))))) | |
410 | ||
411 | ||
412 | (defun bookmark-get-front-context-string (bookmark) | |
413 | "Return the front-context-string of BOOKMARK." | |
414 | (cdr (assq 'front-context-string (bookmark-get-bookmark-record bookmark)))) | |
415 | ||
416 | ||
417 | (defun bookmark-set-front-context-string (bookmark string) | |
418 | "Set the front-context-string of BOOKMARK to STRING." | |
419 | (let ((cell (assq 'front-context-string | |
420 | (bookmark-get-bookmark-record bookmark)))) | |
421 | (if cell | |
422 | (setcdr cell string) | |
423 | (nconc (bookmark-get-bookmark-record bookmark) | |
424 | (list (cons 'front-context-string string)))))) | |
425 | ||
426 | ||
427 | (defun bookmark-get-rear-context-string (bookmark) | |
428 | "Return the rear-context-string of BOOKMARK." | |
429 | (cdr (assq 'rear-context-string (bookmark-get-bookmark-record bookmark)))) | |
430 | ||
431 | ||
432 | (defun bookmark-set-rear-context-string (bookmark string) | |
433 | "Set the rear-context-string of BOOKMARK to STRING." | |
434 | (let ((cell (assq 'rear-context-string | |
435 | (bookmark-get-bookmark-record bookmark)))) | |
436 | (if cell | |
437 | (setcdr cell string) | |
438 | (nconc (bookmark-get-bookmark-record bookmark) | |
439 | (list (cons 'rear-context-string string)))))) | |
440 | ||
441 | ||
442 | (defun bookmark-get-info-node (bookmark) | |
4eadcdf8 | 443 | "Get the info node associated with BOOKMARK." |
e3437989 | 444 | (cdr (assq 'info-node (bookmark-get-bookmark-record bookmark)))) |
dbe99ae9 | 445 | |
e3437989 RS |
446 | |
447 | (defun bookmark-set-info-node (bookmark node) | |
448 | "Set the Info node of BOOKMARK to NODE." | |
449 | (let ((cell (assq 'info-node | |
450 | (bookmark-get-bookmark-record bookmark)))) | |
451 | (if cell | |
452 | (setcdr cell node) | |
453 | (nconc (bookmark-get-bookmark-record bookmark) | |
a15269c0 KF |
454 | (list (cons 'info-node node))))) |
455 | ||
456 | (message "%S" (assq 'info-node (bookmark-get-bookmark-record bookmark))) | |
457 | (sit-for 4) | |
458 | ) | |
dbe99ae9 | 459 | |
e3437989 | 460 | |
4c0b5ad1 KF |
461 | (defvar bookmark-history nil |
462 | "The history list for bookmark functions.") | |
463 | ||
464 | ||
e3437989 RS |
465 | (defun bookmark-completing-read (prompt &optional default) |
466 | "Prompting with PROMPT, read a bookmark name in completion. | |
467 | PROMPT will get a \": \" stuck on the end no matter what, so you | |
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." | |
471 | (bookmark-maybe-load-default-file) ; paranoia | |
472 | (let* ((completion-ignore-case bookmark-completion-ignore-case) | |
473 | (default default) | |
474 | (prompt (if default | |
475 | (concat prompt (format " (%s): " default)) | |
476 | (concat prompt ": "))) | |
477 | (str | |
478 | (completing-read prompt | |
479 | bookmark-alist | |
480 | nil | |
4c0b5ad1 KF |
481 | 0 |
482 | nil | |
483 | 'bookmark-history))) | |
e3437989 RS |
484 | (if (string-equal "" str) |
485 | (list default) | |
486 | (list str)))) | |
487 | ||
488 | ||
4c0b5ad1 KF |
489 | (defmacro bookmark-maybe-historicize-string (string) |
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'." | |
dbe99ae9 SS |
493 | `(or |
494 | (interactive-p) | |
495 | (setq bookmark-history (cons ,string bookmark-history)))) | |
4c0b5ad1 KF |
496 | |
497 | ||
a15269c0 | 498 | (defun bookmark-make (name &optional annotation overwrite info-node) |
e3437989 RS |
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 | |
a15269c0 KF |
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." | |
e3437989 | 505 | (bookmark-maybe-load-default-file) |
88415bfc | 506 | (let ((stripped-name (copy-sequence name))) |
09fd6588 KF |
507 | (or bookmark-xemacsp |
508 | ;; XEmacs's `set-text-properties' doesn't work on | |
509 | ;; free-standing strings, apparently. | |
510 | (set-text-properties 0 (length stripped-name) nil stripped-name)) | |
88415bfc | 511 | (if (and (bookmark-get-bookmark stripped-name) (not overwrite)) |
3b526bae | 512 | ;; already existing bookmark under that name and |
88415bfc KH |
513 | ;; no prefix arg means just overwrite old bookmark |
514 | (setcdr (bookmark-get-bookmark stripped-name) | |
a15269c0 | 515 | (list (bookmark-make-cell annotation info-node))) |
dbe99ae9 | 516 | |
88415bfc KH |
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...) | |
dbe99ae9 | 520 | |
88415bfc KH |
521 | (setq bookmark-alist |
522 | (cons | |
dbe99ae9 | 523 | (list stripped-name |
a15269c0 | 524 | (bookmark-make-cell annotation info-node)) |
88415bfc | 525 | bookmark-alist))) |
dbe99ae9 | 526 | |
88415bfc KH |
527 | ;; Added by db |
528 | (setq bookmark-current-bookmark stripped-name) | |
529 | (setq bookmark-alist-modification-count | |
530 | (1+ bookmark-alist-modification-count)) | |
531 | (if (bookmark-time-to-save-p) | |
532 | (bookmark-save)))) | |
e3437989 RS |
533 | |
534 | ||
a15269c0 | 535 | (defun bookmark-make-cell (annotation &optional info-node) |
4eadcdf8 | 536 | "Return the record part of a new bookmark, given ANNOTATION. |
e3437989 | 537 | Must be at the correct position in the buffer in which the bookmark is |
a15269c0 KF |
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." | |
541 | (let ((the-record | |
8a946354 SS |
542 | `((filename . ,(bookmark-buffer-file-name)) |
543 | (front-context-string | |
544 | . ,(if (>= (- (point-max) (point)) bookmark-search-size) | |
545 | (buffer-substring-no-properties | |
546 | (point) | |
547 | (+ (point) bookmark-search-size)) | |
548 | nil)) | |
549 | (rear-context-string | |
550 | . ,(if (>= (- (point) (point-min)) bookmark-search-size) | |
551 | (buffer-substring-no-properties | |
552 | (point) | |
553 | (- (point) bookmark-search-size)) | |
554 | nil)) | |
555 | (position . ,(point))))) | |
a15269c0 KF |
556 | |
557 | ;; Now fill in the optional parts: | |
91169ba7 RS |
558 | |
559 | ;; Take no chances with text properties | |
560 | (set-text-properties 0 (length annotation) nil annotation) | |
561 | (set-text-properties 0 (length info-node) nil info-node) | |
562 | ||
a15269c0 KF |
563 | (if annotation |
564 | (nconc the-record (list (cons 'annotation annotation)))) | |
565 | (if info-node | |
566 | (nconc the-record (list (cons 'info-node info-node)))) | |
567 | ||
568 | ;; Finally, return the completed record. | |
569 | the-record)) | |
dbe99ae9 SS |
570 | |
571 | ||
e3437989 RS |
572 | \f |
573 | ;;; File format stuff | |
574 | ||
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 | |
dbe99ae9 | 603 | ;; accesses it by from then on. |
e3437989 RS |
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 | ;; | |
dbe99ae9 | 610 | ;; STRING-BEHIND is the same thing, but after the point. |
e3437989 RS |
611 | ;; |
612 | ;; The context strings exist so that modifications to a file don't | |
dbe99ae9 | 613 | ;; necessarily cause a bookmark's position to be invalidated. |
e3437989 RS |
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. | |
a15269c0 | 617 | ;; ANNOTATION is the annotation for the bookmark; it may not exist |
e3437989 RS |
618 | ;; (for backward compatibility), be nil (no annotation), or be a |
619 | ;; string. | |
e3437989 RS |
620 | |
621 | ||
622 | (defconst bookmark-file-format-version 1 | |
623 | "The current version of the format used by bookmark files. | |
624 | You should never need to change this.") | |
625 | ||
626 | ||
627 | (defconst bookmark-end-of-version-stamp-marker | |
628 | "-*- End Of Bookmark File Format Version Stamp -*-\n" | |
629 | "This string marks the end of the version stamp in a bookmark file.") | |
630 | ||
631 | ||
632 | (defun bookmark-alist-from-buffer () | |
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." | |
637 | (save-excursion | |
638 | (goto-char (point-min)) | |
639 | (if (search-forward bookmark-end-of-version-stamp-marker nil t) | |
640 | (read (current-buffer)) | |
641 | ;; Else we're dealing with format version 0 | |
642 | (if (search-forward "(" nil t) | |
643 | (progn | |
644 | (forward-char -1) | |
645 | (read (current-buffer))) | |
646 | ;; Else no hope of getting information here. | |
a3ad20c2 | 647 | (error "Not bookmark format"))))) |
e3437989 RS |
648 | |
649 | ||
650 | (defun bookmark-upgrade-version-0-alist (old-list) | |
4eadcdf8 | 651 | "Upgrade a version 0 alist OLD-LIST to the current version." |
e3437989 RS |
652 | (mapcar |
653 | (lambda (bookmark) | |
654 | (let* ((name (car bookmark)) | |
655 | (record (car (cdr bookmark))) | |
656 | (filename (nth 0 record)) | |
657 | (front-str (nth 1 record)) | |
658 | (rear-str (nth 2 record)) | |
659 | (position (nth 3 record)) | |
660 | (ann (nth 4 record))) | |
661 | (list | |
662 | name | |
8a946354 SS |
663 | `((filename . ,filename) |
664 | (front-context-string . ,(or front-str "")) | |
665 | (rear-context-string . ,(or rear-str "")) | |
666 | (position . ,position) | |
667 | (annotation . ,ann))))) | |
e3437989 RS |
668 | old-list)) |
669 | ||
670 | ||
671 | (defun bookmark-upgrade-file-format-from-0 () | |
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." | |
674 | (message "Upgrading bookmark format from 0 to %d..." | |
675 | bookmark-file-format-version) | |
676 | (let* ((old-list (bookmark-alist-from-buffer)) | |
677 | (new-list (bookmark-upgrade-version-0-alist old-list))) | |
678 | (delete-region (point-min) (point-max)) | |
679 | (bookmark-insert-file-format-version-stamp) | |
680 | (pp new-list (current-buffer)) | |
681 | (save-buffer)) | |
682 | (goto-char (point-min)) | |
60d0378e | 683 | (message "Upgrading bookmark format from 0 to %d...done" |
e3437989 RS |
684 | bookmark-file-format-version) |
685 | ) | |
686 | ||
687 | ||
688 | (defun bookmark-grok-file-format-version () | |
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." | |
691 | (if (looking-at "^;;;;") | |
692 | (save-excursion | |
693 | (save-match-data | |
694 | (re-search-forward "[0-9]") | |
695 | (forward-char -1) | |
696 | (read (current-buffer)))) | |
697 | ;; Else this is format version 0, the original one, which didn't | |
698 | ;; even have version stamps. | |
699 | 0)) | |
700 | ||
701 | ||
702 | (defun bookmark-maybe-upgrade-file-format () | |
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." | |
706 | (let ((version (bookmark-grok-file-format-version))) | |
707 | (cond | |
708 | ((= version bookmark-file-format-version) | |
709 | ) ; home free -- version is current | |
710 | ((= version 0) | |
711 | (bookmark-upgrade-file-format-from-0)) | |
712 | (t | |
a3ad20c2 | 713 | (error "Bookmark file format version strangeness"))))) |
e3437989 RS |
714 | |
715 | ||
716 | (defun bookmark-insert-file-format-version-stamp () | |
5e0e5feb | 717 | "Insert text indicating current version of bookmark file format." |
e3437989 RS |
718 | (insert |
719 | (format ";;;; Emacs Bookmark Format Version %d ;;;;\n" | |
720 | bookmark-file-format-version)) | |
721 | (insert ";;; This format is meant to be slightly human-readable;\n" | |
722 | ";;; nevertheless, you probably don't want to edit it.\n" | |
723 | ";;; " | |
724 | bookmark-end-of-version-stamp-marker)) | |
725 | ||
726 | ||
727 | ;;; end file-format stuff | |
728 | ||
729 | \f | |
730 | ;;; Core code: | |
731 | ||
d22d6453 | 732 | ;;;###autoload |
4eadcdf8 RS |
733 | (defun bookmark-set (&optional name parg) |
734 | "Set a bookmark named NAME inside a file. | |
735 | If name is nil, then the user will be prompted. | |
9aef3b21 RS |
736 | With prefix arg, will not overwrite a bookmark that has the same name |
737 | as NAME if such a bookmark already exists, but instead will \"push\" | |
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. | |
b3bf02fa RS |
742 | |
743 | To yank words from the text of the buffer and use them as part of the | |
9aef3b21 | 744 | bookmark name, type C-w while setting a bookmark. Successive C-w's |
b3bf02fa RS |
745 | yank successive words. |
746 | ||
4c0b5ad1 KF |
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. | |
b3bf02fa RS |
751 | |
752 | Use \\[bookmark-delete] to remove bookmarks \(you give it a name, | |
753 | and it removes only the first instance of a bookmark with that name from | |
754 | the list of bookmarks.\)" | |
4eadcdf8 | 755 | (interactive (list nil current-prefix-arg)) |
e3437989 RS |
756 | (or |
757 | (bookmark-buffer-file-name) | |
a3ad20c2 | 758 | (error "Buffer not visiting a file or directory")) |
e3437989 RS |
759 | |
760 | (bookmark-maybe-load-default-file) | |
761 | ||
b3bf02fa RS |
762 | (setq bookmark-current-point (point)) |
763 | (setq bookmark-yank-point (point)) | |
764 | (setq bookmark-current-buffer (current-buffer)) | |
e3437989 | 765 | |
d22d6453 | 766 | (let* ((default (or bookmark-current-bookmark |
e3437989 | 767 | (bookmark-buffer-name))) |
d22d6453 | 768 | (str |
4eadcdf8 RS |
769 | (or name |
770 | (read-from-minibuffer | |
771 | (format "Set bookmark (%s): " default) | |
772 | nil | |
773 | (let ((now-map (copy-keymap minibuffer-local-map))) | |
91169ba7 RS |
774 | (define-key now-map "\C-w" 'bookmark-yank-word) |
775 | (define-key now-map "\C-u" 'bookmark-insert-current-bookmark) | |
4eadcdf8 | 776 | now-map)))) |
e3437989 RS |
777 | (annotation nil)) |
778 | (and (string-equal str "") (setq str default)) | |
dbe99ae9 | 779 | ;; Ask for an annotation buffer for this bookmark |
e3437989 RS |
780 | (if bookmark-use-annotations |
781 | (bookmark-read-annotation parg str) | |
91169ba7 RS |
782 | (bookmark-make str annotation parg (bookmark-info-current-node)) |
783 | (setq bookmark-current-bookmark str) | |
784 | (bookmark-bmenu-surreptitiously-rebuild-list) | |
785 | (goto-char bookmark-current-point)))) | |
e3437989 RS |
786 | |
787 | ||
a15269c0 KF |
788 | (defun bookmark-info-current-node () |
789 | "If in Info-mode, return current node name (a string), else nil." | |
790 | (if (eq major-mode 'Info-mode) | |
791 | Info-current-node)) | |
792 | ||
793 | ||
e3437989 RS |
794 | (defun bookmark-kill-line (&optional newline-too) |
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." | |
798 | (let ((eol (save-excursion (end-of-line) (point)))) | |
799 | (delete-region (point) eol) | |
800 | (if (and newline-too (looking-at "\n")) | |
801 | (delete-char 1)))) | |
802 | ||
803 | ||
4c0b5ad1 KF |
804 | ;; Defvars to avoid compilation warnings: |
805 | (defvar bookmark-annotation-paragraph nil) | |
806 | (defvar bookmark-annotation-name nil) | |
807 | (defvar bookmark-annotation-buffer nil) | |
808 | (defvar bookmark-annotation-file nil) | |
809 | (defvar bookmark-annotation-point nil) | |
810 | ||
811 | ||
e3437989 | 812 | (defun bookmark-send-annotation () |
5e0e5feb RS |
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 | |
e3437989 RS |
816 | the bookmark (and file, and point) specified in buffer local variables." |
817 | (interactive) | |
818 | (if (not (eq major-mode 'bookmark-read-annotation-mode)) | |
a3ad20c2 | 819 | (error "Not in bookmark-read-annotation-mode")) |
e3437989 RS |
820 | (goto-char (point-min)) |
821 | (while (< (point) (point-max)) | |
822 | (if (looking-at "^#") | |
823 | (bookmark-kill-line t) | |
824 | (forward-line 1))) | |
91169ba7 | 825 | (let ((annotation (buffer-string)) |
e3437989 RS |
826 | (parg bookmark-annotation-paragraph) |
827 | (bookmark bookmark-annotation-name) | |
828 | (pt bookmark-annotation-point) | |
829 | (buf bookmark-annotation-buffer)) | |
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? | |
dbe99ae9 | 835 | (save-excursion |
e3437989 RS |
836 | (pop-to-buffer buf) |
837 | (goto-char pt) | |
a15269c0 | 838 | (bookmark-make bookmark annotation parg (bookmark-info-current-node)) |
e3437989 RS |
839 | (setq bookmark-current-bookmark bookmark)) |
840 | (bookmark-bmenu-surreptitiously-rebuild-list) | |
841 | (goto-char bookmark-current-point)) | |
842 | (kill-buffer (current-buffer))) | |
843 | ||
844 | ||
845 | (defun bookmark-default-annotation-text (bookmark) | |
846 | (concat "# Type the annotation for bookmark '" bookmark "' here.\n" | |
847 | "# All lines which start with a '#' will be deleted.\n" | |
848 | "# Type C-c C-c when done.\n#\n" | |
849 | "# Author: " (user-full-name) " <" (user-login-name) "@" | |
850 | (system-name) ">\n" | |
851 | "# Date: " (current-time-string) "\n")) | |
852 | ||
853 | ||
854 | (defvar bookmark-read-annotation-text-func 'bookmark-default-annotation-text | |
5e0e5feb RS |
855 | "Function to return default text to use for a bookmark annotation. |
856 | It takes the name of the bookmark, as a string, as an arg.") | |
e3437989 RS |
857 | |
858 | (defun bookmark-read-annotation-mode (buf point parg bookmark) | |
859 | "Mode for composing annotations for a bookmark. | |
4eadcdf8 | 860 | Wants BUF POINT PARG and BOOKMARK. |
e3437989 RS |
861 | When you have finished composing, type \\[bookmark-send-annotation] to send |
862 | the annotation. | |
863 | ||
864 | \\{bookmark-read-annotation-mode-map} | |
865 | " | |
866 | (interactive) | |
867 | (kill-all-local-variables) | |
868 | (make-local-variable 'bookmark-annotation-paragraph) | |
869 | (make-local-variable 'bookmark-annotation-name) | |
870 | (make-local-variable 'bookmark-annotation-buffer) | |
871 | (make-local-variable 'bookmark-annotation-file) | |
872 | (make-local-variable 'bookmark-annotation-point) | |
873 | (setq bookmark-annotation-paragraph parg) | |
874 | (setq bookmark-annotation-name bookmark) | |
875 | (setq bookmark-annotation-buffer buf) | |
876 | (setq bookmark-annotation-file (buffer-file-name buf)) | |
877 | (setq bookmark-annotation-point point) | |
878 | (use-local-map bookmark-read-annotation-mode-map) | |
879 | (setq major-mode 'bookmark-read-annotation-mode) | |
880 | (insert (funcall bookmark-read-annotation-text-func bookmark)) | |
881 | (run-hooks 'text-mode-hook)) | |
882 | ||
883 | ||
884 | (defun bookmark-read-annotation (parg bookmark) | |
5e0e5feb RS |
885 | "Pop up a buffer for entering a bookmark annotation. |
886 | Text surrounding the bookmark is PARG; the bookmark name is BOOKMARK." | |
e3437989 RS |
887 | (let ((buf (current-buffer)) |
888 | (point (point))) | |
889 | (pop-to-buffer (generate-new-buffer-name "*Bookmark Annotation Compose*")) | |
890 | (bookmark-read-annotation-mode buf point parg bookmark))) | |
891 | ||
892 | ||
893 | (defvar bookmark-edit-annotation-mode-map (copy-keymap text-mode-map) | |
894 | "Keymap for editing an annotation of a bookmark.") | |
895 | ||
896 | ||
897 | (define-key bookmark-edit-annotation-mode-map "\C-c\C-c" | |
898 | 'bookmark-send-edited-annotation) | |
899 | ||
900 | ||
901 | (defun bookmark-edit-annotation-mode (bookmark) | |
902 | "Mode for editing the annotation of bookmark BOOKMARK. | |
903 | When you have finished composing, type \\[bookmark-send-annotation]. | |
904 | ||
905 | \\{bookmark-edit-annotation-mode-map} | |
906 | " | |
907 | (interactive) | |
908 | (kill-all-local-variables) | |
909 | (make-local-variable 'bookmark-annotation-name) | |
910 | (setq bookmark-annotation-name bookmark) | |
911 | (use-local-map bookmark-edit-annotation-mode-map) | |
912 | (setq major-mode 'bookmark-edit-annotation-mode) | |
913 | (insert (funcall bookmark-read-annotation-text-func bookmark)) | |
914 | (let ((annotation (bookmark-get-annotation bookmark))) | |
91169ba7 | 915 | (if (and annotation (not (string-equal annotation ""))) |
e3437989 RS |
916 | (insert annotation))) |
917 | (run-hooks 'text-mode-hook)) | |
918 | ||
919 | ||
920 | (defun bookmark-send-edited-annotation () | |
5e0e5feb | 921 | "Use buffer contents (minus beginning with `#' as annotation for a bookmark." |
e3437989 RS |
922 | (interactive) |
923 | (if (not (eq major-mode 'bookmark-edit-annotation-mode)) | |
a3ad20c2 | 924 | (error "Not in bookmark-edit-annotation-mode")) |
e3437989 RS |
925 | (goto-char (point-min)) |
926 | (while (< (point) (point-max)) | |
927 | (if (looking-at "^#") | |
928 | (bookmark-kill-line t) | |
929 | (forward-line 1))) | |
91169ba7 | 930 | (let ((annotation (buffer-string)) |
e3437989 RS |
931 | (bookmark bookmark-annotation-name)) |
932 | (bookmark-set-annotation bookmark annotation) | |
933 | (bookmark-bmenu-surreptitiously-rebuild-list) | |
934 | (goto-char bookmark-current-point)) | |
935 | (kill-buffer (current-buffer))) | |
936 | ||
937 | ||
938 | (defun bookmark-edit-annotation (bookmark) | |
939 | "Pop up a buffer for editing bookmark BOOKMARK's annotation." | |
940 | (let ((buf (current-buffer)) | |
941 | (point (point))) | |
942 | (pop-to-buffer (generate-new-buffer-name "*Bookmark Annotation Compose*")) | |
943 | (bookmark-edit-annotation-mode bookmark))) | |
944 | ||
b3bf02fa RS |
945 | |
946 | (defun bookmark-insert-current-bookmark () | |
5e0e5feb RS |
947 | "Insert this buffer's value of bookmark-current-bookmark. |
948 | Default to file name if it's nil." | |
b3bf02fa RS |
949 | (interactive) |
950 | (let ((str | |
951 | (save-excursion | |
952 | (set-buffer bookmark-current-buffer) | |
953 | bookmark-current-bookmark))) | |
4cd51172 | 954 | (if str (insert str) (bookmark-insert-buffer-name)))) |
b3bf02fa | 955 | |
e3437989 | 956 | |
4cd51172 | 957 | (defun bookmark-insert-buffer-name () |
5e0e5feb RS |
958 | "Insert the current file name into the bookmark name being set. |
959 | The directory part of the file name is not used." | |
b3bf02fa | 960 | (interactive) |
e3437989 RS |
961 | (let ((str |
962 | (save-excursion | |
963 | (set-buffer bookmark-current-buffer) | |
4cd51172 | 964 | (bookmark-buffer-name)))) |
e3437989 RS |
965 | (insert str))) |
966 | ||
b3bf02fa | 967 | |
4cd51172 RS |
968 | (defun bookmark-buffer-name () |
969 | "Return the name of the current buffer's file, non-directory. | |
970 | In Info, return the current node." | |
971 | (cond | |
972 | ;; Are we in Info? | |
973 | ((string-equal mode-name "Info") Info-current-node) | |
974 | ;; Or are we a file? | |
975 | (buffer-file-name (file-name-nondirectory buffer-file-name)) | |
976 | ;; Or are we a directory? | |
977 | ((and (boundp 'dired-directory) dired-directory) | |
978 | (let* ((dirname (if (stringp dired-directory) | |
979 | dired-directory | |
980 | (car dired-directory))) | |
981 | (idx (1- (length dirname)))) | |
982 | ;; Strip the trailing slash. | |
983 | (if (= ?/ (aref dirname idx)) | |
984 | (file-name-nondirectory (substring dirname 0 idx)) | |
985 | ;; Else return the current-buffer | |
986 | (buffer-name (current-buffer))))) | |
987 | ;; If all else fails, use the buffer's name. | |
988 | (t | |
989 | (buffer-name (current-buffer))))) | |
990 | ||
991 | ||
b3bf02fa RS |
992 | (defun bookmark-yank-word () |
993 | (interactive) | |
994 | ;; get the next word from the buffer and append it to the name of | |
995 | ;; the bookmark currently being set. | |
996 | (let ((string (save-excursion | |
d22d6453 RS |
997 | (set-buffer bookmark-current-buffer) |
998 | (goto-char bookmark-yank-point) | |
88415bfc | 999 | (buffer-substring-no-properties |
d22d6453 | 1000 | (point) |
91169ba7 | 1001 | (progn |
d22d6453 RS |
1002 | (forward-word 1) |
1003 | (setq bookmark-yank-point (point))))))) | |
b3bf02fa RS |
1004 | (insert string))) |
1005 | ||
b3bf02fa RS |
1006 | |
1007 | (defun bookmark-buffer-file-name () | |
e3437989 RS |
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." | |
1010 | (if (eq major-mode 'Info-mode) | |
1011 | Info-current-file | |
1012 | (or | |
1013 | buffer-file-name | |
1014 | (if (and (boundp 'dired-directory) dired-directory) | |
1015 | (if (stringp dired-directory) | |
1016 | dired-directory | |
1017 | (car dired-directory)))))) | |
1018 | ||
1019 | ||
e3437989 | 1020 | (defun bookmark-maybe-load-default-file () |
d22d6453 RS |
1021 | (and (not bookmarks-already-loaded) |
1022 | (null bookmark-alist) | |
e3437989 RS |
1023 | (prog2 |
1024 | (and | |
1025 | ;; Possibly the old bookmark file, "~/.emacs-bkmrks", needs | |
1026 | ;; to be renamed. | |
1027 | (file-exists-p (expand-file-name bookmark-old-default-file)) | |
1028 | (not (file-exists-p (expand-file-name bookmark-default-file))) | |
1029 | (rename-file (expand-file-name bookmark-old-default-file) | |
1030 | (expand-file-name bookmark-default-file))) | |
1031 | ;; return t so the `and' will continue... | |
1032 | t) | |
dbe99ae9 | 1033 | |
e3437989 | 1034 | (file-readable-p (expand-file-name bookmark-default-file)) |
91169ba7 RS |
1035 | (bookmark-load bookmark-default-file t t) |
1036 | (setq bookmarks-already-loaded t))) | |
d22d6453 | 1037 | |
e3437989 | 1038 | |
d22d6453 RS |
1039 | (defun bookmark-maybe-sort-alist () |
1040 | ;;Return the bookmark-alist for display. If the bookmark-sort-flag | |
1041 | ;;is non-nil, then return a sorted copy of the alist. | |
1042 | (if bookmark-sort-flag | |
1043 | (setq bookmark-alist | |
1044 | (sort (copy-alist bookmark-alist) | |
1045 | (function | |
1046 | (lambda (x y) (string-lessp (car x) (car y)))))))) | |
1047 | ||
e3437989 | 1048 | |
d22d6453 | 1049 | ;;;###autoload |
4eadcdf8 | 1050 | (defun bookmark-jump (bookmark) |
dbe99ae9 | 1051 | "Jump to bookmark BOOKMARK (a point in some file). |
9aef3b21 RS |
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 | |
d22d6453 RS |
1055 | this. |
1056 | ||
e3437989 RS |
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." | |
1061 | (interactive | |
1062 | (bookmark-completing-read "Jump to bookmark" bookmark-current-bookmark)) | |
4eadcdf8 RS |
1063 | (bookmark-maybe-historicize-string bookmark) |
1064 | (let ((cell (bookmark-jump-noselect bookmark))) | |
d22d6453 RS |
1065 | (and cell |
1066 | (switch-to-buffer (car cell)) | |
e3437989 | 1067 | (goto-char (cdr cell)) |
2c9ad69f KF |
1068 | (if bookmark-automatically-show-annotations |
1069 | ;; if there is an annotation for this bookmark, | |
1070 | ;; show it in a buffer. | |
4eadcdf8 | 1071 | (bookmark-show-annotation bookmark))))) |
e3437989 | 1072 | |
d22d6453 | 1073 | |
8d56596c GM |
1074 | (defun bookmark-file-or-variation-thereof (file) |
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." | |
dbe99ae9 | 1077 | (cond |
8d56596c GM |
1078 | ((file-exists-p file) file) |
1079 | ((file-exists-p (concat file ".Z")) (concat file ".Z")) | |
1080 | ((file-exists-p (concat file ".gz")) (concat file ".gz")) | |
1081 | ((file-exists-p (concat file ".z")) (concat file ".z")) | |
1082 | ((file-exists-p (concat file ".info")) (concat file ".info")) | |
1083 | ((file-exists-p (concat file ".info.gz")) (concat file ".info.gz")) | |
1084 | ((file-exists-p (concat file ".info.Z")) (concat file ".info.Z")) | |
1085 | ((file-exists-p (concat file ".info.z")) (concat file ".info.z")) | |
1086 | ((vc-backend file) file) ; maybe VC has it? | |
1087 | (t nil))) | |
1088 | ||
1089 | ||
d22d6453 RS |
1090 | (defun bookmark-jump-noselect (str) |
1091 | ;; a leetle helper for bookmark-jump :-) | |
1092 | ;; returns (BUFFER . POINT) | |
e3437989 RS |
1093 | (bookmark-maybe-load-default-file) |
1094 | (let* ((file (expand-file-name (bookmark-get-filename str))) | |
1095 | (forward-str (bookmark-get-front-context-string str)) | |
1096 | (behind-str (bookmark-get-rear-context-string str)) | |
1097 | (place (bookmark-get-position str)) | |
1098 | (info-node (bookmark-get-info-node str)) | |
1099 | (orig-file file) | |
1100 | ) | |
8d56596c | 1101 | (if (setq file (bookmark-file-or-variation-thereof file)) |
e3437989 | 1102 | (save-excursion |
e197b151 RS |
1103 | (save-window-excursion |
1104 | (if info-node | |
1105 | ;; Info nodes must be visited with care. | |
1106 | (progn | |
1107 | (require 'info) | |
1108 | (Info-find-node file info-node)) | |
1109 | ;; Else no Info. Can do an ordinary find-file: | |
1110 | (set-buffer (find-file-noselect file)) | |
1111 | (goto-char place)) | |
1112 | ||
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. | |
1118 | (if forward-str | |
1119 | (if (search-forward forward-str (point-max) t) | |
1120 | (goto-char (match-beginning 0)))) | |
1121 | (if behind-str | |
1122 | (if (search-backward behind-str (point-min) t) | |
1123 | (goto-char (match-end 0)))) | |
1124 | ;; added by db | |
1125 | (setq bookmark-current-bookmark str) | |
1126 | (cons (current-buffer) (point)))) | |
1127 | ||
91169ba7 RS |
1128 | ;; Else unable to find the marked file, so ask if user wants to |
1129 | ;; relocate the bookmark, else remind them to consider deletion. | |
1130 | (ding) | |
1131 | (if (y-or-n-p (concat (file-name-nondirectory orig-file) | |
1132 | " nonexistent. Relocate \"" | |
1133 | str | |
1134 | "\"? ")) | |
1135 | (progn | |
1136 | (bookmark-relocate str) | |
1137 | ;; gasp! It's a recursive function call in Emacs Lisp! | |
1138 | (bookmark-jump-noselect str)) | |
dbe99ae9 | 1139 | (message |
91169ba7 RS |
1140 | "Bookmark not relocated; consider removing it \(%s\)." str) |
1141 | nil)))) | |
e3437989 | 1142 | |
d22d6453 RS |
1143 | |
1144 | ;;;###autoload | |
4eadcdf8 | 1145 | (defun bookmark-relocate (bookmark) |
5e0e5feb RS |
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." | |
e3437989 | 1150 | (interactive (bookmark-completing-read "Bookmark to relocate")) |
4eadcdf8 | 1151 | (bookmark-maybe-historicize-string bookmark) |
e3437989 | 1152 | (bookmark-maybe-load-default-file) |
4eadcdf8 | 1153 | (let* ((bmrk-filename (bookmark-get-filename bookmark)) |
d22d6453 | 1154 | (newloc (expand-file-name |
e3437989 | 1155 | (read-file-name |
4eadcdf8 | 1156 | (format "Relocate %s to: " bookmark) |
e3437989 | 1157 | (file-name-directory bmrk-filename))))) |
91169ba7 RS |
1158 | (bookmark-set-filename bookmark newloc) |
1159 | (bookmark-bmenu-surreptitiously-rebuild-list))) | |
e3437989 | 1160 | |
d22d6453 RS |
1161 | |
1162 | ;;;###autoload | |
4eadcdf8 | 1163 | (defun bookmark-insert-location (bookmark &optional no-history) |
4c0b5ad1 KF |
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'." | |
e3437989 | 1167 | (interactive (bookmark-completing-read "Insert bookmark location")) |
4eadcdf8 | 1168 | (or no-history (bookmark-maybe-historicize-string bookmark)) |
7e510a5e RS |
1169 | (let ((start (point))) |
1170 | (prog1 | |
1171 | (insert (bookmark-location bookmark)) ; *Return this line* | |
59cfe8b9 | 1172 | (if (and (display-color-p) (display-mouse-p)) |
2fbb6576 EZ |
1173 | (add-text-properties start |
1174 | (save-excursion (re-search-backward | |
1175 | "[^ \t]") | |
1176 | (1+ (point))) | |
1177 | '(mouse-face highlight | |
1178 | help-echo "mouse-2: go to this bookmark")))))) | |
e3437989 | 1179 | |
fbd98d61 | 1180 | ;;;###autoload |
a15269c0 | 1181 | (defalias 'bookmark-locate 'bookmark-insert-location) |
e3437989 | 1182 | |
4eadcdf8 | 1183 | (defun bookmark-location (bookmark) |
e3437989 RS |
1184 | "Return the name of the file associated with BOOKMARK." |
1185 | (bookmark-maybe-load-default-file) | |
4eadcdf8 | 1186 | (bookmark-get-filename bookmark)) |
e3437989 | 1187 | |
d22d6453 RS |
1188 | |
1189 | ;;;###autoload | |
9aef3b21 | 1190 | (defun bookmark-rename (old &optional new) |
5e0e5feb RS |
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. | |
4eadcdf8 | 1194 | |
5e0e5feb | 1195 | If called from Lisp, prompt for NEW if only OLD was passed as an |
4eadcdf8 RS |
1196 | argument. If called with two strings, then no prompting is done. You |
1197 | must pass at least OLD when calling from Lisp. | |
9aef3b21 RS |
1198 | |
1199 | While you are entering the new name, consecutive C-w's insert | |
3b526bae | 1200 | consecutive words from the text of the buffer into the new bookmark |
4c0b5ad1 | 1201 | name." |
e3437989 | 1202 | (interactive (bookmark-completing-read "Old bookmark name")) |
4c0b5ad1 | 1203 | (bookmark-maybe-historicize-string old) |
e3437989 | 1204 | (bookmark-maybe-load-default-file) |
91169ba7 RS |
1205 | |
1206 | (setq bookmark-current-point (point)) | |
1207 | (setq bookmark-yank-point (point)) | |
1208 | (setq bookmark-current-buffer (current-buffer)) | |
1209 | (let ((newname | |
1210 | (or new ; use second arg, if non-nil | |
1211 | (read-from-minibuffer | |
1212 | "New name: " | |
1213 | nil | |
1214 | (let ((now-map (copy-keymap minibuffer-local-map))) | |
1215 | (define-key now-map "\C-w" 'bookmark-yank-word) | |
1216 | now-map) | |
1217 | nil | |
1218 | 'bookmark-history)))) | |
1219 | (bookmark-set-name old newname) | |
1220 | (setq bookmark-current-bookmark newname) | |
1221 | (bookmark-bmenu-surreptitiously-rebuild-list) | |
1222 | (setq bookmark-alist-modification-count | |
1223 | (1+ bookmark-alist-modification-count)) | |
1224 | (if (bookmark-time-to-save-p) | |
1225 | (bookmark-save)))) | |
b3bf02fa | 1226 | |
e3437989 | 1227 | |
d22d6453 | 1228 | ;;;###autoload |
4eadcdf8 | 1229 | (defun bookmark-insert (bookmark) |
dbe99ae9 | 1230 | "Insert the text of the file pointed to by bookmark BOOKMARK. |
9aef3b21 RS |
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 | |
8027e2ad | 1234 | this." |
e3437989 | 1235 | (interactive (bookmark-completing-read "Insert bookmark contents")) |
4eadcdf8 | 1236 | (bookmark-maybe-historicize-string bookmark) |
e3437989 | 1237 | (bookmark-maybe-load-default-file) |
d22d6453 RS |
1238 | (let ((orig-point (point)) |
1239 | (str-to-insert | |
1240 | (save-excursion | |
4eadcdf8 | 1241 | (set-buffer (car (bookmark-jump-noselect bookmark))) |
91169ba7 | 1242 | (buffer-string)))) |
d22d6453 RS |
1243 | (insert str-to-insert) |
1244 | (push-mark) | |
1245 | (goto-char orig-point))) | |
1246 | ||
e3437989 | 1247 | |
d22d6453 | 1248 | ;;;###autoload |
e3437989 | 1249 | (defun bookmark-delete (bookmark &optional batch) |
dbe99ae9 | 1250 | "Delete BOOKMARK from the bookmark list. |
9aef3b21 RS |
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 | |
1253 | not be deleted. Defaults to the \"current\" bookmark \(that is, the | |
e3437989 RS |
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." | |
1257 | (interactive | |
1258 | (bookmark-completing-read "Delete bookmark" bookmark-current-bookmark)) | |
4c0b5ad1 | 1259 | (bookmark-maybe-historicize-string bookmark) |
e3437989 RS |
1260 | (bookmark-maybe-load-default-file) |
1261 | (let ((will-go (bookmark-get-bookmark bookmark))) | |
11eb4275 RS |
1262 | (setq bookmark-alist (delq will-go bookmark-alist)) |
1263 | ;; Added by db, nil bookmark-current-bookmark if the last | |
3b526bae | 1264 | ;; occurrence has been deleted |
e3437989 | 1265 | (or (bookmark-get-bookmark bookmark-current-bookmark) |
11eb4275 | 1266 | (setq bookmark-current-bookmark nil))) |
e3437989 RS |
1267 | ;; Don't rebuild the list |
1268 | (if batch | |
1269 | nil | |
1270 | (bookmark-bmenu-surreptitiously-rebuild-list) | |
1271 | (setq bookmark-alist-modification-count | |
1272 | (1+ bookmark-alist-modification-count)) | |
1273 | (if (bookmark-time-to-save-p) | |
1274 | (bookmark-save)))) | |
1275 | ||
b3bf02fa RS |
1276 | |
1277 | (defun bookmark-time-to-save-p (&optional last-time) | |
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. | |
dbe99ae9 | 1284 | (cond (last-time |
b3bf02fa RS |
1285 | (and (> bookmark-alist-modification-count 0) |
1286 | bookmark-save-flag)) | |
1287 | ((numberp bookmark-save-flag) | |
1288 | (>= bookmark-alist-modification-count bookmark-save-flag)) | |
1289 | (t | |
1290 | nil))) | |
1291 | ||
e3437989 | 1292 | |
d22d6453 | 1293 | ;;;###autoload |
b3bf02fa | 1294 | (defun bookmark-write () |
5e0e5feb RS |
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." | |
b3bf02fa | 1297 | (interactive) |
e3437989 | 1298 | (bookmark-maybe-load-default-file) |
b3bf02fa RS |
1299 | (bookmark-save t)) |
1300 | ||
e3437989 | 1301 | |
d22d6453 | 1302 | ;;;###autoload |
dbe99ae9 | 1303 | (defun bookmark-save (&optional parg file) |
9aef3b21 RS |
1304 | "Save currently defined bookmarks. |
1305 | Saves by default in the file defined by the variable | |
4eadcdf8 RS |
1306 | `bookmark-default-file'. With a prefix arg, save it in file FILE |
1307 | \(second argument\). | |
b3bf02fa RS |
1308 | |
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. | |
1314 | ||
11eb4275 | 1315 | When you want to load in the bookmarks from a file, use |
9aef3b21 | 1316 | \`bookmark-load\', \\[bookmark-load]. That function will prompt you |
11eb4275 | 1317 | for a file, defaulting to the file defined by variable |
e3437989 | 1318 | `bookmark-default-file'." |
b3bf02fa | 1319 | (interactive "P") |
e3437989 | 1320 | (bookmark-maybe-load-default-file) |
b3bf02fa RS |
1321 | (cond |
1322 | ((and (null parg) (null file)) | |
1323 | ;;whether interactive or not, write to default file | |
e3437989 | 1324 | (bookmark-write-file bookmark-default-file)) |
b3bf02fa RS |
1325 | ((and (null parg) file) |
1326 | ;;whether interactive or not, write to given file | |
1327 | (bookmark-write-file file)) | |
1328 | ((and parg (not file)) | |
1329 | ;;have been called interactively w/ prefix arg | |
1330 | (let ((file (read-file-name "File to save bookmarks in: "))) | |
1331 | (bookmark-write-file file))) | |
1332 | (t ; someone called us with prefix-arg *and* a file, so just write to file | |
1333 | (bookmark-write-file file))) | |
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. | |
1337 | (setq bookmark-alist-modification-count 0)) | |
1338 | ||
e3437989 RS |
1339 | |
1340 | \f | |
b3bf02fa RS |
1341 | (defun bookmark-write-file (file) |
1342 | (save-excursion | |
d22d6453 RS |
1343 | (save-window-excursion |
1344 | (if (>= baud-rate 9600) | |
bd0e5b36 | 1345 | (message "Saving bookmarks to file %s..." file)) |
186a7127 | 1346 | (set-buffer (let ((enable-local-variables nil)) |
d23e2c3f | 1347 | (find-file-noselect file))) |
d22d6453 | 1348 | (goto-char (point-min)) |
8a946354 | 1349 | (let ((print-length nil) |
1672462f GM |
1350 | (print-level nil)) |
1351 | (delete-region (point-min) (point-max)) | |
1352 | (bookmark-insert-file-format-version-stamp) | |
1353 | (pp bookmark-alist (current-buffer)) | |
1354 | (let ((version-control | |
1355 | (cond | |
1356 | ((null bookmark-version-control) nil) | |
1357 | ((eq 'never bookmark-version-control) 'never) | |
1358 | ((eq 'nospecial bookmark-version-control) version-control) | |
1359 | (t | |
1360 | t)))) | |
1361 | (write-file file) | |
1362 | (kill-buffer (current-buffer)) | |
1363 | (if (>= baud-rate 9600) | |
1364 | (message "Saving bookmarks to file %s...done" file))))))) | |
e3437989 | 1365 | |
d22d6453 | 1366 | |
91169ba7 RS |
1367 | (defun bookmark-import-new-list (new-list) |
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. | |
1372 | (let ((lst new-list) | |
1373 | (names (bookmark-all-names))) | |
1374 | (while lst | |
1375 | (let* ((full-record (car lst))) | |
1376 | (bookmark-maybe-rename full-record names) | |
1377 | (setq bookmark-alist (nconc bookmark-alist (list full-record))) | |
1378 | (setq names (cons (bookmark-name-from-full-record full-record) names)) | |
1379 | (setq lst (cdr lst)))))) | |
1380 | ||
1381 | ||
1382 | (defun bookmark-maybe-rename (full-record names) | |
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. | |
1388 | (let ((found-name (bookmark-name-from-full-record full-record))) | |
1389 | (if (member found-name names) | |
1390 | ;; We've got a conflict, so generate a new name | |
1391 | (let ((count 2) | |
1392 | (new-name found-name)) | |
1393 | (while (member new-name names) | |
1394 | (setq new-name (concat found-name (format "<%d>" count))) | |
1395 | (setq count (1+ count))) | |
1396 | (bookmark-set-name full-record new-name))))) | |
1397 | ||
1398 | ||
d22d6453 | 1399 | ;;;###autoload |
91169ba7 | 1400 | (defun bookmark-load (file &optional overwrite no-msg) |
9aef3b21 RS |
1401 | "Load bookmarks from FILE (which must be in bookmark format). |
1402 | Appends loaded bookmarks to the front of the list of bookmarks. If | |
91169ba7 | 1403 | optional second argument OVERWRITE is non-nil, existing bookmarks are |
9aef3b21 RS |
1404 | destroyed. Optional third arg NO-MSG means don't display any messages |
1405 | while loading. | |
b3bf02fa RS |
1406 | |
1407 | If you load a file that doesn't contain a proper bookmark alist, you | |
9aef3b21 | 1408 | will corrupt Emacs's bookmark list. Generally, you should only load |
b3bf02fa | 1409 | in files that were created with the bookmark functions in the first |
e3437989 | 1410 | place. Your own personal bookmark file, `~/.emacs.bmk', is |
8027e2ad | 1411 | maintained automatically by Emacs; you shouldn't need to load it |
91169ba7 RS |
1412 | explicitly. |
1413 | ||
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 | |
1416 | unique numeric suffixes \"<2>\", \"<3>\", ... following the same | |
1417 | method buffers use to resolve name collisions." | |
b3bf02fa | 1418 | (interactive |
e3437989 RS |
1419 | (list (read-file-name |
1420 | (format "Load bookmarks from: (%s) " | |
dbe99ae9 | 1421 | bookmark-default-file) |
e3437989 RS |
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. | |
1425 | "~/" bookmark-default-file 'confirm))) | |
b3bf02fa RS |
1426 | (setq file (expand-file-name file)) |
1427 | (if (file-readable-p file) | |
1428 | (save-excursion | |
d22d6453 RS |
1429 | (save-window-excursion |
1430 | (if (and (null no-msg) (>= baud-rate 9600)) | |
bd0e5b36 | 1431 | (message "Loading bookmarks from %s..." file)) |
186a7127 | 1432 | (set-buffer (let ((enable-local-variables nil)) |
d23e2c3f | 1433 | (find-file-noselect file))) |
d22d6453 | 1434 | (goto-char (point-min)) |
e3437989 RS |
1435 | (bookmark-maybe-upgrade-file-format) |
1436 | (let ((blist (bookmark-alist-from-buffer))) | |
d22d6453 RS |
1437 | (if (listp blist) |
1438 | (progn | |
91169ba7 RS |
1439 | (if overwrite |
1440 | (progn | |
1441 | (setq bookmark-alist blist) | |
1442 | (setq bookmark-alist-modification-count 0)) | |
1443 | ;; else | |
1444 | (bookmark-import-new-list blist) | |
1445 | (setq bookmark-alist-modification-count | |
1446 | (1+ bookmark-alist-modification-count))) | |
1447 | (if (string-equal | |
1448 | (expand-file-name bookmark-default-file) | |
1449 | file) | |
1450 | (setq bookmarks-already-loaded t)) | |
dbe99ae9 | 1451 | (bookmark-bmenu-surreptitiously-rebuild-list)) |
a3ad20c2 | 1452 | (error "Invalid bookmark list in %s" file))) |
d22d6453 RS |
1453 | (kill-buffer (current-buffer))) |
1454 | (if (and (null no-msg) (>= baud-rate 9600)) | |
bd0e5b36 | 1455 | (message "Loading bookmarks from %s...done" file))) |
a3ad20c2 | 1456 | (error "Cannot read bookmark file %s" file))) |
b3bf02fa | 1457 | |
d22d6453 | 1458 | |
e3437989 RS |
1459 | \f |
1460 | ;;; Code supporting the dired-like bookmark menu. Prefix is | |
1461 | ;;; "bookmark-bmenu" for "buffer-menu": | |
1462 | ||
1463 | ||
1464 | (defvar bookmark-bmenu-bookmark-column nil) | |
d22d6453 | 1465 | |
d22d6453 | 1466 | |
e3437989 RS |
1467 | (defvar bookmark-bmenu-hidden-bookmarks ()) |
1468 | ||
1469 | ||
e3437989 | 1470 | (defvar bookmark-bmenu-mode-map nil) |
d22d6453 | 1471 | |
d22d6453 | 1472 | |
e3437989 | 1473 | (if bookmark-bmenu-mode-map |
d22d6453 | 1474 | nil |
e3437989 RS |
1475 | (setq bookmark-bmenu-mode-map (make-keymap)) |
1476 | (suppress-keymap bookmark-bmenu-mode-map t) | |
31cd9611 | 1477 | (define-key bookmark-bmenu-mode-map "q" 'quit-window) |
e3437989 RS |
1478 | (define-key bookmark-bmenu-mode-map "v" 'bookmark-bmenu-select) |
1479 | (define-key bookmark-bmenu-mode-map "w" 'bookmark-bmenu-locate) | |
1480 | (define-key bookmark-bmenu-mode-map "2" 'bookmark-bmenu-2-window) | |
1481 | (define-key bookmark-bmenu-mode-map "1" 'bookmark-bmenu-1-window) | |
1482 | (define-key bookmark-bmenu-mode-map "j" 'bookmark-bmenu-this-window) | |
fbd98d61 | 1483 | (define-key bookmark-bmenu-mode-map "\C-c\C-c" 'bookmark-bmenu-this-window) |
e3437989 | 1484 | (define-key bookmark-bmenu-mode-map "f" 'bookmark-bmenu-this-window) |
74002bdf | 1485 | (define-key bookmark-bmenu-mode-map "\C-m" 'bookmark-bmenu-this-window) |
e3437989 | 1486 | (define-key bookmark-bmenu-mode-map "o" 'bookmark-bmenu-other-window) |
fbd98d61 KF |
1487 | (define-key bookmark-bmenu-mode-map "\C-o" |
1488 | 'bookmark-bmenu-switch-other-window) | |
e3437989 RS |
1489 | (define-key bookmark-bmenu-mode-map "s" 'bookmark-bmenu-save) |
1490 | (define-key bookmark-bmenu-mode-map "k" 'bookmark-bmenu-delete) | |
1491 | (define-key bookmark-bmenu-mode-map "\C-d" 'bookmark-bmenu-delete-backwards) | |
1492 | (define-key bookmark-bmenu-mode-map "x" 'bookmark-bmenu-execute-deletions) | |
e3437989 RS |
1493 | (define-key bookmark-bmenu-mode-map "d" 'bookmark-bmenu-delete) |
1494 | (define-key bookmark-bmenu-mode-map " " 'next-line) | |
1495 | (define-key bookmark-bmenu-mode-map "n" 'next-line) | |
1496 | (define-key bookmark-bmenu-mode-map "p" 'previous-line) | |
1497 | (define-key bookmark-bmenu-mode-map "\177" 'bookmark-bmenu-backup-unmark) | |
1498 | (define-key bookmark-bmenu-mode-map "?" 'describe-mode) | |
1499 | (define-key bookmark-bmenu-mode-map "u" 'bookmark-bmenu-unmark) | |
1500 | (define-key bookmark-bmenu-mode-map "m" 'bookmark-bmenu-mark) | |
dbe99ae9 | 1501 | (define-key bookmark-bmenu-mode-map "l" 'bookmark-bmenu-load) |
e3437989 RS |
1502 | (define-key bookmark-bmenu-mode-map "r" 'bookmark-bmenu-rename) |
1503 | (define-key bookmark-bmenu-mode-map "t" 'bookmark-bmenu-toggle-filenames) | |
1504 | (define-key bookmark-bmenu-mode-map "a" 'bookmark-bmenu-show-annotation) | |
1505 | (define-key bookmark-bmenu-mode-map "A" 'bookmark-bmenu-show-all-annotations) | |
7e510a5e RS |
1506 | (define-key bookmark-bmenu-mode-map "e" 'bookmark-bmenu-edit-annotation) |
1507 | (define-key bookmark-bmenu-mode-map [mouse-2] | |
1508 | 'bookmark-bmenu-other-window-with-mouse)) | |
e3437989 | 1509 | |
dbe99ae9 | 1510 | |
e3437989 RS |
1511 | |
1512 | ;; Bookmark Buffer Menu mode is suitable only for specially formatted | |
1513 | ;; data. | |
1514 | (put 'bookmark-bmenu-mode 'mode-class 'special) | |
1515 | ||
1516 | ||
1517 | ;; todo: need to display whether or not bookmark exists as a buffer in | |
dbe99ae9 | 1518 | ;; flag column. |
d22d6453 RS |
1519 | |
1520 | ;; Format: | |
e3437989 RS |
1521 | ;; FLAGS BOOKMARK [ LOCATION ] |
1522 | ||
1523 | ||
1524 | (defun bookmark-bmenu-surreptitiously-rebuild-list () | |
1525 | "Rebuild the Bookmark List if it exists. | |
1526 | Don't affect the buffer ring order." | |
1527 | (if (get-buffer "*Bookmark List*") | |
1528 | (save-excursion | |
dbe99ae9 | 1529 | (save-window-excursion |
e3437989 | 1530 | (bookmark-bmenu-list))))) |
d22d6453 | 1531 | |
d22d6453 RS |
1532 | |
1533 | ;;;###autoload | |
e3437989 | 1534 | (defun bookmark-bmenu-list () |
d22d6453 RS |
1535 | "Display a list of existing bookmarks. |
1536 | The list is displayed in a buffer named `*Bookmark List*'. | |
e3437989 RS |
1537 | The leftmost column displays a D if the bookmark is flagged for |
1538 | deletion, or > if it is flagged for displaying." | |
d22d6453 | 1539 | (interactive) |
e3437989 RS |
1540 | (bookmark-maybe-load-default-file) |
1541 | (if (interactive-p) | |
1542 | (switch-to-buffer (get-buffer-create "*Bookmark List*")) | |
1543 | (set-buffer (get-buffer-create "*Bookmark List*"))) | |
d22d6453 RS |
1544 | (let ((buffer-read-only nil)) |
1545 | (delete-region (point-max) (point-min)) | |
1546 | (goto-char (point-min)) ;sure are playing it safe... | |
1547 | (insert "% Bookmark\n- --------\n") | |
1548 | (bookmark-maybe-sort-alist) | |
e3437989 RS |
1549 | (mapcar |
1550 | (lambda (full-record) | |
3b526bae | 1551 | ;; if a bookmark has an annotation, prepend a "*" |
e3437989 RS |
1552 | ;; in the list of bookmarks. |
1553 | (let ((annotation (bookmark-get-annotation | |
1554 | (bookmark-name-from-full-record full-record)))) | |
91169ba7 | 1555 | (if (and annotation (not (string-equal annotation ""))) |
e3437989 RS |
1556 | (insert " *") |
1557 | (insert " ")) | |
7e510a5e RS |
1558 | (let ((start (point))) |
1559 | (insert (bookmark-name-from-full-record full-record)) | |
59cfe8b9 | 1560 | (if (and (display-color-p) (display-mouse-p)) |
2fbb6576 EZ |
1561 | (add-text-properties start |
1562 | (save-excursion (re-search-backward | |
1563 | "[^ \t]") | |
1564 | (1+ (point))) | |
1565 | '(mouse-face highlight | |
1566 | help-echo "mouse-2: go to this bookmark"))) | |
7e510a5e RS |
1567 | (insert "\n") |
1568 | ))) | |
e3437989 | 1569 | bookmark-alist)) |
d22d6453 RS |
1570 | (goto-char (point-min)) |
1571 | (forward-line 2) | |
e3437989 RS |
1572 | (bookmark-bmenu-mode) |
1573 | (if bookmark-bmenu-toggle-filenames | |
1574 | (bookmark-bmenu-toggle-filenames t))) | |
1575 | ||
1576 | ;;;###autoload | |
1577 | (defalias 'list-bookmarks 'bookmark-bmenu-list) | |
1578 | ;;;###autoload | |
1579 | (defalias 'edit-bookmarks 'bookmark-bmenu-list) | |
d22d6453 | 1580 | |
e3437989 RS |
1581 | |
1582 | ||
1583 | (defun bookmark-bmenu-mode () | |
d22d6453 RS |
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. | |
3b526bae | 1587 | Bookmark names preceded by a \"*\" have annotations. |
e3437989 RS |
1588 | \\<bookmark-bmenu-mode-map> |
1589 | \\[bookmark-bmenu-mark] -- mark bookmark to be displayed. | |
1590 | \\[bookmark-bmenu-select] -- select bookmark of line point is on. | |
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). | |
1593 | \\[bookmark-bmenu-locate] -- display (in minibuffer) location of this bookmark. | |
1594 | \\[bookmark-bmenu-1-window] -- select this bookmark in full-frame window. | |
1595 | \\[bookmark-bmenu-2-window] -- select this bookmark in one window, | |
d22d6453 | 1596 | together with bookmark selected before this one in another window. |
e3437989 RS |
1597 | \\[bookmark-bmenu-this-window] -- select this bookmark in place of the bookmark menu buffer. |
1598 | \\[bookmark-bmenu-other-window] -- select this bookmark in another window, | |
d22d6453 | 1599 | so the bookmark menu bookmark remains visible in its window. |
e3437989 | 1600 | \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark. |
dbe99ae9 | 1601 | \\[bookmark-bmenu-rename] -- rename this bookmark \(prompts for new name\). |
e3437989 | 1602 | \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down. |
dbe99ae9 | 1603 | \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up. |
60d0378e | 1604 | \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'. |
e3437989 | 1605 | \\[bookmark-bmenu-save] -- save the current bookmark list in the default file. |
d22d6453 | 1606 | With a prefix arg, prompts for a file to save in. |
e3437989 RS |
1607 | \\[bookmark-bmenu-load] -- load in a file of bookmarks (prompts for file.) |
1608 | \\[bookmark-bmenu-unmark] -- remove all kinds of marks from current line. | |
d22d6453 | 1609 | With prefix argument, also move up one line. |
e3437989 RS |
1610 | \\[bookmark-bmenu-backup-unmark] -- back up a line and remove marks. |
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. | |
1614 | \\[bookmark-bmenu-edit-annotation] -- edit the annotation for the current bookmark." | |
d22d6453 | 1615 | (kill-all-local-variables) |
e3437989 | 1616 | (use-local-map bookmark-bmenu-mode-map) |
d22d6453 RS |
1617 | (setq truncate-lines t) |
1618 | (setq buffer-read-only t) | |
e3437989 | 1619 | (setq major-mode 'bookmark-bmenu-mode) |
d22d6453 | 1620 | (setq mode-name "Bookmark Menu") |
e3437989 | 1621 | (run-hooks 'bookmark-bmenu-mode-hook)) |
d22d6453 | 1622 | |
e3437989 | 1623 | |
4eadcdf8 | 1624 | (defun bookmark-bmenu-toggle-filenames (&optional show) |
d22d6453 RS |
1625 | "Toggle whether filenames are shown in the bookmark list. |
1626 | Optional argument SHOW means show them unconditionally." | |
1627 | (interactive) | |
1628 | (cond | |
4eadcdf8 | 1629 | (show |
e3437989 RS |
1630 | (setq bookmark-bmenu-toggle-filenames nil) |
1631 | (bookmark-bmenu-show-filenames) | |
1632 | (setq bookmark-bmenu-toggle-filenames t)) | |
1633 | (bookmark-bmenu-toggle-filenames | |
1634 | (bookmark-bmenu-hide-filenames) | |
1635 | (setq bookmark-bmenu-toggle-filenames nil)) | |
d22d6453 | 1636 | (t |
e3437989 RS |
1637 | (bookmark-bmenu-show-filenames) |
1638 | (setq bookmark-bmenu-toggle-filenames t)))) | |
1639 | ||
d22d6453 | 1640 | |
e3437989 RS |
1641 | (defun bookmark-bmenu-show-filenames (&optional force) |
1642 | (if (and (not force) bookmark-bmenu-toggle-filenames) | |
d22d6453 RS |
1643 | nil ;already shown, so do nothing |
1644 | (save-excursion | |
1645 | (save-window-excursion | |
1646 | (goto-char (point-min)) | |
1647 | (forward-line 2) | |
e3437989 | 1648 | (setq bookmark-bmenu-hidden-bookmarks ()) |
d22d6453 RS |
1649 | (let ((buffer-read-only nil)) |
1650 | (while (< (point) (point-max)) | |
e3437989 RS |
1651 | (let ((bmrk (bookmark-bmenu-bookmark))) |
1652 | (setq bookmark-bmenu-hidden-bookmarks | |
1653 | (cons bmrk bookmark-bmenu-hidden-bookmarks)) | |
7e510a5e RS |
1654 | (let ((start (save-excursion (end-of-line) (point)))) |
1655 | (move-to-column bookmark-bmenu-file-column t) | |
1656 | ;; Strip off `mouse-face' from the white spaces region. | |
59cfe8b9 | 1657 | (if (and (display-color-p) (display-mouse-p)) |
7e510a5e | 1658 | (remove-text-properties start (point) |
2fbb6576 | 1659 | '(mouse-face nil help-echo nil)))) |
7e510a5e | 1660 | (delete-region (point) (progn (end-of-line) (point))) |
d22d6453 | 1661 | (insert " ") |
4c0b5ad1 KF |
1662 | ;; Pass the NO-HISTORY arg: |
1663 | (bookmark-insert-location bmrk t) | |
d22d6453 RS |
1664 | (forward-line 1)))))))) |
1665 | ||
e3437989 RS |
1666 | |
1667 | (defun bookmark-bmenu-hide-filenames (&optional force) | |
1668 | (if (and (not force) bookmark-bmenu-toggle-filenames) | |
d22d6453 RS |
1669 | ;; nothing to hide if above is nil |
1670 | (save-excursion | |
1671 | (save-window-excursion | |
1672 | (goto-char (point-min)) | |
1673 | (forward-line 2) | |
e3437989 RS |
1674 | (setq bookmark-bmenu-hidden-bookmarks |
1675 | (nreverse bookmark-bmenu-hidden-bookmarks)) | |
d22d6453 RS |
1676 | (save-excursion |
1677 | (goto-char (point-min)) | |
1678 | (search-forward "Bookmark") | |
1679 | (backward-word 1) | |
e3437989 | 1680 | (setq bookmark-bmenu-bookmark-column (current-column))) |
d22d6453 RS |
1681 | (save-excursion |
1682 | (let ((buffer-read-only nil)) | |
e3437989 RS |
1683 | (while bookmark-bmenu-hidden-bookmarks |
1684 | (move-to-column bookmark-bmenu-bookmark-column t) | |
1685 | (bookmark-kill-line) | |
7e510a5e RS |
1686 | (let ((start (point))) |
1687 | (insert (car bookmark-bmenu-hidden-bookmarks)) | |
59cfe8b9 | 1688 | (if (and (display-color-p) (display-mouse-p)) |
2fbb6576 EZ |
1689 | (add-text-properties start |
1690 | (save-excursion (re-search-backward | |
1691 | "[^ \t]") | |
1692 | (1+ (point))) | |
1693 | '(mouse-face highlight | |
1694 | help-echo | |
1695 | "mouse-2: go to this bookmark")))) | |
e3437989 RS |
1696 | (setq bookmark-bmenu-hidden-bookmarks |
1697 | (cdr bookmark-bmenu-hidden-bookmarks)) | |
d22d6453 RS |
1698 | (forward-line 1)))))))) |
1699 | ||
e3437989 | 1700 | |
e3437989 | 1701 | (defun bookmark-bmenu-check-position () |
91169ba7 RS |
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. | |
d22d6453 RS |
1705 | (cond ((< (count-lines (point-min) (point)) 2) |
1706 | (goto-char (point-min)) | |
1707 | (forward-line 2) | |
91169ba7 | 1708 | bookmark-alist) |
d22d6453 RS |
1709 | ((and (bolp) (eobp)) |
1710 | (beginning-of-line 0) | |
91169ba7 | 1711 | bookmark-alist) |
d22d6453 | 1712 | (t |
91169ba7 | 1713 | bookmark-alist))) |
d22d6453 | 1714 | |
e3437989 RS |
1715 | |
1716 | (defun bookmark-bmenu-bookmark () | |
d22d6453 | 1717 | ;; return a string which is bookmark of this line. |
e3437989 | 1718 | (if (bookmark-bmenu-check-position) |
d22d6453 RS |
1719 | (save-excursion |
1720 | (save-window-excursion | |
1721 | (goto-char (point-min)) | |
1722 | (search-forward "Bookmark") | |
1723 | (backward-word 1) | |
e3437989 RS |
1724 | (setq bookmark-bmenu-bookmark-column (current-column))))) |
1725 | (if bookmark-bmenu-toggle-filenames | |
1726 | (bookmark-bmenu-hide-filenames)) | |
d22d6453 RS |
1727 | (save-excursion |
1728 | (save-window-excursion | |
1729 | (beginning-of-line) | |
e3437989 | 1730 | (forward-char bookmark-bmenu-bookmark-column) |
d22d6453 | 1731 | (prog1 |
dbe99ae9 SS |
1732 | (buffer-substring-no-properties (point) |
1733 | (progn | |
d22d6453 RS |
1734 | (end-of-line) |
1735 | (point))) | |
1736 | ;; well, this is certainly crystal-clear: | |
e3437989 RS |
1737 | (if bookmark-bmenu-toggle-filenames |
1738 | (bookmark-bmenu-toggle-filenames t)))))) | |
d22d6453 | 1739 | |
e3437989 RS |
1740 | |
1741 | (defun bookmark-show-annotation (bookmark) | |
1742 | "Display the annotation for bookmark named BOOKMARK in a buffer, | |
1743 | if an annotation exists." | |
1744 | (let ((annotation (bookmark-get-annotation bookmark))) | |
91169ba7 RS |
1745 | (if (and annotation (not (string-equal annotation ""))) |
1746 | (save-excursion | |
1747 | (let ((old-buf (current-buffer))) | |
1748 | (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t) | |
1749 | (delete-region (point-min) (point-max)) | |
1750 | ;; (insert (concat "Annotation for bookmark '" bookmark "':\n\n")) | |
1751 | (insert annotation) | |
1752 | (goto-char (point-min)) | |
1753 | (pop-to-buffer old-buf)))))) | |
e3437989 RS |
1754 | |
1755 | ||
1756 | (defun bookmark-show-all-annotations () | |
1757 | "Display the annotations for all bookmarks in a buffer." | |
1758 | (let ((old-buf (current-buffer))) | |
1759 | (pop-to-buffer (get-buffer-create "*Bookmark Annotation*") t) | |
1760 | (delete-region (point-min) (point-max)) | |
1761 | (mapcar | |
1762 | (lambda (full-record) | |
1763 | (let* ((name (bookmark-name-from-full-record full-record)) | |
1764 | (ann (bookmark-get-annotation name))) | |
1765 | (insert (concat name ":\n")) | |
91169ba7 | 1766 | (if (and ann (not (string-equal ann ""))) |
e3437989 RS |
1767 | ;; insert the annotation, indented by 4 spaces. |
1768 | (progn | |
1769 | (save-excursion (insert ann)) | |
1770 | (while (< (point) (point-max)) | |
1771 | (beginning-of-line) ; paranoia | |
1772 | (insert " ") | |
1773 | (forward-line) | |
1774 | (end-of-line)))))) | |
1775 | bookmark-alist) | |
1776 | (goto-char (point-min)) | |
1777 | (pop-to-buffer old-buf))) | |
1778 | ||
1779 | ||
1780 | (defun bookmark-bmenu-mark () | |
5e0e5feb | 1781 | "Mark bookmark on this line to be displayed by \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-select]." |
d22d6453 RS |
1782 | (interactive) |
1783 | (beginning-of-line) | |
e3437989 | 1784 | (if (bookmark-bmenu-check-position) |
d22d6453 RS |
1785 | (let ((buffer-read-only nil)) |
1786 | (delete-char 1) | |
1787 | (insert ?>) | |
91169ba7 RS |
1788 | (forward-line 1) |
1789 | (bookmark-bmenu-check-position)))) | |
d22d6453 | 1790 | |
e3437989 RS |
1791 | |
1792 | (defun bookmark-bmenu-select () | |
d22d6453 | 1793 | "Select this line's bookmark; also display bookmarks marked with `>'. |
e3437989 | 1794 | You can mark bookmarks with the \\<bookmark-bmenu-mode-map>\\[bookmark-bmenu-mark] command." |
d22d6453 | 1795 | (interactive) |
e3437989 RS |
1796 | (if (bookmark-bmenu-check-position) |
1797 | (let ((bmrk (bookmark-bmenu-bookmark)) | |
dbe99ae9 | 1798 | (menu (current-buffer)) |
d22d6453 RS |
1799 | (others ()) |
1800 | tem) | |
1801 | (goto-char (point-min)) | |
1802 | (while (re-search-forward "^>" nil t) | |
e3437989 | 1803 | (setq tem (bookmark-bmenu-bookmark)) |
d22d6453 RS |
1804 | (let ((buffer-read-only nil)) |
1805 | (delete-char -1) | |
1806 | (insert ?\ )) | |
dbe99ae9 SS |
1807 | (or (string-equal tem bmrk) |
1808 | (member tem others) | |
d22d6453 RS |
1809 | (setq others (cons tem others)))) |
1810 | (setq others (nreverse others) | |
1811 | tem (/ (1- (frame-height)) (1+ (length others)))) | |
1812 | (delete-other-windows) | |
1813 | (bookmark-jump bmrk) | |
1814 | (bury-buffer menu) | |
4eadcdf8 RS |
1815 | (if others |
1816 | (while others | |
1817 | (split-window nil tem) | |
1818 | (other-window 1) | |
1819 | (bookmark-jump (car others)) | |
1820 | (setq others (cdr others))) | |
d22d6453 RS |
1821 | (other-window 1))))) |
1822 | ||
e3437989 RS |
1823 | |
1824 | (defun bookmark-bmenu-save (parg) | |
d22d6453 RS |
1825 | "Save the current list into a bookmark file. |
1826 | With a prefix arg, prompts for a file to save them in." | |
1827 | (interactive "P") | |
1828 | (save-excursion | |
1829 | (save-window-excursion | |
1830 | (bookmark-save parg)))) | |
1831 | ||
e3437989 RS |
1832 | |
1833 | (defun bookmark-bmenu-load () | |
1834 | "Load the bookmark file and rebuild the bookmark menu-buffer." | |
d22d6453 | 1835 | (interactive) |
e3437989 | 1836 | (if (bookmark-bmenu-check-position) |
d22d6453 RS |
1837 | (save-excursion |
1838 | (save-window-excursion | |
e3437989 | 1839 | ;; This will call `bookmark-bmenu-list' |
d22d6453 RS |
1840 | (call-interactively 'bookmark-load))))) |
1841 | ||
e3437989 RS |
1842 | |
1843 | (defun bookmark-bmenu-1-window () | |
d22d6453 RS |
1844 | "Select this line's bookmark, alone, in full frame." |
1845 | (interactive) | |
e3437989 | 1846 | (if (bookmark-bmenu-check-position) |
d22d6453 | 1847 | (progn |
e3437989 | 1848 | (bookmark-jump (bookmark-bmenu-bookmark)) |
d22d6453 RS |
1849 | (bury-buffer (other-buffer)) |
1850 | (delete-other-windows)))) | |
1851 | ||
e3437989 RS |
1852 | |
1853 | (defun bookmark-bmenu-2-window () | |
d22d6453 RS |
1854 | "Select this line's bookmark, with previous buffer in second window." |
1855 | (interactive) | |
e3437989 RS |
1856 | (if (bookmark-bmenu-check-position) |
1857 | (let ((bmrk (bookmark-bmenu-bookmark)) | |
d22d6453 RS |
1858 | (menu (current-buffer)) |
1859 | (pop-up-windows t)) | |
1860 | (delete-other-windows) | |
1861 | (switch-to-buffer (other-buffer)) | |
e40e3151 KF |
1862 | (let* ((pair (bookmark-jump-noselect bmrk)) |
1863 | (buff (car pair)) | |
1864 | (pos (cdr pair))) | |
1865 | (pop-to-buffer buff) | |
1866 | (goto-char pos)) | |
d22d6453 RS |
1867 | (bury-buffer menu)))) |
1868 | ||
e3437989 RS |
1869 | |
1870 | (defun bookmark-bmenu-this-window () | |
d22d6453 RS |
1871 | "Select this line's bookmark in this window." |
1872 | (interactive) | |
e3437989 RS |
1873 | (if (bookmark-bmenu-check-position) |
1874 | (bookmark-jump (bookmark-bmenu-bookmark)))) | |
d22d6453 | 1875 | |
e3437989 RS |
1876 | |
1877 | (defun bookmark-bmenu-other-window () | |
d22d6453 RS |
1878 | "Select this line's bookmark in other window, leaving bookmark menu visible." |
1879 | (interactive) | |
e3437989 RS |
1880 | (let ((bookmark (bookmark-bmenu-bookmark))) |
1881 | (if (bookmark-bmenu-check-position) | |
e40e3151 KF |
1882 | (let* ((pair (bookmark-jump-noselect bookmark)) |
1883 | (buff (car pair)) | |
1884 | (pos (cdr pair))) | |
e3437989 | 1885 | (switch-to-buffer-other-window buff) |
e40e3151 KF |
1886 | (goto-char pos) |
1887 | (set-window-point (get-buffer-window buff) pos) | |
1888 | (bookmark-show-annotation bookmark))))) | |
1889 | ||
1890 | ||
1891 | (defun bookmark-bmenu-switch-other-window () | |
1892 | "Make the other window select this line's bookmark. | |
1893 | The current window remains selected." | |
1894 | (interactive) | |
e197b151 RS |
1895 | (let ((bookmark (bookmark-bmenu-bookmark)) |
1896 | (pop-up-windows t) | |
dbe99ae9 | 1897 | same-window-buffer-names |
e197b151 | 1898 | same-window-regexps) |
e40e3151 KF |
1899 | (if (bookmark-bmenu-check-position) |
1900 | (let* ((pair (bookmark-jump-noselect bookmark)) | |
1901 | (buff (car pair)) | |
1902 | (pos (cdr pair))) | |
1903 | (display-buffer buff) | |
1904 | (let ((o-buffer (current-buffer))) | |
1905 | ;; save-excursion won't do | |
1906 | (set-buffer buff) | |
1907 | (goto-char pos) | |
1908 | (set-window-point (get-buffer-window buff) pos) | |
1909 | (set-buffer o-buffer)) | |
e3437989 RS |
1910 | (bookmark-show-annotation bookmark))))) |
1911 | ||
7e510a5e RS |
1912 | (defun bookmark-bmenu-other-window-with-mouse (event) |
1913 | "Select bookmark at the mouse pointer in other window, leaving bookmark menu visible." | |
1914 | (interactive "e") | |
1915 | (save-excursion | |
1916 | (set-buffer (window-buffer (posn-window (event-end event)))) | |
1917 | (save-excursion | |
1918 | (goto-char (posn-point (event-end event))) | |
1919 | (bookmark-bmenu-other-window)))) | |
1920 | ||
e3437989 RS |
1921 | |
1922 | (defun bookmark-bmenu-show-annotation () | |
1923 | "Show the annotation for the current bookmark in another window." | |
1924 | (interactive) | |
1925 | (let ((bookmark (bookmark-bmenu-bookmark))) | |
1926 | (if (bookmark-bmenu-check-position) | |
1927 | (bookmark-show-annotation bookmark)))) | |
d22d6453 | 1928 | |
e3437989 RS |
1929 | |
1930 | (defun bookmark-bmenu-show-all-annotations () | |
1931 | "Show the annotation for all bookmarks in another window." | |
1932 | (interactive) | |
1933 | (bookmark-show-all-annotations)) | |
1934 | ||
1935 | ||
1936 | (defun bookmark-bmenu-edit-annotation () | |
1937 | "Edit the annotation for the current bookmark in another window." | |
1938 | (interactive) | |
1939 | (let ((bookmark (bookmark-bmenu-bookmark))) | |
1940 | (if (bookmark-bmenu-check-position) | |
1941 | (bookmark-edit-annotation bookmark)))) | |
1942 | ||
1943 | ||
e3437989 | 1944 | (defun bookmark-bmenu-unmark (&optional backup) |
d22d6453 | 1945 | "Cancel all requested operations on bookmark on this line and move down. |
4eadcdf8 | 1946 | Optional BACKUP means move up." |
d22d6453 RS |
1947 | (interactive "P") |
1948 | (beginning-of-line) | |
e3437989 | 1949 | (if (bookmark-bmenu-check-position) |
d22d6453 RS |
1950 | (progn |
1951 | (let ((buffer-read-only nil)) | |
1952 | (delete-char 1) | |
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. | |
1956 | (insert " ")) | |
91169ba7 RS |
1957 | (forward-line (if backup -1 1)) |
1958 | (bookmark-bmenu-check-position)))) | |
d22d6453 | 1959 | |
e3437989 RS |
1960 | |
1961 | (defun bookmark-bmenu-backup-unmark () | |
d22d6453 RS |
1962 | "Move up and cancel all requested operations on bookmark on line above." |
1963 | (interactive) | |
1964 | (forward-line -1) | |
e3437989 | 1965 | (if (bookmark-bmenu-check-position) |
d22d6453 | 1966 | (progn |
e3437989 | 1967 | (bookmark-bmenu-unmark) |
91169ba7 RS |
1968 | (forward-line -1) |
1969 | (bookmark-bmenu-check-position)))) | |
d22d6453 | 1970 | |
e3437989 RS |
1971 | |
1972 | (defun bookmark-bmenu-delete () | |
5e0e5feb RS |
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]." | |
d22d6453 RS |
1975 | (interactive) |
1976 | (beginning-of-line) | |
e3437989 | 1977 | (if (bookmark-bmenu-check-position) |
d22d6453 RS |
1978 | (let ((buffer-read-only nil)) |
1979 | (delete-char 1) | |
1980 | (insert ?D) | |
91169ba7 RS |
1981 | (forward-line 1) |
1982 | (bookmark-bmenu-check-position)))) | |
d22d6453 | 1983 | |
e3437989 RS |
1984 | |
1985 | (defun bookmark-bmenu-delete-backwards () | |
5e0e5feb RS |
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]." | |
d22d6453 | 1988 | (interactive) |
e3437989 | 1989 | (bookmark-bmenu-delete) |
d22d6453 | 1990 | (forward-line -2) |
e3437989 | 1991 | (if (bookmark-bmenu-check-position) |
91169ba7 RS |
1992 | (forward-line 1)) |
1993 | (bookmark-bmenu-check-position)) | |
d22d6453 | 1994 | |
e3437989 RS |
1995 | |
1996 | (defun bookmark-bmenu-execute-deletions () | |
d22d6453 RS |
1997 | "Delete bookmarks marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands." |
1998 | (interactive) | |
60d0378e | 1999 | (message "Deleting bookmarks...") |
e3437989 RS |
2000 | (let ((hide-em bookmark-bmenu-toggle-filenames) |
2001 | (o-point (point)) | |
2002 | (o-str (save-excursion | |
2003 | (beginning-of-line) | |
2004 | (if (looking-at "^D") | |
2005 | nil | |
2006 | (buffer-substring | |
2007 | (point) | |
2008 | (progn (end-of-line) (point)))))) | |
2009 | (o-col (current-column))) | |
2010 | (if hide-em (bookmark-bmenu-hide-filenames)) | |
2011 | (setq bookmark-bmenu-toggle-filenames nil) | |
d22d6453 RS |
2012 | (goto-char (point-min)) |
2013 | (forward-line 1) | |
e3437989 RS |
2014 | (while (re-search-forward "^D" (point-max) t) |
2015 | (bookmark-delete (bookmark-bmenu-bookmark) t)) ; pass BATCH arg | |
2016 | (bookmark-bmenu-list) | |
2017 | (setq bookmark-bmenu-toggle-filenames hide-em) | |
2018 | (if bookmark-bmenu-toggle-filenames | |
2019 | (bookmark-bmenu-toggle-filenames t)) | |
2020 | (if o-str | |
2021 | (progn | |
2022 | (goto-char (point-min)) | |
2023 | (search-forward o-str) | |
2024 | (beginning-of-line) | |
2025 | (forward-char o-col)) | |
2026 | (goto-char o-point)) | |
2027 | (beginning-of-line) | |
2028 | (setq bookmark-alist-modification-count | |
2029 | (1+ bookmark-alist-modification-count)) | |
2030 | (if (bookmark-time-to-save-p) | |
60d0378e KF |
2031 | (bookmark-save)) |
2032 | (message "Deleting bookmarks...done") | |
2033 | )) | |
e3437989 RS |
2034 | |
2035 | ||
2036 | (defun bookmark-bmenu-rename () | |
d22d6453 RS |
2037 | "Rename bookmark on current line. Prompts for a new name." |
2038 | (interactive) | |
e3437989 RS |
2039 | (if (bookmark-bmenu-check-position) |
2040 | (let ((bmrk (bookmark-bmenu-bookmark)) | |
d22d6453 RS |
2041 | (thispoint (point))) |
2042 | (bookmark-rename bmrk) | |
e3437989 | 2043 | (bookmark-bmenu-list) |
d22d6453 RS |
2044 | (goto-char thispoint)))) |
2045 | ||
e3437989 RS |
2046 | |
2047 | (defun bookmark-bmenu-locate () | |
d22d6453 RS |
2048 | "Display location of this bookmark. Displays in the minibuffer." |
2049 | (interactive) | |
e3437989 RS |
2050 | (if (bookmark-bmenu-check-position) |
2051 | (let ((bmrk (bookmark-bmenu-bookmark))) | |
2052 | (message (bookmark-location bmrk))))) | |
2053 | ||
d22d6453 | 2054 | |
e3437989 RS |
2055 | \f |
2056 | ;;; Menu bar stuff. Prefix is "bookmark-menu". | |
11eb4275 | 2057 | |
e3437989 RS |
2058 | (defun bookmark-menu-build-paned-menu (name entries) |
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." | |
2064 | (let* ((f-height (/ (frame-height) 2)) | |
2065 | (pane-list | |
2066 | (let (temp-pane-list | |
2067 | (iter 0)) | |
2068 | (while entries | |
2069 | (let (lst | |
2070 | (count 0)) | |
2071 | (while (and (< count f-height) entries) | |
2072 | (let ((str (car entries))) | |
2073 | (setq lst (cons | |
2074 | (cons | |
2075 | (if (> (length str) bookmark-menu-length) | |
2076 | (substring str 0 bookmark-menu-length) | |
2077 | str) | |
2078 | str) | |
2079 | lst)) | |
2080 | (setq entries (cdr entries)) | |
2081 | (setq count (1+ count)))) | |
2082 | (setq iter (1+ iter)) | |
2083 | (setq | |
2084 | temp-pane-list | |
2085 | (cons | |
2086 | (cons | |
2087 | (format "-*- %s (%d) -*-" name iter) | |
2088 | (nreverse lst)) | |
2089 | temp-pane-list)))) | |
2090 | (nreverse temp-pane-list)))) | |
2091 | ||
2092 | ;; Return the menu: | |
2093 | (cons (concat "-*- " name " -*-") pane-list))) | |
2094 | ||
2095 | ||
2096 | (defun bookmark-menu-popup-paned-menu (event name entries) | |
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." | |
2101 | (interactive "e") | |
2102 | (x-popup-menu event (bookmark-menu-build-paned-menu name entries))) | |
2103 | ||
2104 | ||
2105 | (defun bookmark-menu-popup-paned-bookmark-menu (event name) | |
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." | |
2109 | (bookmark-menu-popup-paned-menu event name (bookmark-all-names))) | |
2110 | ||
2111 | ||
2112 | (defun bookmark-popup-menu-and-apply-function (func-sym menu-label event) | |
b3bf02fa RS |
2113 | ;; help function for making menus that need to apply a bookmark |
2114 | ;; function to a string. | |
e3437989 RS |
2115 | (let* ((choice (bookmark-menu-popup-paned-bookmark-menu |
2116 | event menu-label))) | |
2117 | (if choice (apply func-sym (list choice))))) | |
b3bf02fa | 2118 | |
e3437989 | 2119 | |
7af04c89 | 2120 | ;;;###autoload |
e3437989 | 2121 | (defun bookmark-menu-insert (event) |
dbe99ae9 | 2122 | "Insert the text of the file pointed to by bookmark BOOKMARK. |
9aef3b21 RS |
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 | |
4eadcdf8 RS |
2126 | this. |
2127 | ||
2128 | Warning: this function only takes an EVENT as argument. Use the | |
2129 | corresponding bookmark function from Lisp \(the one without the | |
2130 | \"-menu-\" in its name\)." | |
b3bf02fa | 2131 | (interactive "e") |
e3437989 RS |
2132 | (bookmark-popup-menu-and-apply-function |
2133 | 'bookmark-insert "Insert Bookmark Contents" event)) | |
b3bf02fa | 2134 | |
e3437989 | 2135 | |
7af04c89 | 2136 | ;;;###autoload |
e3437989 | 2137 | (defun bookmark-menu-jump (event) |
dbe99ae9 | 2138 | "Jump to bookmark BOOKMARK (a point in some file). |
9aef3b21 RS |
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 | |
4eadcdf8 RS |
2142 | this. |
2143 | ||
2144 | Warning: this function only takes an EVENT as argument. Use the | |
2145 | corresponding bookmark function from Lisp \(the one without the | |
2146 | \"-menu-\" in its name\)." | |
b3bf02fa | 2147 | (interactive "e") |
e3437989 RS |
2148 | (bookmark-popup-menu-and-apply-function |
2149 | 'bookmark-jump "Jump to Bookmark" event)) | |
b3bf02fa | 2150 | |
e3437989 | 2151 | |
7af04c89 | 2152 | ;;;###autoload |
e3437989 | 2153 | (defun bookmark-menu-locate (event) |
dbe99ae9 | 2154 | "Insert the name of the file associated with BOOKMARK. |
4eadcdf8 RS |
2155 | \(This is not the same as the contents of that file\). |
2156 | ||
2157 | Warning: this function only takes an EVENT as argument. Use the | |
2158 | corresponding bookmark function from Lisp \(the one without the | |
2159 | \"-menu-\" in its name\)." | |
b3bf02fa | 2160 | (interactive "e") |
e3437989 RS |
2161 | (bookmark-popup-menu-and-apply-function |
2162 | 'bookmark-insert-location "Insert Bookmark Location" event)) | |
b3bf02fa | 2163 | |
e3437989 | 2164 | |
7af04c89 | 2165 | ;;;###autoload |
e3437989 | 2166 | (defun bookmark-menu-rename (event) |
dbe99ae9 | 2167 | "Change the name of OLD-BOOKMARK to NEWNAME. |
d22d6453 RS |
2168 | If called from keyboard, prompts for OLD-BOOKMARK and NEWNAME. |
2169 | If called from menubar, OLD-BOOKMARK is selected from a menu, and | |
dbe99ae9 | 2170 | prompts for NEWNAME. |
d22d6453 RS |
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. | |
9aef3b21 RS |
2174 | |
2175 | While you are entering the new name, consecutive C-w's insert | |
3b526bae | 2176 | consecutive words from the text of the buffer into the new bookmark |
4eadcdf8 RS |
2177 | name. |
2178 | ||
2179 | Warning: this function only takes an EVENT as argument. Use the | |
2180 | corresponding bookmark function from Lisp \(the one without the | |
2181 | \"-menu-\" in its name\)." | |
b3bf02fa | 2182 | (interactive "e") |
e3437989 RS |
2183 | (bookmark-popup-menu-and-apply-function |
2184 | 'bookmark-rename "Rename Bookmark" event)) | |
b3bf02fa | 2185 | |
e3437989 | 2186 | |
7af04c89 | 2187 | ;;;###autoload |
e3437989 | 2188 | (defun bookmark-menu-delete (event) |
dbe99ae9 | 2189 | "Delete the bookmark named NAME from the bookmark list. |
9aef3b21 RS |
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 | |
2192 | not be deleted. Defaults to the \"current\" bookmark \(that is, the | |
4eadcdf8 RS |
2193 | one most recently used in this file, if any\). |
2194 | ||
2195 | Warning: this function only takes an EVENT as argument. Use the | |
2196 | corresponding bookmark function from Lisp \(the one without the | |
2197 | \"-menu-\" in its name\)." | |
b3bf02fa | 2198 | (interactive "e") |
e3437989 RS |
2199 | (bookmark-popup-menu-and-apply-function |
2200 | 'bookmark-delete "Delete Bookmark" event)) | |
2201 | ||
b3bf02fa | 2202 | |
d22d6453 RS |
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. | |
b3bf02fa | 2205 | |
7af04c89 RS |
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. | |
b3bf02fa | 2208 | |
5e0e5feb | 2209 | ;; Emacs menubar stuff. |
09fd6588 | 2210 | |
7af04c89 RS |
2211 | ;;;###autoload |
2212 | (defvar menu-bar-bookmark-map (make-sparse-keymap "Bookmark functions")) | |
09fd6588 | 2213 | |
7af04c89 | 2214 | ;;;###autoload |
4eadcdf8 | 2215 | (defalias 'menu-bar-bookmark-map (symbol-value 'menu-bar-bookmark-map)) |
e3437989 | 2216 | |
09fd6588 KF |
2217 | ;; make bookmarks appear toward the right side of the menu. |
2218 | (if (boundp 'menu-bar-final-items) | |
dbe99ae9 | 2219 | (if menu-bar-final-items |
09fd6588 KF |
2220 | (setq menu-bar-final-items |
2221 | (cons 'bookmark menu-bar-final-items))) | |
2222 | (setq menu-bar-final-items '(bookmark))) | |
2223 | ||
7af04c89 | 2224 | ;;;###autoload |
d22d6453 | 2225 | (define-key menu-bar-bookmark-map [load] |
09fd6588 | 2226 | '("Load a Bookmark File..." . bookmark-load)) |
b3bf02fa | 2227 | |
7af04c89 | 2228 | ;;;###autoload |
d22d6453 | 2229 | (define-key menu-bar-bookmark-map [write] |
09fd6588 | 2230 | '("Save Bookmarks As..." . bookmark-write)) |
d22d6453 | 2231 | |
7af04c89 | 2232 | ;;;###autoload |
d22d6453 | 2233 | (define-key menu-bar-bookmark-map [save] |
09fd6588 | 2234 | '("Save Bookmarks" . bookmark-save)) |
d22d6453 | 2235 | |
7af04c89 | 2236 | ;;;###autoload |
d22d6453 | 2237 | (define-key menu-bar-bookmark-map [edit] |
e3437989 | 2238 | '("Edit Bookmark List" . bookmark-bmenu-list)) |
d22d6453 | 2239 | |
7af04c89 | 2240 | ;;;###autoload |
d22d6453 | 2241 | (define-key menu-bar-bookmark-map [delete] |
0e520d74 | 2242 | '("Delete Bookmark" . bookmark-menu-delete)) |
d22d6453 | 2243 | |
7af04c89 | 2244 | ;;;###autoload |
d22d6453 | 2245 | (define-key menu-bar-bookmark-map [rename] |
0e520d74 | 2246 | '("Rename Bookmark" . bookmark-menu-rename)) |
d22d6453 | 2247 | |
7af04c89 | 2248 | ;;;###autoload |
d22d6453 | 2249 | (define-key menu-bar-bookmark-map [locate] |
0e520d74 | 2250 | '("Insert Location" . bookmark-menu-locate)) |
b3bf02fa | 2251 | |
7af04c89 | 2252 | ;;;###autoload |
d22d6453 | 2253 | (define-key menu-bar-bookmark-map [insert] |
0e520d74 | 2254 | '("Insert Contents" . bookmark-menu-insert)) |
d22d6453 | 2255 | |
7af04c89 | 2256 | ;;;###autoload |
d22d6453 | 2257 | (define-key menu-bar-bookmark-map [set] |
0e520d74 | 2258 | '("Set Bookmark" . bookmark-set)) |
d22d6453 | 2259 | |
7af04c89 | 2260 | ;;;###autoload |
dbe99ae9 | 2261 | (define-key menu-bar-bookmark-map [jump] |
0e520d74 | 2262 | '("Jump to Bookmark" . bookmark-menu-jump)) |
d22d6453 | 2263 | |
e3437989 RS |
2264 | ;;;; end bookmark menu stuff ;;;; |
2265 | ||
2266 | \f | |
2267 | ;;; Load Hook | |
2268 | (defvar bookmark-load-hook nil | |
2269 | "Hook to run at the end of loading bookmark.") | |
2270 | ||
6192b604 KF |
2271 | ;;; Exit Hook, called from kill-emacs-hook |
2272 | (defvar bookmark-exit-hook nil | |
2273 | "Hook to run when emacs exits") | |
dbe99ae9 | 2274 | |
6192b604 KF |
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))) | |
2283 | ||
2284 | (add-hook 'kill-emacs-hook 'bookmark-exit-hook-internal) | |
2285 | ||
2286 | ||
e3437989 | 2287 | (run-hooks 'bookmark-load-hook) |
b3bf02fa | 2288 | |
b3bf02fa | 2289 | (provide 'bookmark) |
dbe99ae9 | 2290 | |
11eb4275 | 2291 | ;;; bookmark.el ends here |