Function: pages-directory
pages-directory is an interactive and byte-compiled function defined
in page-ext.el.gz.
Signature
(pages-directory PAGES-LIST-ALL-HEADERS-P COUNT-LINES-P &optional REGEXP)
Documentation
Display a directory of the page headers in a temporary buffer.
A header is the first non-blank line after the page-delimiter.
You may move point to one of the lines in the temporary buffer,
then use RET (pages-directory-goto) to go to the same line in the pages buffer.
In interactive use:
1. With no prefix arg, display all headers.
2. With prefix arg, display the headers of only those pages that
contain matches to a regular expression for which you are
prompted.
3. With numeric prefix arg, for every page, print the number of
lines within each page.
4. With negative numeric prefix arg, for only those pages that
match a regular expression, print the number of lines within
each page.
When called from a program, non-nil first arg means list all headers; non-nil second arg means print numbers of lines in each page; if first arg is nil, optional third arg is regular expression.
If the buffer is narrowed, the pages-directory command creates a
directory for only the accessible portion of the buffer.
Key Bindings
Source Code
;; Defined in /usr/src/emacs/lisp/textmodes/page-ext.el.gz
(defun pages-directory (pages-list-all-headers-p count-lines-p &optional regexp)
"Display a directory of the page headers in a temporary buffer.
A header is the first non-blank line after the `page-delimiter'.
\\<pages-directory-mode-map>
You may move point to one of the lines in the temporary buffer,
then use \\[pages-directory-goto] to go to the same line in the pages buffer.
In interactive use:
1. With no prefix arg, display all headers.
2. With prefix arg, display the headers of only those pages that
contain matches to a regular expression for which you are
prompted.
3. With numeric prefix arg, for every page, print the number of
lines within each page.
4. With negative numeric prefix arg, for only those pages that
match a regular expression, print the number of lines within
each page.
When called from a program, non-nil first arg means list all headers;
non-nil second arg means print numbers of lines in each page; if first
arg is nil, optional third arg is regular expression.
If the buffer is narrowed, the `pages-directory' command creates a
directory for only the accessible portion of the buffer."
(interactive
(cond ((not current-prefix-arg)
(list t nil nil))
((listp current-prefix-arg)
(list nil
nil
(read-string
(format-message
"Select according to `%s' (end with RET): "
(or pages-directory-previous-regexp "regexp")))))
((> (prefix-numeric-value current-prefix-arg) 0)
(list t t nil))
((< (prefix-numeric-value current-prefix-arg) 0)
(list nil
t
(read-string
(format-message
"Select according to `%s' (end with RET): "
(or pages-directory-previous-regexp "regexp")))))))
(if (equal regexp "")
(setq regexp pages-directory-previous-regexp)
(setq pages-directory-previous-regexp regexp))
(if (called-interactively-p 'interactive)
(message "Creating directory for: %s "
(buffer-name)))
(let ((pages-target-buffer (current-buffer))
(pages-directory-buffer
(concat pages-directory-prefix " " (buffer-name)))
(pages-buffer-original-position (point))
(pages-buffer-original-page 0))
;; `with-output-to-temp-buffer' binds the value of the variable
;; `standard-output' to the buffer named as its first argument,
;; but does not switch to that buffer.
(with-output-to-temp-buffer pages-directory-buffer
(with-current-buffer standard-output
(pages-directory-mode)
(setq buffer-read-only nil)
(insert
(substitute-command-keys
"==== Pages Directory: use \\<pages-directory-mode-map>\
\\[pages-directory-goto] to go to page under cursor. ====") "\n")
(setq pages-buffer pages-target-buffer)
(setq pages-pos-list nil))
(if pages-list-all-headers-p
;; 1. If no prefix argument, list all headers
(save-excursion
(goto-char (point-min))
;; (a) Point is at beginning of buffer; but the first
;; page may not begin with a page-delimiter
(save-restriction
;; If page delimiter is at beginning of buffer, skip it
(if (and (save-excursion
(re-search-forward page-delimiter nil t))
(= 1 (match-beginning 0)))
(goto-char (match-end 0)))
(narrow-to-page)
(pages-copy-header-and-position count-lines-p))
;; (b) Search within pages buffer for next page-delimiter
(while (re-search-forward page-delimiter nil t)
(pages-copy-header-and-position count-lines-p)))
;; 2. Else list headers whose pages match regexp.
(save-excursion
;; REMOVED save-restriction AND widen FROM HERE
(goto-char (point-min))
;; (a) Handle first page
(save-restriction
(narrow-to-page)
;; search for selection regexp
(if (save-excursion (re-search-forward regexp nil t))
(pages-copy-header-and-position count-lines-p)))
;; (b) Search for next page-delimiter
(while (re-search-forward page-delimiter nil t)
(save-restriction
(narrow-to-page)
;; search for selection regexp
(if (save-excursion (re-search-forward regexp nil t))
(pages-copy-header-and-position count-lines-p)
)))))
(set-buffer standard-output)
(setq buffer-read-only t)
;; Put positions in increasing order to go with buffer.
(setq pages-pos-list (nreverse pages-pos-list))
(if (called-interactively-p 'interactive)
(message "%d matching lines in: %s"
(length pages-pos-list) (buffer-name pages-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))))