diff options
Diffstat (limited to 'lisp/bookmark.el')
| -rw-r--r-- | lisp/bookmark.el | 1313 |
1 files changed, 0 insertions, 1313 deletions
diff --git a/lisp/bookmark.el b/lisp/bookmark.el deleted file mode 100644 index 0bddad34ada..00000000000 --- a/lisp/bookmark.el +++ /dev/null @@ -1,1313 +0,0 @@ -;;; bookmark.el --- set bookmarks, jump to them later. - -;; Copyright (C) 1993 Free Software Foundation - -;; Author: Karl Fogel <kfogel@cs.oberlin.edu> -;; Maintainer: Karl Fogel <kfogel@cs.oberlin.edu> -;; Created: July, 1993 -;; Version: 2.5 -;; Keywords: bookmarks, placeholders - -;; This file is part of GNU Emacs. - -;; GNU Emacs is free software; you can redistribute it and/or modify -;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation; either version 2, or (at your option) -;; any later version. - -;; GNU Emacs is distributed in the hope that it will be useful, -;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;; GNU General Public License for more details. - -;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to -;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. - -;; Thanks to David Bremner <bremner@cs.sfu.ca> for thinking of and -;; then implementing the bookmark-current-bookmark idea. He even -;; sent *patches*, bless his soul... - -;; Thanks to Gregory M. Saunders <saunders@cis.ohio-state.edu> for -;; fixing and improving bookmark-time-to-save-p. - -;; Thanks go to Andrew V. Klein <avk@rtsg.mot.com> for the code that -;; sorts the alist before presenting it to the user (in list-bookmarks -;; and the menu-bar). - -;; And much thanks to David Hughes <djh@harston.cv.com> for many small -;; suggestions and the code to implement them (like -;; Bookmark-menu-check-position, and some of the Lucid compatibility -;; stuff). - -;; Kudos (whatever they are) go to Jim Blandy <jimb@cs.oberlin.edu> -;; for his eminently sensible suggestion to separate bookmark-jump -;; into bookmark-jump and bookmark-jump-noselect, which made many -;; other things cleaner as well. - -;; Thanks to Roland McGrath for encouragement and help with defining -;; autoloads on the menu-bar. - -;; Jonathan Stigelman <stig@key.amdahl.com> gave patches for default -;; values in bookmark-jump and bookmark-set. Everybody please keep -;; all the keystrokes they save thereby and send them to him at the -;; end of each year :-) (No, seriously, thanks Jonathan!) - -;; Based on info-bookmark.el, by Karl Fogel and Ken Olstad -;; <olstad@msc.edu>. - -;; LCD Archive Entry: -;; bookmark|Karl Fogel|kfogel@cs.oberlin.edu| -;; Setting bookmarks in files or directories, jumping to them later.| -;; 16-July-93|Version: 2.5|~/misc/bookmark.el.Z| - -;; Enough with the credits already, get on to the good stuff: - -;; FAVORITE CHINESE RESTAURANT: -;; Boy, that's a tough one. Probably Hong Min, or maybe Emperor's -;; Choice (both in Chicago's Chinatown). Well, both. How about you? - -;;; Commentary on code: - -;; bookmark alist format: -;; (... -;; (bookmark-name (filename -;; string-in-front -;; string-behind -;; point)) -;; ...) -;; -;; bookmark-name is the string the user gives the bookmark and -;; accesses it by from then on. filename is the location of the file -;; in which the bookmark is set. string-in-front is a string of -;; `bookmark-search-size' chars of context in front of the point the -;; bookmark is set at, string-behind is the same thing after the -;; point. bookmark-jump will search for string-behind and -;; string-in-front in case the file has changed since the bookmark was -;; set. It will attempt to place the user before the changes, if -;; there were any. -;; -;; The bookmark list is sorted lexically by default, but you can turn -;; this off by setting bookmark-sort-flag to nil. If it is nil, then -;; the list will be presented in the order it is recorded -;; (chronologically), which is actually fairly useful as well. - -;;; Code: - -;; Added for lucid emacs compatibility, db -(or (fboundp 'defalias) (fset 'defalias 'fset)) - -;; suggested for lucid compatibility by david hughes: -(or (fboundp 'frame-height) (fset 'frame-height 'screen-height)) - -;; some people have C-x r set to rmail or whatever. We don't want to -;; assume that C-x r is a prefix map just because it's distributed -;; that way... -;; These are the distribution keybindings suggested by RMS, everything -;; else will be done with M-x or the menubar: -;;;###autoload -(if (or (symbolp (key-binding "\C-xr")) - (fboundp 'bookmark-set)) - nil - (progn (define-key ctl-x-map "rb" 'bookmark-jump) - (define-key ctl-x-map "rm" 'bookmark-set) - (define-key ctl-x-map "rl" 'list-bookmarks))) - -;; define the map, so it can be bound by those who desire to do so: - -;;;###autoload -(defvar bookmark-map nil - "Keymap containing bindings to bookmark functions. -It is not bound to any key by default: to bind it -so that you have a bookmark prefix, just use `global-set-key' and bind a -key of your choice to `bookmark-map'. All interactive bookmark -functions have a binding in this keymap.") - -;;;###autoload -(define-prefix-command 'bookmark-map) - -;; Read the help on all of these functions for details... -;;;###autoload -(define-key bookmark-map "x" 'bookmark-set) -;;;###autoload -(define-key bookmark-map "m" 'bookmark-set) ; "m" for "mark" -;;;###autoload -(define-key bookmark-map "j" 'bookmark-jump) -;;;###autoload -(define-key bookmark-map "g" 'bookmark-jump) ; "g" for "go" -;;;###autoload -(define-key bookmark-map "i" 'bookmark-insert) -;;;###autoload -(define-key bookmark-map "e" 'edit-bookmarks) -;;;###autoload -(define-key bookmark-map "f" 'bookmark-locate) ; "f" for "find" -;;;###autoload -(define-key bookmark-map "r" 'bookmark-rename) -;;;###autoload -(define-key bookmark-map "d" 'bookmark-delete) -;;;###autoload -(define-key bookmark-map "l" 'bookmark-load) -;;;###autoload -(define-key bookmark-map "w" 'bookmark-write) -;;;###autoload -(define-key bookmark-map "s" 'bookmark-save) - -(defvar bookmark-alist () - "Association list of bookmarks. -You probably don't want to change the value of this alist yourself; -instead, let the various bookmark functions do it for you.") - -(defvar bookmarks-already-loaded nil) - -;; just add the hook to make sure that people don't lose bookmarks -;; when they kill Emacs, unless they don't want to save them. -(add-hook 'kill-emacs-hook - (function - (lambda () (and (featurep 'bookmark) - bookmark-alist - (bookmark-time-to-save-p t) - (bookmark-save))))) - -;; more stuff added by db. - -(defvar bookmark-current-bookmark nil - "Name of bookmark most recently used in the current file. -It is buffer local, used to make moving a bookmark forward -through a file easier.") - -(make-variable-buffer-local 'bookmark-current-bookmark) - -(defvar bookmark-save-flag t - "*Controls when Emacs saves bookmarks to a file. ---> Nil means never save bookmarks, except when `bookmark-save' is - explicitly called \(\\[bookmark-save]\). ---> t means save bookmarks when Emacs is killed. ---> Otherise, it should be a number that is the frequency with which - the bookmark list is saved \(i.e.: the number of times which - Emacs' bookmark list may be modified before it is automatically - saved.\). If it is a number, Emacs will also automatically save - bookmarks when it is killed. - -Therefore, the way to get it to save every time you make or delete a -bookmark is to set this variable to 1 \(or 0, which produces the same -behavior.\) - -To specify the file in which to save them, modify the variable -bookmark-file, which is `~/.emacs-bkmrks' by default.") - -(defvar bookmark-alist-modification-count 0 - "Number of modifications to bookmark list since it was last saved.") - -(defvar bookmark-file "~/.emacs-bkmrks" - "*File in which to save bookmarks by default.") - -(defvar bookmark-version-control 'nospecial - "This variable controls whether or not to make numbered backups of -the master bookmark file. It can have four values: t, nil, never, and -nospecial. The first three have the same meaning that they do for the -variable version-control, and the final value nospecial means just use -the value of version-control.") - -(defvar bookmark-completion-ignore-case t - "*Non-nil means bookmark functions ignore case in completion.") - -(defvar bookmark-sort-flag t - "*Non-nil means that bookmarks will be displayed sorted by bookmark -name. Otherwise they will be displayed in LIFO order (that is, most -recently set ones come first, oldest ones come last).") - -(defvar bookmark-search-size 500 - "Length of the context strings recorded on either side of a bookmark.") - -(defvar bookmark-current-point 0) -(defvar bookmark-yank-point 0) -(defvar bookmark-current-buffer nil) - -;;;###autoload -(defun bookmark-set (&optional parg) - "Set a bookmark named NAME inside a file. -With prefix arg, will not overwrite a bookmark that has the same name -as NAME if such a bookmark already exists, but instead will \"push\" -the new bookmark onto the bookmark alist. Thus the most recently set -bookmark with name NAME would be the one in effect at any given time, -but the others are still there, should you decide to delete the most -recent one. - -To yank words from the text of the buffer and use them as part of the -bookmark name, type C-w while setting a bookmark. Successive C-w's -yank successive words. - -Typing C-v inserts the name of the current file being visited. Typing -C-u inserts the name of the last bookmark used in the buffer \(as an -aid in using a single bookmark name to track your progress through a -large file\). If no bookmark was used, then C-u behaves like C-v and -inserts the name of the file being visited. - -Use \\[bookmark-delete] to remove bookmarks \(you give it a name, -and it removes only the first instance of a bookmark with that name from -the list of bookmarks.\)" - (interactive "P") - (if (not (bookmark-buffer-file-name)) - (error "Buffer not visiting a file or directory.")) - (bookmark-try-default-file) - (setq bookmark-current-point (point)) - (setq bookmark-yank-point (point)) - (setq bookmark-current-buffer (current-buffer)) - (let* ((default (or bookmark-current-bookmark - (buffer-name (current-buffer)))) - (str - (read-from-minibuffer - (format "Set bookmark (%s): " default) - nil - (let ((now-map (copy-keymap minibuffer-local-map))) - (progn (define-key now-map "\C-w" - 'bookmark-yank-word) - (define-key now-map "\C-v" - 'bookmark-insert-current-file-name) - (define-key now-map "\C-u" - 'bookmark-insert-current-bookmark)) - now-map)))) - (and (string-equal str "") (setq str default)) - (progn - (bookmark-make parg str) - (setq bookmark-current-bookmark str) - (if (get-buffer "*Bookmark List*") ;rebuild the bookmark list - (save-excursion - (save-window-excursion - (list-bookmarks)))) - (goto-char bookmark-current-point)))) - -(defun bookmark-insert-current-bookmark () - ;; insert this buffer's value of bookmark-current-bookmark, default - ;; to file name if it's nil. - (interactive) - (let ((str - (save-excursion - (set-buffer bookmark-current-buffer) - bookmark-current-bookmark))) - (if str (insert str) (bookmark-insert-current-file-name)))) - -(defun bookmark-insert-current-file-name () - ;; insert the name (sans path) of the current file into the bookmark - ;; name that is being set. - (interactive) - (let ((str (save-excursion - (set-buffer bookmark-current-buffer) - (bookmark-buffer-file-name)))) - (insert (substring - str - (1+ (string-match - "\\(/[^/]*\\)/*$" - str)))))) - -(defun bookmark-yank-word () - (interactive) - ;; get the next word from the buffer and append it to the name of - ;; the bookmark currently being set. - (let ((string (save-excursion - (set-buffer bookmark-current-buffer) - (goto-char bookmark-yank-point) - (buffer-substring - (point) - (save-excursion - (forward-word 1) - (setq bookmark-yank-point (point))))))) - (insert string))) - -(defun bookmark-make (parg str) - (if (and (assoc str bookmark-alist) (not parg)) - ;; already existing boookmark under that name and - ;; no prefix arg means just overwrite old bookmark - (setcdr (assoc str bookmark-alist) - (list (bookmark-make-cell))) - - ;; otherwise just cons it onto the front (either the bookmark - ;; doesn't exist already, or there is no prefix arg. In either - ;; case, we want the new bookmark consed onto the alist...) - - (setq bookmark-alist - (cons - (list str - (bookmark-make-cell)) - bookmark-alist))) - ;; Added by db - (setq bookmark-current-bookmark str) - (setq bookmark-alist-modification-count - (1+ bookmark-alist-modification-count)) - (if (bookmark-time-to-save-p) - (bookmark-save))) - -(defun bookmark-make-cell () - ;; make the cell that is the cdr of a bookmark alist element. It - ;; looks like this: - ;; (filename search-forward-str search-back-str point) - (list - (bookmark-buffer-file-name) - (if (>= (- (point-max) (point)) bookmark-search-size) - (buffer-substring - (point) - (+ (point) bookmark-search-size)) - nil) - (if (>= (- (point) (point-min)) bookmark-search-size) - (buffer-substring - (point) - (- (point) bookmark-search-size)) - nil) - (point))) - -(defun bookmark-buffer-file-name () - (or - buffer-file-name - (if (and (boundp 'dired-directory) dired-directory) - (if (stringp dired-directory) - dired-directory - (car dired-directory))))) - -(defun bookmark-try-default-file () - (and (not bookmarks-already-loaded) - (null bookmark-alist) - (file-readable-p (expand-file-name bookmark-file)) - (progn - (bookmark-load bookmark-file t t) - (setq bookmarks-already-loaded t)))) - -(defun bookmark-maybe-sort-alist () - ;;Return the bookmark-alist for display. If the bookmark-sort-flag - ;;is non-nil, then return a sorted copy of the alist. - (if bookmark-sort-flag - (setq bookmark-alist - (sort (copy-alist bookmark-alist) - (function - (lambda (x y) (string-lessp (car x) (car y)))))))) - -;;;###autoload -(defun bookmark-jump (str) - "Jump to bookmark BOOKMARK (a point in some file). -You may have a problem using this function if the value of variable -`bookmark-alist' is nil. If that happens, you need to load in some -bookmarks. See help on function `bookmark-load' for more about -this. - -If the file pointed to by BOOKMARK no longer exists, you will be asked -if you wish to give the bookmark a new location, and bookmark-jump -will then jump to the new location, as well as recording it in place -of the old one in the permanent bookmark record." - (interactive (progn (bookmark-try-default-file) - (let* ((completion-ignore-case - bookmark-completion-ignore-case) - (default - (or (and - (assoc bookmark-current-bookmark - bookmark-alist) - bookmark-current-bookmark) - (and (assoc (buffer-name (current-buffer)) - bookmark-alist) - (buffer-name (current-buffer))))) - (str - (completing-read - (if default - (format "Jump to bookmark (%s): " - default) - "Jump to bookmark: ") - bookmark-alist - nil - 0))) - (and (string-equal "" str) - (setq str default)) - (list str)))) - (let ((cell (bookmark-jump-noselect str))) - (and cell - (switch-to-buffer (car cell)) - (goto-char (cdr cell))))) - -(defun bookmark-jump-noselect (str) - ;; a leetle helper for bookmark-jump :-) - ;; returns (BUFFER . POINT) - (let ((whereto-list (car (cdr (assoc str bookmark-alist))))) - (let* ((file (expand-file-name (car whereto-list))) - (orig-file file) - (forward-str (car (cdr whereto-list))) - (behind-str (car (cdr (cdr whereto-list)))) - (place (car (cdr (cdr (cdr whereto-list)))))) - (if (or - (file-exists-p file) - ;; else try some common compression extensions - ;; and Emacs better handle it right! - (setq file - (or - (let ((altname (concat file ".Z"))) - (and (file-exists-p altname) - altname)) - (let ((altname (concat file ".gz"))) - (and (file-exists-p altname) - altname)) - (let ((altname (concat file ".z"))) - (and (file-exists-p altname) - altname))))) - (save-excursion - (set-buffer (find-file-noselect file)) - (goto-char place) - ;; Go searching forward first. Then, if forward-str exists and - ;; was found in the file, we can search backward for behind-str. - ;; Rationale is that if text was inserted between the two in the - ;; file, it's better to be put before it so you can read it, - ;; rather than after and remain perhaps unaware of the changes. - (if forward-str - (if (search-forward forward-str (point-max) t) - (backward-char bookmark-search-size))) - (if behind-str - (if (search-backward behind-str (point-min) t) - (forward-char bookmark-search-size))) - ;; added by db - (setq bookmark-current-bookmark str) - (cons (current-buffer) (point))) - (progn - (ding) - (if (y-or-n-p (concat (file-name-nondirectory orig-file) - " nonexistent. Relocate \"" - str - "\"? ")) - (progn - (bookmark-relocate str) - ;; gasp! It's a recursive function call in Emacs Lisp! - (bookmark-jump-noselect str)) - (message - "Bookmark not relocated, but deleting it would be a good idea.") - nil)))))) - -;;;###autoload -(defun bookmark-relocate (str) - "Relocate BOOKMARK -- prompts for a filename, and makes an already -existing bookmark point to that file, instead of the one it used to -point at. Useful when a file has been renamed after a bookmark was -set in it." - (interactive (let ((completion-ignore-case - bookmark-completion-ignore-case)) - (progn (bookmark-try-default-file) - (list (completing-read - "Bookmark to relocate: " - bookmark-alist - nil - 0))))) - (let* ((bmrk (assoc str bookmark-alist)) - (bmrk-filename (car (car (cdr bmrk)))) - (newloc (expand-file-name - (read-file-name - (format "Relocate %s to: " str) - (file-name-directory bmrk-filename))))) - (setcar (car (cdr bmrk)) newloc))) - -;;;###autoload -(defun bookmark-locate (str &optional no-insertion) - "Insert the name of the file associated with BOOKMARK. -Optional second arg NO-INSERTION means merely return the filename as a -string." - (interactive (let ((completion-ignore-case - bookmark-completion-ignore-case)) - (progn (bookmark-try-default-file) - (list (completing-read - "Insert bookmark location: " - bookmark-alist - nil - 0))))) - (let ((where (car (car (cdr (assoc str bookmark-alist)))))) - (if no-insertion - where - (insert where)))) - -;;;###autoload -(defun bookmark-rename (old &optional new) - "Change the name of OLD-BOOKMARK to NEWNAME. -If called from keyboard, prompts for OLD-BOOKMARK and NEWNAME. -If called from menubar, OLD-BOOKMARK is selected from a menu, and -prompts for NEWNAME. -If called from Lisp, prompts for NEWNAME if only OLD-BOOKMARK was -passed as an argument. If called with two strings, then no prompting -is done. You must pass at least OLD-BOOKMARK when calling from Lisp. - -While you are entering the new name, consecutive C-w's insert -consectutive words from the text of the buffer into the new bookmark -name, and C-v inserts the name of the file." - (interactive (let ((completion-ignore-case - bookmark-completion-ignore-case)) - (progn (bookmark-try-default-file) - (list (completing-read "Old bookmark name: " - bookmark-alist - nil - 0))))) - (progn - (setq bookmark-current-point (point)) - (setq bookmark-yank-point (point)) - (setq bookmark-current-buffer (current-buffer)) - (let ((cell (assoc old bookmark-alist)) - (str - (or new ; use second arg, if non-nil - (read-from-minibuffer - "New name: " - nil - (let ((now-map (copy-keymap minibuffer-local-map))) - (progn (define-key now-map "\C-w" - 'bookmark-yank-word) - (define-key now-map "\C-v" - 'bookmark-insert-current-file-name)) - now-map))))) - (progn - (setcar cell str) - (setq bookmark-current-bookmark str) - (if (get-buffer "*Bookmark List*") - (save-excursion (save-window-excursion (list-bookmarks)))) - (setq bookmark-alist-modification-count - (1+ bookmark-alist-modification-count)) - (if (bookmark-time-to-save-p) - (bookmark-save)))))) - -;;;###autoload -(defun bookmark-insert (str) - "Insert the text of the file pointed to by bookmark BOOKMARK. -You may have a problem using this function if the value of variable -`bookmark-alist' is nil. If that happens, you need to load in some -bookmarks. See help on function `bookmark-load' for more about -this." - (interactive (let ((completion-ignore-case - bookmark-completion-ignore-case)) - (progn (bookmark-try-default-file) - (list (completing-read - "Insert bookmark contents: " - bookmark-alist - nil - 0))))) - (let ((orig-point (point)) - (str-to-insert - (save-excursion - (set-buffer (car (bookmark-jump-noselect str))) - (buffer-substring (point-min) (point-max))))) - (insert str-to-insert) - (push-mark) - (goto-char orig-point))) - -;;;###autoload -(defun bookmark-delete (str) - "Delete the bookmark named NAME from the bookmark list. -Removes only the first instance of a bookmark with that name. If -there are one or more other bookmarks with the same name, they will -not be deleted. Defaults to the \"current\" bookmark \(that is, the -one most recently used in this file, if any\)." - (interactive (let ((completion-ignore-case - bookmark-completion-ignore-case)) - (progn (bookmark-try-default-file) - (list - (completing-read - "Delete bookmark: " - bookmark-alist - nil - 0 - bookmark-current-bookmark))))) - (let ((will-go (assoc str bookmark-alist))) - (setq bookmark-alist (delq will-go bookmark-alist)) - ;; Added by db, nil bookmark-current-bookmark if the last - ;; occurence has been deleted - (or (assoc bookmark-current-bookmark bookmark-alist) - (setq bookmark-current-bookmark nil))) - (if (get-buffer "*Bookmark List*") - (save-excursion (save-window-excursion (list-bookmarks)))) - (setq bookmark-alist-modification-count - (1+ bookmark-alist-modification-count)) - (if (bookmark-time-to-save-p) - (bookmark-save))) - -(defun bookmark-time-to-save-p (&optional last-time) - ;; By Gregory M. Saunders <saunders@cis.ohio-state.edu> - ;; finds out whether it's time to save bookmarks to a file, by - ;; examining the value of variable bookmark-save-flag, and maybe - ;; bookmark-alist-modification-count. Returns t if they should be - ;; saved, nil otherwise. if last-time is non-nil, then this is - ;; being called when emacs is killed. - (cond (last-time - (and (> bookmark-alist-modification-count 0) - bookmark-save-flag)) - ((numberp bookmark-save-flag) - (>= bookmark-alist-modification-count bookmark-save-flag)) - (t - nil))) - -;;;###autoload -(defun bookmark-write () - "Write bookmarks to a file \(for which the user will be prompted -interactively\). Don't use this in Lisp programs; use bookmark-save -instead." - (interactive) - (bookmark-try-default-file) - (bookmark-save t)) - -;;;###autoload -(defun bookmark-save (&optional parg file) - "Save currently defined bookmarks. -Saves by default in the file defined by the variable -`bookmark-file'. With a prefix arg, save it in file FILE. - -If you are calling this from Lisp, the two arguments are PREFIX-ARG -and FILE, and if you just want it to write to the default file, then -pass no arguments. Or pass in nil and FILE, and it will save in FILE -instead. If you pass in one argument, and it is non-nil, then the -user will be interactively queried for a file to save in. - -When you want to load in the bookmarks from a file, use -\`bookmark-load\', \\[bookmark-load]. That function will prompt you -for a file, defaulting to the file defined by variable -`bookmark-file'." - (interactive "P") - (bookmark-try-default-file) - (cond - ((and (null parg) (null file)) - ;;whether interactive or not, write to default file - (bookmark-write-file bookmark-file)) - ((and (null parg) file) - ;;whether interactive or not, write to given file - (bookmark-write-file file)) - ((and parg (not file)) - ;;have been called interactively w/ prefix arg - (let ((file (read-file-name "File to save bookmarks in: "))) - (bookmark-write-file file))) - (t ; someone called us with prefix-arg *and* a file, so just write to file - (bookmark-write-file file))) - ;; signal that we have synced the bookmark file by setting this to - ;; 0. If there was an error at any point before, it will not get - ;; set, which is what we want. - (setq bookmark-alist-modification-count 0)) - -(defun bookmark-write-file (file) - (save-excursion - (save-window-excursion - (if (>= baud-rate 9600) - (message (format "Saving bookmarks to file %s." file))) - (set-buffer (let ((enable-local-variables nil)) - (find-file-noselect file))) - (goto-char (point-min)) - (delete-region (point-min) (point-max)) - (print bookmark-alist (current-buffer)) - (let ((version-control - (cond - ((null bookmark-version-control) nil) - ((eq 'never bookmark-version-control) 'never) - ((eq 'nospecial bookmark-version-control) version-control) - (t - t)))) - (write-file file) - (kill-buffer (current-buffer)))))) - -;;;###autoload -(defun bookmark-load (file &optional revert no-msg) - "Load bookmarks from FILE (which must be in bookmark format). -Appends loaded bookmarks to the front of the list of bookmarks. If -optional second argument REVERT is non-nil, existing bookmarks are -destroyed. Optional third arg NO-MSG means don't display any messages -while loading. - -If you load a file that doesn't contain a proper bookmark alist, you -will corrupt Emacs's bookmark list. Generally, you should only load -in files that were created with the bookmark functions in the first -place. Your own personal bookmark file, `~/.emacs-bkmrks', is -maintained automatically by Emacs; you shouldn't need to load it -explicitly." - (interactive - (progn (bookmark-try-default-file) - (list (read-file-name - (format "Load bookmarks from: (%s) " - bookmark-file) - ;;Default might not be used often, - ;;but there's no better default, and - ;;I guess it's better than none at all. - "~/" bookmark-file 'confirm)))) - (setq file (expand-file-name file)) - (if (file-readable-p file) - (save-excursion - (save-window-excursion - (if (and (null no-msg) (>= baud-rate 9600)) - (message (format "Loading bookmarks from %s..." file))) - (set-buffer (let ((enable-local-variables nil)) - (find-file-noselect file))) - (goto-char (point-min)) - (let ((blist (car (read-from-string - (buffer-substring (point-min) (point-max)))))) - (if (listp blist) - (progn - (if (not revert) - (setq bookmark-alist-modification-count - (1+ bookmark-alist-modification-count)) - (setq bookmark-alist-modification-count 0)) - (setq bookmark-alist - (append blist (if (not revert) bookmark-alist))) - (if (get-buffer "*Bookmark List*") - (save-excursion (list-bookmarks)))) - (error (format "Invalid bookmark list in %s." file)))) - (kill-buffer (current-buffer))) - (if (and (null no-msg) (>= baud-rate 9600)) - (message (format "Loading bookmarks from %s... done" file)))) - (error (format "Cannot read bookmark file %s." file)))) - -;;;; bookmark-menu-mode stuff ;;;; - -(defvar Bookmark-menu-bookmark-column nil) - -(defvar Bookmark-menu-hidden-bookmarks ()) - -(defvar Bookmark-menu-file-column 30 - "*Column at which to display filenames in a buffer listing bookmarks. -You can toggle whether files are shown with \\<Bookmark-menu-mode-map>\\[Bookmark-menu-toggle-filenames].") - -(defvar Bookmark-menu-toggle-filenames t - "*Non-nil means show filenames when listing bookmarks. -This may result in truncated bookmark names. To disable this, put the -following in your .emacs: - -\(setq Bookmark-menu-toggle-filenames nil\)") - -(defvar Bookmark-menu-mode-map nil) - -(if Bookmark-menu-mode-map - nil - (setq Bookmark-menu-mode-map (make-keymap)) - (suppress-keymap Bookmark-menu-mode-map t) - (define-key Bookmark-menu-mode-map "q" 'Bookmark-menu-quit) - (define-key Bookmark-menu-mode-map "v" 'Bookmark-menu-select) - (define-key Bookmark-menu-mode-map "w" 'Bookmark-menu-locate) - (define-key Bookmark-menu-mode-map "2" 'Bookmark-menu-2-window) - (define-key Bookmark-menu-mode-map "1" 'Bookmark-menu-1-window) - (define-key Bookmark-menu-mode-map "j" 'Bookmark-menu-this-window) - (define-key Bookmark-menu-mode-map "f" 'Bookmark-menu-this-window) - (define-key Bookmark-menu-mode-map "o" 'Bookmark-menu-other-window) - (define-key Bookmark-menu-mode-map "\C-o" 'Bookmark-menu-switch-other-window) - (define-key Bookmark-menu-mode-map "s" 'Bookmark-menu-save) - (define-key Bookmark-menu-mode-map "k" 'Bookmark-menu-delete) - (define-key Bookmark-menu-mode-map "\C-d" 'Bookmark-menu-delete-backwards) - (define-key Bookmark-menu-mode-map "x" 'Bookmark-menu-execute) - (define-key Bookmark-menu-mode-map "\C-k" 'Bookmark-menu-delete) - (define-key Bookmark-menu-mode-map "d" 'Bookmark-menu-delete) - (define-key Bookmark-menu-mode-map " " 'next-line) - (define-key Bookmark-menu-mode-map "n" 'next-line) - (define-key Bookmark-menu-mode-map "p" 'previous-line) - (define-key Bookmark-menu-mode-map "\177" 'Bookmark-menu-backup-unmark) - (define-key Bookmark-menu-mode-map "?" 'describe-mode) - (define-key Bookmark-menu-mode-map "u" 'Bookmark-menu-unmark) - (define-key Bookmark-menu-mode-map "m" 'Bookmark-menu-mark) - (define-key Bookmark-menu-mode-map "l" 'Bookmark-menu-load) - (define-key Bookmark-menu-mode-map "r" 'Bookmark-menu-rename) - (define-key Bookmark-menu-mode-map "t" 'Bookmark-menu-toggle-filenames)) - -;; Bookmark Menu mode is suitable only for specially formatted data. -(put 'Bookmark-menu-mode 'mode-class 'special) - -;; need to display whether or not bookmark exists as a buffer in flag -;; column. - -;; Format: -;; FLAGS BOOKMARK (/FILE/NAME/HERE/WHAT/REGEXP/TO/USE?) -;; goto bookmark-column and then search till "(/[^)]*)$" or "(/.*)$" ? - -;;;###autoload -(defalias 'edit-bookmarks 'list-bookmarks) - -;;;###autoload -(defun list-bookmarks () - "Display a list of existing bookmarks. -The list is displayed in a buffer named `*Bookmark List*'. -The leftmost column displays a D if the bookmark is flagged for -deletion, or > if it is flagged for displaying." - (interactive) - (bookmark-try-default-file) - (switch-to-buffer (get-buffer-create "*Bookmark List*")) - (let ((buffer-read-only nil)) - (delete-region (point-max) (point-min)) - (goto-char (point-min)) ;sure are playing it safe... - (insert "% Bookmark\n- --------\n") - (bookmark-maybe-sort-alist) - (let ((lst bookmark-alist)) - (while lst - (insert - (concat " " (car (car lst)) "\n")) - (setq lst (cdr lst))))) - (goto-char (point-min)) - (forward-line 2) - (bookmark-menu-mode) - (if Bookmark-menu-toggle-filenames - (Bookmark-menu-toggle-filenames t))) - -(defun bookmark-menu-mode () - "Major mode for editing a list of bookmarks. -Each line describes one of the bookmarks in Emacs. -Letters do not insert themselves; instead, they are commands. -\\<Bookmark-menu-mode-map> -\\[Bookmark-menu-mark] -- mark bookmark to be displayed. -\\[Bookmark-menu-select] -- select bookmark of line point is on. - Also show bookmarks marked using m in other windows. -\\[Bookmark-menu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names). -\\[Bookmark-menu-locate] -- display (in minibuffer) location of this bookmark. -\\[Bookmark-menu-1-window] -- select this bookmark in full-frame window. -\\[Bookmark-menu-2-window] -- select this bookmark in one window, - together with bookmark selected before this one in another window. -\\[Bookmark-menu-this-window] -- select this bookmark in place of the bookmark menu buffer. -\\[Bookmark-menu-other-window] -- select this bookmark in another window, - so the bookmark menu bookmark remains visible in its window. -\\[Bookmark-menu-switch-other-window] -- switch the other window to this bookmark. -\\[Bookmark-menu-rename] -- rename this bookmark \(prompts for new name\). -\\[Bookmark-menu-delete] -- mark this bookmark to be deleted, and move down. -\\[Bookmark-menu-delete-backwards] -- mark this bookmark to be deleted, and move up. -\\[Bookmark-menu-execute] -- delete marked bookmarks. -\\[Bookmark-menu-save] -- save the current bookmark list in the default file. - With a prefix arg, prompts for a file to save in. -\\[Bookmark-menu-load] -- load in a file of bookmarks (prompts for file.) -\\[Bookmark-menu-unmark] -- remove all kinds of marks from current line. - With prefix argument, also move up one line. -\\[Bookmark-menu-backup-unmark] -- back up a line and remove marks." - (kill-all-local-variables) - (use-local-map Bookmark-menu-mode-map) - (setq truncate-lines t) - (setq buffer-read-only t) - (setq major-mode 'bookmark-menu-mode) - (setq mode-name "Bookmark Menu") - (run-hooks 'bookmark-menu-mode-hook)) - -(defun Bookmark-menu-toggle-filenames (&optional parg) - "Toggle whether filenames are shown in the bookmark list. -Optional argument SHOW means show them unconditionally." - (interactive) - (cond - (parg - (setq Bookmark-menu-toggle-filenames nil) - (Bookmark-menu-show-filenames) - (setq Bookmark-menu-toggle-filenames t)) - (Bookmark-menu-toggle-filenames - (Bookmark-menu-hide-filenames) - (setq Bookmark-menu-toggle-filenames nil)) - (t - (Bookmark-menu-show-filenames) - (setq Bookmark-menu-toggle-filenames t)))) - -(defun Bookmark-menu-show-filenames (&optional force) - (if (and (not force) Bookmark-menu-toggle-filenames) - nil ;already shown, so do nothing - (save-excursion - (save-window-excursion - (goto-char (point-min)) - (forward-line 2) - (setq Bookmark-menu-hidden-bookmarks ()) - (let ((buffer-read-only nil)) - (while (< (point) (point-max)) - (let ((bmrk (Bookmark-menu-bookmark))) - (setq Bookmark-menu-hidden-bookmarks - (cons bmrk Bookmark-menu-hidden-bookmarks)) - (move-to-column Bookmark-menu-file-column t) - (delete-region (point) (progn (end-of-line) (point))) - (insert " ") - (bookmark-locate bmrk) - (forward-line 1)))))))) - -(defun Bookmark-menu-hide-filenames (&optional force) - (if (and (not force) Bookmark-menu-toggle-filenames) - ;; nothing to hide if above is nil - (save-excursion - (save-window-excursion - (goto-char (point-min)) - (forward-line 2) - (setq Bookmark-menu-hidden-bookmarks - (nreverse Bookmark-menu-hidden-bookmarks)) - (save-excursion - (goto-char (point-min)) - (search-forward "Bookmark") - (backward-word 1) - (setq Bookmark-menu-bookmark-column (current-column))) - (save-excursion - (let ((buffer-read-only nil)) - (while Bookmark-menu-hidden-bookmarks - (move-to-column Bookmark-menu-bookmark-column t) - (kill-line) - (insert (car Bookmark-menu-hidden-bookmarks)) - (setq Bookmark-menu-hidden-bookmarks - (cdr Bookmark-menu-hidden-bookmarks)) - (forward-line 1)))))))) - -;; if you look at this next function from far away, it resembles a -;; gun. But only with this comment above... -(defun Bookmark-menu-check-position () - ;; Returns t if on a line with a bookmark. - ;; Otherwise, repositions and returns t. - ;; written by David Hughes <djh@harston.cv.com> - ;; Mucho thanks, David! -karl - (cond ((< (count-lines (point-min) (point)) 2) - (goto-char (point-min)) - (forward-line 2) - t) - ((and (bolp) (eobp)) - (beginning-of-line 0) - t) - (t - t))) - -(defun Bookmark-menu-bookmark () - ;; return a string which is bookmark of this line. - (if (Bookmark-menu-check-position) - (save-excursion - (save-window-excursion - (goto-char (point-min)) - (search-forward "Bookmark") - (backward-word 1) - (setq Bookmark-menu-bookmark-column (current-column))))) - (if Bookmark-menu-toggle-filenames - (Bookmark-menu-hide-filenames)) - (save-excursion - (save-window-excursion - (beginning-of-line) - (forward-char Bookmark-menu-bookmark-column) - (prog1 - (buffer-substring (point) - (progn - (end-of-line) - (point))) - ;; well, this is certainly crystal-clear: - (if Bookmark-menu-toggle-filenames - (Bookmark-menu-toggle-filenames t)))))) - -(defun Bookmark-menu-mark () - "Mark bookmark on this line to be displayed by \\<Bookmark-menu-mode-map>\\[Bookmark-menu-select] command." - (interactive) - (beginning-of-line) - (if (Bookmark-menu-check-position) - (let ((buffer-read-only nil)) - (delete-char 1) - (insert ?>) - (forward-line 1)))) - -(defun Bookmark-menu-select () - "Select this line's bookmark; also display bookmarks marked with `>'. -You can mark bookmarks with the \\<Bookmark-menu-mode-map>\\[Bookmark-menu-mark] command." - (interactive) - (if (Bookmark-menu-check-position) - (let ((bmrk (Bookmark-menu-bookmark)) - (menu (current-buffer)) - (others ()) - tem) - (goto-char (point-min)) - (while (re-search-forward "^>" nil t) - (setq tem (Bookmark-menu-bookmark)) - (let ((buffer-read-only nil)) - (delete-char -1) - (insert ?\ )) - (or (string-equal tem bmrk) - (memq tem others) - (setq others (cons tem others)))) - (setq others (nreverse others) - tem (/ (1- (frame-height)) (1+ (length others)))) - (delete-other-windows) - (bookmark-jump bmrk) - (bury-buffer menu) - (if (equal (length others) 0) - nil - (while others - (split-window nil tem) - (other-window 1) - (bookmark-jump (car others)) - (setq others (cdr others))) - (other-window 1))))) - -(defun Bookmark-menu-save (parg) - "Save the current list into a bookmark file. -With a prefix arg, prompts for a file to save them in." - (interactive "P") - (save-excursion - (save-window-excursion - (bookmark-save parg)))) - -(defun Bookmark-menu-load () - "Load a bookmark file and rebuild list." - (interactive) - (if (Bookmark-menu-check-position) - (save-excursion - (save-window-excursion - (call-interactively 'bookmark-load))))) - -(defun Bookmark-menu-1-window () - "Select this line's bookmark, alone, in full frame." - (interactive) - (if (Bookmark-menu-check-position) - (progn - (bookmark-jump (Bookmark-menu-bookmark)) - (bury-buffer (other-buffer)) - (delete-other-windows)))) - -(defun Bookmark-menu-2-window () - "Select this line's bookmark, with previous buffer in second window." - (interactive) - (if (Bookmark-menu-check-position) - (let ((bmrk (Bookmark-menu-bookmark)) - (menu (current-buffer)) - (pop-up-windows t)) - (delete-other-windows) - (switch-to-buffer (other-buffer)) - (let ((buff (car (bookmark-jump-noselect bmrk)))) - (pop-to-buffer buff)) - (bury-buffer menu)))) - -(defun Bookmark-menu-this-window () - "Select this line's bookmark in this window." - (interactive) - (if (Bookmark-menu-check-position) - (bookmark-jump (Bookmark-menu-bookmark)))) - -(defun Bookmark-menu-other-window () - "Select this line's bookmark in other window, leaving bookmark menu visible." - (interactive) - (if (Bookmark-menu-check-position) - (let ((buff (car (bookmark-jump-noselect (Bookmark-menu-bookmark))))) - (switch-to-buffer-other-window buff)))) - -(defun Bookmark-menu-switch-other-window () - "Make the other window select this line's bookmark. -The current window remains selected." - (interactive) - (if (Bookmark-menu-check-position) - (let ((buff (car (bookmark-jump-noselect (Bookmark-menu-bookmark))))) - (display-buffer buff)))) - -(defun Bookmark-menu-quit () - "Quit the bookmark menu." - (interactive) - (let ((buffer (current-buffer))) - (switch-to-buffer (other-buffer)) - (bury-buffer buffer))) - -(defun Bookmark-menu-unmark (&optional backup) - "Cancel all requested operations on bookmark on this line and move down. -Optional ARG means move up." - (interactive "P") - (beginning-of-line) - (if (Bookmark-menu-check-position) - (progn - (let ((buffer-read-only nil)) - (delete-char 1) - ;; any flags to reset according to circumstances? How about a - ;; flag indicating whether this bookmark is being visited? - ;; well, we don't have this now, so maybe later. - (insert " ")) - (forward-line (if backup -1 1))))) - -(defun Bookmark-menu-backup-unmark () - "Move up and cancel all requested operations on bookmark on line above." - (interactive) - (forward-line -1) - (if (Bookmark-menu-check-position) - (progn - (Bookmark-menu-unmark) - (forward-line -1)))) - -(defun Bookmark-menu-delete () - "Mark bookmark on this line to be deleted by \\<Bookmark-menu-mode-map>\\[Bookmark-menu-execute] command." - (interactive) - (beginning-of-line) - (if (Bookmark-menu-check-position) - (let ((buffer-read-only nil)) - (delete-char 1) - (insert ?D) - (forward-line 1)))) - -(defun Bookmark-menu-delete-backwards () - "Mark bookmark on this line to be deleted by \\<Bookmark-menu-mode-map>\\[Bookmark-menu-execute] command -and then move up one line" - (interactive) - (Bookmark-menu-delete) - (forward-line -2) - (if (Bookmark-menu-check-position) - (forward-line 1))) - -(defun Bookmark-menu-execute () - "Delete bookmarks marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands." - (interactive) - (let ((hide-em Bookmark-menu-toggle-filenames)) - (if hide-em (Bookmark-menu-hide-filenames)) - (setq Bookmark-menu-toggle-filenames nil) - (goto-char (point-min)) - (forward-line 1) - (let ((deaders ())) - (while (re-search-forward "^D" (point-max) t) - (setq deaders (cons (Bookmark-menu-bookmark) deaders))) - (mapcar (lambda (str) - (setq bookmark-alist - (delq (assoc str bookmark-alist) bookmark-alist))) - deaders)) - (list-bookmarks) - (goto-char (point-min)) - (forward-line 2) - (setq Bookmark-menu-toggle-filenames hide-em) - (if Bookmark-menu-toggle-filenames - (Bookmark-menu-toggle-filenames t)))) - -(defun Bookmark-menu-rename () - "Rename bookmark on current line. Prompts for a new name." - (interactive) - (if (Bookmark-menu-check-position) - (let ((bmrk (Bookmark-menu-bookmark)) - (thispoint (point))) - (bookmark-rename bmrk) - (list-bookmarks) - (goto-char thispoint)))) - -(defun Bookmark-menu-locate () - "Display location of this bookmark. Displays in the minibuffer." - (interactive) - (if (Bookmark-menu-check-position) - (let ((bmrk (Bookmark-menu-bookmark))) - (message (bookmark-locate bmrk t))))) - -;;;; bookmark menu bar stuff ;;;; - -(defvar bookmark-menu-bar-length 70 - "*Maximum length of a bookmark name displayed on a popup menu.") - -(defun bookmark-make-menu-bar-alist () - (bookmark-try-default-file) - (bookmark-maybe-sort-alist) - (if bookmark-alist - (mapcar (lambda (cell) - (let ((str (car cell))) - (cons - (if (> (length str) bookmark-menu-bar-length) - (substring str 0 bookmark-menu-bar-length) - str) - str))) - bookmark-alist) - (error "No bookmarks currently set."))) - -(defun bookmark-make-menu-bar-with-function (func-sym - menu-label - menu-str event) - ;; help function for making menus that need to apply a bookmark - ;; function to a string. - (let* ((menu (bookmark-make-menu-bar-alist)) - (str (x-popup-menu event - (list menu-label - (cons menu-str menu))))) - (if str (apply func-sym (list str))))) - -;;;###autoload -(defun bookmark-menu-bar-insert (event) - "Insert the text of the file pointed to by bookmark BOOKMARK. -You may have a problem using this function if the value of variable -`bookmark-alist' is nil. If that happens, you need to load in some -bookmarks. See help on function `bookmark-load' for more about -this." - (interactive "e") - (bookmark-make-menu-bar-with-function 'bookmark-insert - "Bookmark Insert Menu" - "--- Insert Contents ---" - event)) - -;;;###autoload -(defun bookmark-menu-bar-jump (event) - "Jump to bookmark BOOKMARK (a point in some file). -You may have a problem using this function if the value of variable -`bookmark-alist' is nil. If that happens, you need to load in some -bookmarks. See help on function `bookmark-load' for more about -this." - (interactive "e") - (bookmark-make-menu-bar-with-function 'bookmark-jump - "Bookmark Jump Menu" - "--- Jump to Bookmark ---" - event)) - -;;;###autoload -(defun bookmark-menu-bar-locate (event) - "Insert the name of the file associated with BOOKMARK. -\(This is not the same as the contents of that file\)." - (interactive "e") - (bookmark-make-menu-bar-with-function 'bookmark-locate - "Bookmark Locate Menu" - "--- Insert Location ---" - event)) - -;;;###autoload -(defun bookmark-menu-bar-rename (event) - "Change the name of OLD-BOOKMARK to NEWNAME. -If called from keyboard, prompts for OLD-BOOKMARK and NEWNAME. -If called from menubar, OLD-BOOKMARK is selected from a menu, and -prompts for NEWNAME. -If called from Lisp, prompts for NEWNAME if only OLD-BOOKMARK was -passed as an argument. If called with two strings, then no prompting -is done. You must pass at least OLD-BOOKMARK when calling from Lisp. - -While you are entering the new name, consecutive C-w's insert -consectutive words from the text of the buffer into the new bookmark -name, and C-v inserts the name of the file." - (interactive "e") - (bookmark-make-menu-bar-with-function 'bookmark-rename - "Bookmark Rename Menu" - "--- Rename Bookmark ---" - event)) - -;;;###autoload -(defun bookmark-menu-bar-delete (event) - "Delete the bookmark named NAME from the bookmark list. -Removes only the first instance of a bookmark with that name. If -there are one or more other bookmarks with the same name, they will -not be deleted. Defaults to the \"current\" bookmark \(that is, the -one most recently used in this file, if any\)." - (interactive "e") - (bookmark-make-menu-bar-with-function 'bookmark-delete - "Bookmark Delete Menu" - "--- Delete Bookmark ---" - event)) - -;; Thanks to Roland McGrath for fixing menubar.el so that the -;; following works, and for explaining what to do to make it work. - -;;;###autoload -(defvar menu-bar-bookmark-map (make-sparse-keymap "Bookmark functions.")) - -;;;###autoload -(fset 'menu-bar-bookmark-map (symbol-value 'menu-bar-bookmark-map)) - -;;;###autoload -(define-key menu-bar-bookmark-map [load] - '("Load a bookmark file" . bookmark-load)) - -;;;###autoload -(define-key menu-bar-bookmark-map [write] - '("Write \(to another file\)" . bookmark-write)) - -;;;###autoload -(define-key menu-bar-bookmark-map [save] - '("Save \(in default file\)" . bookmark-save)) - -;;;###autoload -(define-key menu-bar-bookmark-map [edit] - '("Edit Bookmark List" . list-bookmarks)) - -;;;###autoload -(define-key menu-bar-bookmark-map [delete] - '("Delete bookmark" . bookmark-menu-bar-delete)) - -;;;###autoload -(define-key menu-bar-bookmark-map [rename] - '("Rename bookmark" . bookmark-menu-bar-rename)) - -;;;###autoload -(define-key menu-bar-bookmark-map [locate] - '("Insert location" . bookmark-menu-bar-locate)) - -;;;###autoload -(define-key menu-bar-bookmark-map [insert] - '("Insert contents" . bookmark-menu-bar-insert)) - -;;;###autoload -(define-key menu-bar-bookmark-map [set] - '("Set bookmark" . bookmark-set)) - -;;;###autoload -(define-key menu-bar-bookmark-map [jump] - '("Jump to bookmark" . bookmark-menu-bar-jump)) - -(fset 'menu-bar-bookmark-map (symbol-value 'menu-bar-bookmark-map)) - -;;;; end bookmark menu-bar stuff ;;;; - -(provide 'bookmark) - -;;; bookmark.el ends here |