-;;; page-ext.el --- page handling commands
+;;; page-ext.el --- extended page handling commands
-;;; Copyright (C) 1990 Free Software Foundation
+;; Copyright (C) 1990, 1991, 1993, 1994 Free Software Foundation
-;; Author: Robert J. Chassell <bob@gnu.ai.mit.edu>
+;; Maintainer: Robert J. Chassell <bob@gnu.org>
;; This file is part of GNU Emacs.
;; 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.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
;;; Commentary:
-;;; You may use these commands to handle an address list or other
-;;; small data base.
-
-;;; Change Log:
-
-;;; Change Log ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;;
-;;; Version 0.043
-;;; 24 May 1990 - When the cursor is at the end of the pages directory
-;;; buffer (which is empty), a `C-c C-c' (pages-directory-goto)
-;;; command now takes you to the end of the buffer.
-;;;
-;;; Version 0.042
-;;; 16 May 1990 - Since people often handle address and other files
-;;; differently, variable `pages-directory-for-addresses-narrowing-p'
-;;; now specifies whether `pages-directory-goto' should narrow
-;;; addresses buffer to entry to which it goes.
-;;; `pages-directory-buffer-narrowing-p' continues to control
-;;; narrowing of pages buffer.
-;;;
-;;; `add-new-page' documentation string now explains
-;;; that the value of the inserted page-delimiter is a `^L'.
-;;;
-;;; `pages-directory-previous-regexp' definition reworded.
-;;;
-;;; Removed unneeded defvar for `pages-directory-buffer'.
-;;;
-;;; Version 0.041
-;;; 14 May 1990 - `pages-last-search' bound to nil initially.
-;;; Remove unnecessary lines from `search-pages' definition.
-;;;
-;;; Version 0.04
-;;; 18 Mar 1990 - `pages-directory' creates a directory for only the
-;;; accessible portion of the buffer; it does not automatically widen
-;;; the buffer.
-;;;
-;;; However, `pages-directory-for-addresses' does widen the addresses'
-;;; buffer before constructing the addresses' directory.
-;;;
-;;; Version 0.032
-;;; 20 Feb 1990 - `pages-directory-for-addresses' no longer copies
-;;; first line of addresses directory to kill-ring
-;;;
-;;; Remove `(kill-all-local-variables)' line from
-;;; `pages-directory-address-mode' so Emacs will not be told to forget
-;;; the name of the file containing the addresses!
-;;;
-;;; Version 0.031
-;;; 15 Feb 1990 - `pages-directory-goto' no longer erroneously selects
-;;; the entry on the following line when the cursor is at the end of
-;;; the line, but selects the entry on which the cursor rests.
-;;;
-;;; `pages-directory-address-mode' now sets local variables and enables
-;;; `describe-mode' to describe Addresses Directory mode.
-;;;
-;;; `pages-directory-for-addresses' now sets the buffer-modifed flag
-;;; for the Addresses Directory to nil.
-;;;
-;;; The documentation string for both `pages-directory-mode' and
-;;; `pages-directory-address-mode' now provide a lookup for the
-;;; `pages-directory-goto' keybinding.
-;;;
-;;; Version 0.03
-;;; 10 Feb 1990 - Incorporated a specialized extension of the
-;;; `pages-directory' command called `pages-directory-for-addresses'
-;;; and bound it to ctl-x-ctl-p-map "d" for integration with other
-;;; page functions. This function finds a file, creates a directory
-;;; for it using the `pages-directory' command, and displays the
-;;; directory. It is primarily for lists of addresses and the like.
-;;;
-;;; The difference between this and the `pages-directory' command is
-;;; that the `pages-directory-for-addresses' command presumes a
-;;; default addresses file (although you may optionally specify a file
-;;; name) and it switches you to the directory for the file, but the
-;;; `pages-directory' command creates a directory for the current
-;;; buffer, and pops to the directory in another window.
-;;;
-;;; `pages-directory' now places the cursor over the header line of
-;;; the page in which point was located in the pages buffer.
-;;;
-;;; New `set-page-delimiter' command sets the buffer local value of
-;;; the page-delimiter variable. With prefix arg, resets function to
-;;; original value. (Quicker to use than `edit-options'.)
-;;;
-;;; Version 0.02
-;;; 9 Feb 1990 - `pages-directory' now displays the
-;;; first line that contains a non-blank character that follows the
-;;; `page-delimiter'; this may be the rest of the line that contains
-;;; the `page-delimiter' or a line following. (In most instances, the
-;;; line containing a non-blank character is a line of text.)
-;;; Modification includes changes to `pages-copy-header-and-position'.
-;;;
-;;; Each directory created by `pages-directory' now possesses a name
-;;; derived on the name of the pages buffer. Consequently, you may
-;;; create several different directories, one for each pages buffer.
-;;;
-;;; `sort-pages-in-region' no longers requires the text to start on
-;;; the line immediately following the line containing the
-;;; page-delimiter.
-;;;
-;;; `pages-directory-goto' no longer narrows to the page
-;;; automatically. Instead, if you wish it to narrow to the page, set
-;;; variable pages-directory-buffer-narrowing-p to a non-nil value.
-;;; Default is nil; this is an experiment to see whether it is useful
-;;; to see the surrounding context.
-;;;
-;;; Version 0.011
-;;; 2 Feb 1990 - `add-new-page': removed extraneous space.
-;;;
-;;; Version 0.01
-;;; 28 Jan 1990 - Initial definitions.
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; You may use these commands to handle an address list or other
+;; small data base.
-;;; Code:
\f
-;;;; Summary
-
-; The current page commands are:
-
-; forward-page C-x ]
-; backward-page C-x [
-; narrow-to-page C-x p
-; count-lines-page C-x l
-; mark-page C-x C-p (change this to C-x C-p C-m)
-; sort-pages not bound
-; what-page not bound
-
-; The new page handling commands all use `C-x C-p' as a prefix. This
-; means that the key binding for `mark-page' must be changed.
-; Otherwise, no other changes are made to the current commands or
-; their bindings.
-
-; New page handling commands:
-
-; next-page C-x C-p C-n
-; previous-page C-x C-p C-p
-; search-pages C-x C-p C-s
-; add-new-page C-x C-p C-a
-; sort-pages-buffer C-x C-p s
-; set-page-delimiter C-x C-p C-l
-; pages-directory C-x C-p C-d
-; pages-directory-for-addresses C-x C-p d
-; goto-page C-c C-c
+;;; Summary
+
+;; The current page commands are:
+
+;; forward-page C-x ]
+;; backward-page C-x [
+;; narrow-to-page C-x p
+;; count-lines-page C-x l
+;; mark-page C-x C-p (change this to C-x C-p C-m)
+;; sort-pages not bound
+;; what-page not bound
+
+;; The new page handling commands all use `C-x C-p' as a prefix. This
+;; means that the key binding for `mark-page' must be changed.
+;; Otherwise, no other changes are made to the current commands or
+;; their bindings.
+
+;; New page handling commands:
+
+;; next-page C-x C-p C-n
+;; previous-page C-x C-p C-p
+;; search-pages C-x C-p C-s
+;; add-new-page C-x C-p C-a
+;; sort-pages-buffer C-x C-p s
+;; set-page-delimiter C-x C-p C-l
+;; pages-directory C-x C-p C-d
+;; pages-directory-for-addresses C-x C-p d
+;; pages-directory-goto C-c C-c
\f
-;;;; Using the page commands
-;
-; The page commands are helpful in several different contexts. For
-; example, programmers often divide source files into sections using the
-; `page-delimiter'; you can use the `pages-directory' command to list
-; the sections.
-
-; You may change the buffer local value of the `page-delimiter' with
-; the `set-page-delimiter' command. This command is bound to `C-x C-p
-; C-l' The command prompts you for a new value for the page-delimiter.
-; Called with a prefix-arg, the command resets the value of the
-; page-delimiter to its original value.
+;;; Using the page commands
+
+;; The page commands are helpful in several different contexts. For
+;; example, programmers often divide source files into sections using the
+;; `page-delimiter'; you can use the `pages-directory' command to list
+;; the sections.
+
+;; You may change the buffer local value of the `page-delimiter' with
+;; the `set-page-delimiter' command. This command is bound to `C-x C-p
+;; C-l' The command prompts you for a new value for the page-delimiter.
+;; Called with a prefix-arg, the command resets the value of the
+;; page-delimiter to its original value.
+
+;; You may set several user options:
+;;
+;; The `pages-directory-buffer-narrowing-p' variable causes the
+;; `pages-directory-goto' command to narrow to the destination page.
+;;
+;; The `pages-directory-for-adding-page-narrowing-p' variable, causes the
+;; `add-new-page' command to narrow to the new entry.
+;;
+;; The `pages-directory-for-adding-new-page-before-current-page-p' variable
+;; causes the `add-new-page' command to insert a new page before current
+;; page.
+;;
+;; These variables are true by default.
+;;
+;; Additional, addresses-related user options are described in the next page
+;; of this file.
\f
-;;;; Handling an address list or small data base
-
-; You may use the page commands to handle an address list or other
-; small data base. Put each address or entry on its own page. The
-; first line of text in each page is a `header line' and is listed by
-; the `pages-directory' or `pages-directory-for-addresses' command.
-
-; Specifically:
-;
-; 1. Begin each entry with a `page-delimiter' (which is, by default,
-; `^L' at the beginning of the line).
-;
-; 2. The first line of text in each entry is the `heading line'; it
-; will appear in the pages-directory-buffer which is constructed
-; using the `C-x C-p C-d' (pages-directory) command or the `C-x
-; C-p d' (pages-directory-for-addresses) command.
-;
-; The heading line may be on the same line as the page-delimiter
-; or it may follow after. It is the first non-blank line on the
-; page. Conventionally, the heading line is placed on the line
-; immediately following the line containing page-delimiter.
-;
-; 3. Follow the heading line with the body of the entry. The body
-; extends up to the next `page-delimiter'. The body may be of any
-; length. It is conventional to place a blank line after the last
-; line of the body.
-
-; For example, a file might look like this:
-;
-; FSF
-; Free Software Foundation
-; 675 Massachusetts Avenue
-; Cambridge, MA 02139 USA
-; (617) 876-3296
-; gnu@prep.ai.mit.edu
-;
-; \f
-; House Subcommittee on Intellectual Property,
-; U.S. House of Representatives,
-; Washington, DC 20515
-;
-; Congressional committee concerned with permitting or preventing
-; monopolistic restictions on the use of software technology
-;
-; \f
-; George Lakoff
-; ``Women, Fire, and Dangerous Things:
-; What Categories Reveal about the Mind''
-; 1987, Univ. of Chicago Press
-;
-; About philosophy, Whorfian effects, and linguistics.
-;
-; \f
-; OBI (On line text collection.)
-; Open Book Initiative
-; c/o Software Tool & Die
-; 1330 Beacon St, Brookline, MA 02146 USA
-; (617) 739-0202
-; obi@world.std.com
-
-; In this example, the heading lines are:
-;
-; FSF
-; House Subcommittee on Intellectual Property
-; George Lakoff
-; OBI (On line text collection.)
-
-; The `C-x C-p s' (sort-pages-buffer) command sorts the entries in the
-; buffer alphabetically.
-
-; You may use any of the page commands, including the `next-page',
-; `previous-page', `add-new-page', `mark-page', and `search-pages'
-; commands.
-
-; You may use either the `C-x C-p d' (pages-directory-for-addresses)
-; or the `C-x C-p C-d' (pages-directory) command to construct and
-; dislay a directory of all the heading lines.
-
-; In the directory, you may position the cursor over a heading line
-; and type `C-c C-c' to go to the entry to which it refers in the
-; pages buffer.
-
-; When used in conjunction with the `pages-directory-for-addresses'
-; command, the `C-c C-c' (pages-directory-goto) command narrows to the
-; entry to which it goes. But, when used in conjunction with the
-; `pages-directory' command, the `C-c C-c' (pages-directory-goto)
-; command does not narrow to the entry, but widens the buffer so you
-; can see the context surrounding the entry.
-
-; If you wish, you may create several different directories,
-; one for each different buffer.
+;;; Handling an address list or small data base
+
+;; You may use the page commands to handle an address list or other
+;; small data base. Put each address or entry on its own page. The
+;; first line of text in each page is a `header line' and is listed by
+;; the `pages-directory' or `pages-directory-for-addresses' command.
+
+;; Specifically:
+;;
+;; 1. Begin each entry with a `page-delimiter' (which is, by default,
+;; `^L' at the beginning of the line).
+;;
+;; 2. The first line of text in each entry is the `heading line'; it
+;; will appear in the pages-directory-buffer which is constructed
+;; using the `C-x C-p C-d' (pages-directory) command or the `C-x
+;; C-p d' (pages-directory-for-addresses) command.
+;;
+;; The heading line may be on the same line as the page-delimiter
+;; or it may follow after. It is the first non-blank line on the
+;; page. Conventionally, the heading line is placed on the line
+;; immediately following the line containing page-delimiter.
+;;
+;; 3. Follow the heading line with the body of the entry. The body
+;; extends up to the next `page-delimiter'. The body may be of any
+;; length. It is conventional to place a blank line after the last
+;; line of the body.
+
+;; For example, a file might look like this:
+;;
+;; FSF
+;; Free Software Foundation
+;; 59 Temple Place - Suite 330
+;; Boston, MA 02111-1307 USA.
+;; (617) 542-5942
+;; gnu@gnu.org
+;;
+;; \f
+;; House Subcommittee on Intellectual Property,
+;; U.S. House of Representatives,
+;; Washington, DC 20515
+;;
+;; Congressional committee concerned with permitting or preventing
+;; monopolistic restrictions on the use of software technology.
+;;
+;; \f
+;; George Lakoff
+;; ``Women, Fire, and Dangerous Things:
+;; What Categories Reveal about the Mind''
+;; 1987, Univ. of Chicago Press
+;;
+;; About philosophy, Whorfian effects, and linguistics.
+;;
+;; \f
+;; OBI (On line text collection.)
+;; Open Book Initiative
+;; c/o Software Tool & Die
+;; 1330 Beacon St, Brookline, MA 02146 USA
+;; (617) 739-0202
+;; obi@world.std.com
+
+;; In this example, the heading lines are:
+;;
+;; FSF
+;; House Subcommittee on Intellectual Property
+;; George Lakoff
+;; OBI (On line text collection.)
+
+;; The `C-x C-p s' (sort-pages-buffer) command sorts the entries in the
+;; buffer alphabetically.
+
+;; You may use any of the page commands, including the `next-page',
+;; `previous-page', `add-new-page', `mark-page', and `search-pages'
+;; commands.
+
+;; You may use either the `C-x C-p d' (pages-directory-for-addresses)
+;; or the `C-x C-p C-d' (pages-directory) command to construct and
+;; display a directory of all the heading lines.
+
+;; In the directory, you may position the cursor over a heading line
+;; and type `C-c C-c' (pages-directory-goto) to go to the entry to
+;; which it refers in the pages buffer.
+
+;; You can type `C-c C-p C-a' (add-new-page) to add a new entry in the
+;; pages buffer or address file. This is the same command you use to
+;; add a new entry when you are in the pages buffer or address file.
+
+;; If you wish, you may create several different directories,
+;; one for each different buffer.
;; `pages-directory-for-addresses' in detail
-; The `pages-directory-for-addresses' assumes a default addresses
-; file. You do not need to specify the addresses file but merely type
-; `C-x C-p d' from any buffer. The command finds the file, constructs
-; a directory for it, and switches you to the directory. If you call
-; the command with a prefix arg, `C-u C-x C-p d', it prompts you for a
-; file name.
+;; The `pages-directory-for-addresses' assumes a default addresses
+;; file. You do not need to specify the addresses file but merely type
+;; `C-x C-p d' from any buffer. The command finds the file, constructs
+;; a directory for it, and switches you to the directory. If you call
+;; the command with a prefix arg, `C-u C-x C-p d', it prompts you for a
+;; file name.
+
+;; You may customize the addresses commands:
+
+;; The `pages-addresses-file-name' variable determines the name of
+;; the addresses file; by default it is "~/addresses".
+
+;; The `pages-directory-for-addresses-goto-narrowing-p' variable
+;; determines whether `pages-directory-goto' narrows the addresses
+;; buffer to the entry, which it does by default.
+
+;; The `pages-directory-for-addresses-buffer-keep-windows-p' variable
+;; determines whether `pages-directory-for-addresses' deletes other
+;; windows to show as many lines as possible on the screen or works
+;; in the usual Emacs manner and keeps other windows. Default is to
+;; keep other windows.
+
+;; The `pages-directory-for-adding-addresses-narrowing-p' variable
+;; determines whether `pages-directory-for-addresses' narrows the
+;; addresses buffer to a new entry when you are adding that entry.
+;; Default is to narrow to new entry, which means you see a blank
+;; screen before you write the new entry.
;; `pages-directory' in detail
-; Call the `pages-directory' from the buffer for which you want a
-; directory created; it creates a directory for the buffer and pops
-; you to the directory.
+;; Call the `pages-directory' command from the buffer for which you
+;; want a directory created; it creates a directory for the buffer and
+;; pops you to the directory.
+
+;; The `pages-directory' command has several options:
+
+;; Called with a prefix arg, `C-u C-x C-p C-d', the `pages-directory'
+;; prompts you for a regular expression and only lists only those
+;; header lines that are part of pages that contain matches to the
+;; regexp. In the example above, `C-u C-x C-p C-d 617 RET' would
+;; match the telephone area code of the first and fourth entries, so
+;; only the header lines of those two entries would appear in the
+;; pages-directory-buffer.
+;;
+;; Called with a numeric argument, the `pages-directory' command
+;; lists the number of lines in each page. This is helpful when you
+;; are printing hardcopy.
+
+;; Called with a negative numeric argument, the `pages-directory'
+;; command lists the lengths of pages whose contents match a regexp.
+
+;;; Code:
+
+\f
+;;; Customarily customizable variable definitions
+
+(defgroup pages nil
+ "Extended page-handling commands."
+ :group 'extensions)
+
+
+(defcustom pages-directory-buffer-narrowing-p t
+ "*If non-nil, `pages-directory-goto' narrows pages buffer to entry."
+ :type 'boolean
+ :group 'pages)
+
+(defcustom pages-directory-for-adding-page-narrowing-p t
+ "*If non-nil, `add-new-page' narrows page buffer to new entry."
+ :type 'boolean
+ :group 'pages)
+
+(defcustom pages-directory-for-adding-new-page-before-current-page-p t
+ "*If non-nil, `add-new-page' inserts new page before current page."
+ :type 'boolean
+ :group 'pages)
-; The `pages-directory' command has several options:
+\f
+;;; Addresses related variables
+
+(defcustom pages-addresses-file-name "~/addresses"
+ "*Standard name for file of addresses. Entries separated by page-delimiter.
+Used by `pages-directory-for-addresses' function."
+ :type 'file
+ :group 'pages)
+
+(defcustom pages-directory-for-addresses-goto-narrowing-p t
+ "*If non-nil, `pages-directory-goto' narrows addresses buffer to entry."
+ :type 'boolean
+ :group 'pages)
-; Called with a prefix arg, `C-u C-x C-p C-d', the `pages-directory'
-; prompts you for a regular expression and only lists only those
-; header lines that are part of pages that contain matches to the
-; regexp. In the example above, `C-u C-x C-p C-d 617 RET' would
-; match the telephone area code of the first and fourth entries, so
-; only the header lines of those two entries would appear in the
-; pages-directory-buffer.
-;
-; Called with a numeric argument, the `pages-directory' command
-; lists the number of lines in each page. This is helpful when you
-; are printing hardcopy.
+(defcustom pages-directory-for-addresses-buffer-keep-windows-p t
+ "*If nil, `pages-directory-for-addresses' deletes other windows."
+ :type 'boolean
+ :group 'pages)
-; Called with a negative numeric argument, the `pages-directory'
-; command lists the lengths of pages whose contents match a regexp.
+(defcustom pages-directory-for-adding-addresses-narrowing-p t
+ "*If non-nil, `add-new-page' narrows addresses buffer to new entry."
+ :type 'boolean
+ :group 'pages)
\f
-;;;; Key bindings for page handling functions
+;;; Key bindings for page handling functions
(global-unset-key "\C-x\C-p")
(define-key ctl-x-ctl-p-map "d" 'pages-directory-for-addresses)
\f
-;;;; Page movement function definitions
+;;; Page movement function definitions
(defun next-page (&optional count)
"Move to the next page bounded by the `page-delimiter' variable.
(next-page (- count)))
\f
-;;;; Adding and searching pages
+;;; Adding and searching pages
(defun add-new-page (header-line)
- "Insert new page at point; prompt for header line.
-Page begins with a `^L' as the page-delimiter.
+ "Insert new page. Prompt for header line.
+
+If point is in the pages directory buffer, insert the new page in the
+buffer associated with the directory.
+
+Insert the new page just before current page if
+ pages-directory-for-adding-new-page-before-current-page-p variable
+is non-nil. Else insert at exact location of point.
+
+Narrow to new page if
+ pages-directory-for-adding-page-narrowing-p variable
+is non-nil.
+
+Page begins with a `^L' as the default page-delimiter.
+Use \\[set-page-delimiter] to change the page-delimiter.
Point is left in the body of page."
(interactive "sHeader line: ")
(widen)
- (insert (format "\n\f\n%s\n\n" header-line))
- ;; don't renarrow; stay unnarrowed to see context
- (forward-line -1))
+ ;; If in pages directory buffer
+ (if (eq major-mode 'pages-directory-mode)
+ (progn
+ ;; Add new page before or after current page?
+ (if pages-directory-for-adding-new-page-before-current-page-p
+ (pages-directory-goto)
+ (pages-directory-goto)
+ (forward-page)
+ (or (eobp) (forward-line -1)))))
+ (widen)
+ ;; Move point before current delimiter if desired.
+ (and pages-directory-for-adding-new-page-before-current-page-p
+ (if (re-search-backward page-delimiter nil t)
+ (goto-char (match-beginning 0))
+ ;; If going to beginning of file, insert a page-delimiter
+ ;; before current first page.
+ (goto-char (point-min))
+ (insert
+ (format "%s\n"
+ ;; Remove leading `^' from page-delimiter string
+ (if (eq '^ (car (read-from-string page-delimiter)))
+ (substring page-delimiter 1))))
+ (goto-char (point-min))))
+ ;; Insert page delimiter at beginning of line.
+ (if (not (looking-at "^.")) (forward-line 1))
+ (insert (format "%s\n%s\n\n\n"
+ (if (eq '^ (car (read-from-string page-delimiter)))
+ (substring page-delimiter 1))
+ header-line))
+ (forward-line -1)
+ (and pages-directory-for-adding-page-narrowing-p (narrow-to-page)))
(defvar pages-last-search nil
"Value of last regexp searched for. Initially, nil.")
(narrow-to-page))
\f
-;;;; Sorting pages
+;;; Sorting pages
(autoload 'sort-subr "sort" "Primary function for sorting." t nil)
(sort-pages-in-region reverse beginning end)))
\f
-;;;; Pages directory ancillary definitions
-
-(defvar pages-directory-buffer-narrowing-p nil
- "*If non-nil, `pages-directory-goto' narrows pages buffer to entry.")
+;;; Pages directory ancillary definitions
(defvar pages-directory-previous-regexp nil
"Value of previous regexp used by `pages-directory'.
()
(setq pages-directory-map (make-sparse-keymap))
(define-key pages-directory-map "\C-c\C-c"
- 'pages-directory-goto))
+ 'pages-directory-goto)
+ (define-key pages-directory-map "\C-c\C-p\C-a" 'add-new-page)
+ (define-key pages-directory-map [mouse-2] 'pages-directory-goto-with-mouse))
+
+(defvar original-page-delimiter "^\f"
+ "Default page delimiter.")
(defun set-page-delimiter (regexp reset-p)
"Set buffer local value of page-delimiter to REGEXP.
(interactive
(if current-prefix-arg
- (list original-page-delimiter nil)
+ (list original-page-delimiter "^\f")
(list (read-string "Set page-delimiter to regexp: " page-delimiter)
nil)))
(make-local-variable 'original-page-delimiter)
(message "The value of `page-delimiter' is now: %s" page-delimiter)))
\f
-;;;; Pages directory main definitions
+;;; Pages directory main definitions
(defun pages-directory
(pages-list-all-headers-p count-lines-p &optional regexp)
(message "Creating directory for: %s "
(buffer-name)))
- (let ((buffer (current-buffer))
+ (let ((target-buffer (current-buffer))
(pages-directory-buffer
- (concat pages-directory-prefix " " (buffer-name) " "))
+ (concat pages-directory-prefix " " (buffer-name)))
(linenum 1)
(pages-buffer-original-position (point))
(pages-buffer-original-page 0))
(pages-directory-mode)
(insert
"==== Pages Directory: use `C-c C-c' to go to page under cursor. ====" ?\n)
- (setq pages-buffer buffer)
+ (setq pages-buffer target-buffer)
(setq pages-pos-list nil))
(if pages-list-all-headers-p
(setq pages-pos-list (nreverse pages-pos-list))
(if (interactive-p)
(message "%d matching lines in: %s"
- (length pages-pos-list) (buffer-name buffer))))
+ (length pages-pos-list) (buffer-name target-buffer))))
(pop-to-buffer pages-directory-buffer)
(sit-for 0) ; otherwise forward-line fails if N > window height.
(forward-line (if (= 0 pages-buffer-original-page)
1
pages-buffer-original-page))))
+(eval-when-compile
+ (defvar pages-buffer-original-position)
+ (defvar pages-buffer-original-page)
+ (defvar pages-buffer-original-page))
(defun pages-copy-header-and-position (count-lines-p)
"Copy page header and its position to the Pages Directory.
(setq position (make-marker))
(set-marker position (point))
(let ((start (point))
- (end (save-excursion (end-of-line) (point))))
+ (end (save-excursion (end-of-line) (point)))
+ inserted-at)
;; change to directory buffer
(set-buffer standard-output)
;; record page position
(setq pages-pos-list (cons position pages-pos-list))
;; insert page header
- (insert-buffer-substring buffer start end))
+ (setq inserted-at (point))
+ (insert-buffer-substring target-buffer start end)
+ (put-text-property inserted-at (point)
+ 'mouse-face 'highlight)
+ (put-text-property inserted-at (point) 'rear-nonsticky 'highlight))
(if count-lines-p
(save-excursion
(insert (format "%3d: " line-count))))
(terpri))
- (forward-line 1)))
+ (end-of-line 1)))
(defun pages-directory-mode ()
"Mode for handling the pages-directory buffer.
(pos (nth pages-number pages-pos-list))
(end-of-directory-p (eobp))
(narrowing-p pages-directory-buffer-narrowing-p))
- (pop-to-buffer pages-buffer)
+ (pop-to-buffer pages-buffer)
(widen)
(if end-of-directory-p
(goto-char (point-max))
(goto-char (marker-position pos)))
(if narrowing-p (narrow-to-page))))
+(defun pages-directory-goto-with-mouse (event)
+ "Go to the corresponding line under the mouse pointer in the pages buffer."
+ (interactive "e")
+ (save-excursion
+ (set-buffer (window-buffer (posn-window (event-end event))))
+ (save-excursion
+ (goto-char (posn-point (event-end event)))
+ (pages-directory-goto))))
\f
-;;;; The `pages-directory-for-addresses' function and ancillary code
-
-(defvar pages-addresses-file-name "~/addresses"
- "*Standard name for file of addresses. Entries separated by `page-delimiter'.
-Used by `pages-directory-for-addresses' function.")
-
-(defvar pages-directory-for-addresses-narrowing-p t
- "*If non-nil, `pages-directory-goto' narrows addresses buffer to entry.")
+;;; The `pages-directory-for-addresses' function and ancillary code
(defun pages-directory-for-addresses (&optional filename)
"Find addresses file and display its directory.
argument, prompt for file name and provide completion.
Move point to one of the lines in the displayed directory,
-then use C-c C-c to go to the same line in the addresses buffer."
+then use \\[pages-directory-goto] to go to the same line
+in the addresses buffer.
+
+If pages-directory-for-addresses-goto-narrowing-p is non-nil,
+`pages-directory-goto' narrows addresses buffer to entry.
+
+If pages-directory-for-addresses-buffer-keep-windows-p is nil,
+this command deletes other windows when it displays the addresses
+directory."
(interactive
(list (if current-prefix-arg
(widen)
(pages-directory t nil nil)
(pages-directory-address-mode)
- (setq pages-directory-buffer-narrowing-p
- pages-directory-for-addresses-narrowing-p)
- (delete-other-windows)
+ (setq pages-directory-buffer-narrowing-p
+ pages-directory-for-addresses-goto-narrowing-p)
+ (or pages-directory-for-addresses-buffer-keep-windows-p
+ (delete-other-windows))
(save-excursion
(goto-char (point-min))
(delete-region (point) (save-excursion (end-of-line) (point)))
(defun pages-directory-address-mode ()
"Mode for handling the Addresses Directory buffer.
-Move point to one of the lines in this buffer, then use C-c C-c to go
+Move point to one of the lines in this buffer,
+then use \\[pages-directory-goto] to go
to the same line in the pages buffer."
(use-local-map pages-directory-map)
(make-local-variable 'pages-pos-list)
(make-local-variable 'pages-directory-buffer-narrowing-p))
-;;; page-ext.el ends here
+\f
+;;; Place `provide' at end of file.
+(provide 'page-ext)
+
+;;;;;;;;;;;;;;;; end of page-ext.el ;;;;;;;;;;;;;;;;