Commit | Line | Data |
---|---|---|
98d87352 | 1 | ;;; page-ext.el --- extended page handling commands |
0d2d639a | 2 | |
73b0cd50 | 3 | ;; Copyright (C) 1990-1991, 1993-1994, 2001-2011 Free Software Foundation, Inc. |
98d87352 | 4 | |
76ced338 GM |
5 | ;; Author: Robert J. Chassell <bob@gnu.org> |
6 | ;; (according to ack.texi) | |
6228c05b | 7 | ;; Keywords: wp data |
9750e079 | 8 | |
3bab998b ER |
9 | ;; This file is part of GNU Emacs. |
10 | ||
1fecc8fe | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
3bab998b | 12 | ;; it under the terms of the GNU General Public License as published by |
1fecc8fe GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
3bab998b ER |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
1fecc8fe | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
b578f267 EN |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;; You may use these commands to handle an address list or other | |
27 | ;; small data base. | |
3bab998b | 28 | |
0d2d639a | 29 | \f |
98d87352 | 30 | ;;; Summary |
0d2d639a | 31 | |
b578f267 EN |
32 | ;; The current page commands are: |
33 | ||
34 | ;; forward-page C-x ] | |
35 | ;; backward-page C-x [ | |
36 | ;; narrow-to-page C-x p | |
37 | ;; count-lines-page C-x l | |
38 | ;; mark-page C-x C-p (change this to C-x C-p C-m) | |
39 | ;; sort-pages not bound | |
40 | ;; what-page not bound | |
41 | ||
42 | ;; The new page handling commands all use `C-x C-p' as a prefix. This | |
43 | ;; means that the key binding for `mark-page' must be changed. | |
44 | ;; Otherwise, no other changes are made to the current commands or | |
45 | ;; their bindings. | |
46 | ||
47 | ;; New page handling commands: | |
48 | ||
49 | ;; next-page C-x C-p C-n | |
50 | ;; previous-page C-x C-p C-p | |
51 | ;; search-pages C-x C-p C-s | |
52 | ;; add-new-page C-x C-p C-a | |
db95369b | 53 | ;; sort-pages-buffer C-x C-p s |
b578f267 | 54 | ;; set-page-delimiter C-x C-p C-l |
db95369b | 55 | ;; pages-directory C-x C-p C-d |
b578f267 EN |
56 | ;; pages-directory-for-addresses C-x C-p d |
57 | ;; pages-directory-goto C-c C-c | |
0d2d639a JB |
58 | |
59 | \f | |
98d87352 | 60 | ;;; Using the page commands |
db95369b | 61 | |
b578f267 EN |
62 | ;; The page commands are helpful in several different contexts. For |
63 | ;; example, programmers often divide source files into sections using the | |
64 | ;; `page-delimiter'; you can use the `pages-directory' command to list | |
65 | ;; the sections. | |
66 | ||
67 | ;; You may change the buffer local value of the `page-delimiter' with | |
68 | ;; the `set-page-delimiter' command. This command is bound to `C-x C-p | |
69 | ;; C-l' The command prompts you for a new value for the page-delimiter. | |
70 | ;; Called with a prefix-arg, the command resets the value of the | |
71 | ;; page-delimiter to its original value. | |
72 | ||
73 | ;; You may set several user options: | |
74 | ;; | |
75 | ;; The `pages-directory-buffer-narrowing-p' variable causes the | |
76 | ;; `pages-directory-goto' command to narrow to the destination page. | |
77 | ;; | |
78 | ;; The `pages-directory-for-adding-page-narrowing-p' variable, causes the | |
79 | ;; `add-new-page' command to narrow to the new entry. | |
80 | ;; | |
81 | ;; The `pages-directory-for-adding-new-page-before-current-page-p' variable | |
82 | ;; causes the `add-new-page' command to insert a new page before current | |
83 | ;; page. | |
84 | ;; | |
85 | ;; These variables are true by default. | |
86 | ;; | |
87 | ;; Additional, addresses-related user options are described in the next page | |
88 | ;; of this file. | |
98d87352 | 89 | |
0d2d639a | 90 | \f |
98d87352 | 91 | ;;; Handling an address list or small data base |
0d2d639a | 92 | |
b578f267 EN |
93 | ;; You may use the page commands to handle an address list or other |
94 | ;; small data base. Put each address or entry on its own page. The | |
95 | ;; first line of text in each page is a `header line' and is listed by | |
96 | ;; the `pages-directory' or `pages-directory-for-addresses' command. | |
97 | ||
98 | ;; Specifically: | |
db95369b | 99 | ;; |
b578f267 EN |
100 | ;; 1. Begin each entry with a `page-delimiter' (which is, by default, |
101 | ;; `^L' at the beginning of the line). | |
db95369b | 102 | ;; |
b578f267 EN |
103 | ;; 2. The first line of text in each entry is the `heading line'; it |
104 | ;; will appear in the pages-directory-buffer which is constructed | |
105 | ;; using the `C-x C-p C-d' (pages-directory) command or the `C-x | |
106 | ;; C-p d' (pages-directory-for-addresses) command. | |
db95369b | 107 | ;; |
b578f267 EN |
108 | ;; The heading line may be on the same line as the page-delimiter |
109 | ;; or it may follow after. It is the first non-blank line on the | |
110 | ;; page. Conventionally, the heading line is placed on the line | |
111 | ;; immediately following the line containing page-delimiter. | |
112 | ;; | |
113 | ;; 3. Follow the heading line with the body of the entry. The body | |
114 | ;; extends up to the next `page-delimiter'. The body may be of any | |
115 | ;; length. It is conventional to place a blank line after the last | |
116 | ;; line of the body. | |
117 | ||
118 | ;; For example, a file might look like this: | |
db95369b | 119 | ;; |
b578f267 EN |
120 | ;; FSF |
121 | ;; Free Software Foundation | |
086add15 LK |
122 | ;; 51 Franklin Street, Fifth Floor |
123 | ;; Boston, MA 02110-1301 USA. | |
29bd7a8f | 124 | ;; (617) 542-5942 |
5762abec | 125 | ;; gnu@gnu.org |
db95369b | 126 | ;; |
b578f267 EN |
127 | ;; \f |
128 | ;; House Subcommittee on Intellectual Property, | |
129 | ;; U.S. House of Representatives, | |
130 | ;; Washington, DC 20515 | |
db95369b | 131 | ;; |
b578f267 EN |
132 | ;; Congressional committee concerned with permitting or preventing |
133 | ;; monopolistic restrictions on the use of software technology. | |
db95369b | 134 | ;; |
b578f267 EN |
135 | ;; \f |
136 | ;; George Lakoff | |
137 | ;; ``Women, Fire, and Dangerous Things: | |
138 | ;; What Categories Reveal about the Mind'' | |
139 | ;; 1987, Univ. of Chicago Press | |
db95369b | 140 | ;; |
b578f267 | 141 | ;; About philosophy, Whorfian effects, and linguistics. |
db95369b JB |
142 | ;; |
143 | ;; \f | |
b578f267 EN |
144 | ;; OBI (On line text collection.) |
145 | ;; Open Book Initiative | |
146 | ;; c/o Software Tool & Die | |
147 | ;; 1330 Beacon St, Brookline, MA 02146 USA | |
db95369b | 148 | ;; (617) 739-0202 |
b578f267 EN |
149 | ;; obi@world.std.com |
150 | ||
151 | ;; In this example, the heading lines are: | |
152 | ;; | |
153 | ;; FSF | |
154 | ;; House Subcommittee on Intellectual Property | |
155 | ;; George Lakoff | |
156 | ;; OBI (On line text collection.) | |
157 | ||
158 | ;; The `C-x C-p s' (sort-pages-buffer) command sorts the entries in the | |
159 | ;; buffer alphabetically. | |
160 | ||
161 | ;; You may use any of the page commands, including the `next-page', | |
162 | ;; `previous-page', `add-new-page', `mark-page', and `search-pages' | |
163 | ;; commands. | |
164 | ||
165 | ;; You may use either the `C-x C-p d' (pages-directory-for-addresses) | |
166 | ;; or the `C-x C-p C-d' (pages-directory) command to construct and | |
167 | ;; display a directory of all the heading lines. | |
168 | ||
169 | ;; In the directory, you may position the cursor over a heading line | |
170 | ;; and type `C-c C-c' (pages-directory-goto) to go to the entry to | |
171 | ;; which it refers in the pages buffer. | |
172 | ||
173 | ;; You can type `C-c C-p C-a' (add-new-page) to add a new entry in the | |
174 | ;; pages buffer or address file. This is the same command you use to | |
175 | ;; add a new entry when you are in the pages buffer or address file. | |
176 | ||
177 | ;; If you wish, you may create several different directories, | |
178 | ;; one for each different buffer. | |
0d2d639a JB |
179 | |
180 | ;; `pages-directory-for-addresses' in detail | |
181 | ||
b578f267 EN |
182 | ;; The `pages-directory-for-addresses' assumes a default addresses |
183 | ;; file. You do not need to specify the addresses file but merely type | |
184 | ;; `C-x C-p d' from any buffer. The command finds the file, constructs | |
185 | ;; a directory for it, and switches you to the directory. If you call | |
186 | ;; the command with a prefix arg, `C-u C-x C-p d', it prompts you for a | |
187 | ;; file name. | |
0d2d639a | 188 | |
b578f267 | 189 | ;; You may customize the addresses commands: |
98d87352 | 190 | |
b578f267 EN |
191 | ;; The `pages-addresses-file-name' variable determines the name of |
192 | ;; the addresses file; by default it is "~/addresses". | |
98d87352 | 193 | |
b578f267 EN |
194 | ;; The `pages-directory-for-addresses-goto-narrowing-p' variable |
195 | ;; determines whether `pages-directory-goto' narrows the addresses | |
196 | ;; buffer to the entry, which it does by default. | |
98d87352 | 197 | |
b578f267 EN |
198 | ;; The `pages-directory-for-addresses-buffer-keep-windows-p' variable |
199 | ;; determines whether `pages-directory-for-addresses' deletes other | |
200 | ;; windows to show as many lines as possible on the screen or works | |
201 | ;; in the usual Emacs manner and keeps other windows. Default is to | |
202 | ;; keep other windows. | |
98d87352 | 203 | |
b578f267 EN |
204 | ;; The `pages-directory-for-adding-addresses-narrowing-p' variable |
205 | ;; determines whether `pages-directory-for-addresses' narrows the | |
206 | ;; addresses buffer to a new entry when you are adding that entry. | |
207 | ;; Default is to narrow to new entry, which means you see a blank | |
208 | ;; screen before you write the new entry. | |
98d87352 | 209 | |
0d2d639a JB |
210 | ;; `pages-directory' in detail |
211 | ||
b578f267 EN |
212 | ;; Call the `pages-directory' command from the buffer for which you |
213 | ;; want a directory created; it creates a directory for the buffer and | |
214 | ;; pops you to the directory. | |
215 | ||
216 | ;; The `pages-directory' command has several options: | |
217 | ||
218 | ;; Called with a prefix arg, `C-u C-x C-p C-d', the `pages-directory' | |
219 | ;; prompts you for a regular expression and only lists only those | |
220 | ;; header lines that are part of pages that contain matches to the | |
221 | ;; regexp. In the example above, `C-u C-x C-p C-d 617 RET' would | |
222 | ;; match the telephone area code of the first and fourth entries, so | |
223 | ;; only the header lines of those two entries would appear in the | |
224 | ;; pages-directory-buffer. | |
db95369b | 225 | ;; |
b578f267 EN |
226 | ;; Called with a numeric argument, the `pages-directory' command |
227 | ;; lists the number of lines in each page. This is helpful when you | |
db95369b | 228 | ;; are printing hardcopy. |
b578f267 EN |
229 | |
230 | ;; Called with a negative numeric argument, the `pages-directory' | |
231 | ;; command lists the lengths of pages whose contents match a regexp. | |
0d2d639a | 232 | |
98d87352 RS |
233 | ;;; Code: |
234 | ||
235 | \f | |
236 | ;;; Customarily customizable variable definitions | |
237 | ||
00ed33e7 RS |
238 | (defgroup pages nil |
239 | "Extended page-handling commands." | |
240 | :group 'extensions) | |
98d87352 | 241 | |
98d87352 | 242 | |
00ed33e7 | 243 | (defcustom pages-directory-buffer-narrowing-p t |
1fc7dabf | 244 | "If non-nil, `pages-directory-goto' narrows pages buffer to entry." |
00ed33e7 RS |
245 | :type 'boolean |
246 | :group 'pages) | |
247 | ||
248 | (defcustom pages-directory-for-adding-page-narrowing-p t | |
1fc7dabf | 249 | "If non-nil, `add-new-page' narrows page buffer to new entry." |
00ed33e7 RS |
250 | :type 'boolean |
251 | :group 'pages) | |
252 | ||
253 | (defcustom pages-directory-for-adding-new-page-before-current-page-p t | |
1fc7dabf | 254 | "If non-nil, `add-new-page' inserts new page before current page." |
00ed33e7 RS |
255 | :type 'boolean |
256 | :group 'pages) | |
98d87352 RS |
257 | |
258 | \f | |
259 | ;;; Addresses related variables | |
260 | ||
00ed33e7 | 261 | (defcustom pages-addresses-file-name "~/addresses" |
1fc7dabf | 262 | "Standard name for file of addresses. Entries separated by page-delimiter. |
00ed33e7 RS |
263 | Used by `pages-directory-for-addresses' function." |
264 | :type 'file | |
265 | :group 'pages) | |
266 | ||
267 | (defcustom pages-directory-for-addresses-goto-narrowing-p t | |
1fc7dabf | 268 | "If non-nil, `pages-directory-goto' narrows addresses buffer to entry." |
00ed33e7 RS |
269 | :type 'boolean |
270 | :group 'pages) | |
271 | ||
272 | (defcustom pages-directory-for-addresses-buffer-keep-windows-p t | |
1fc7dabf | 273 | "If nil, `pages-directory-for-addresses' deletes other windows." |
00ed33e7 RS |
274 | :type 'boolean |
275 | :group 'pages) | |
276 | ||
277 | (defcustom pages-directory-for-adding-addresses-narrowing-p t | |
1fc7dabf | 278 | "If non-nil, `add-new-page' narrows addresses buffer to new entry." |
00ed33e7 RS |
279 | :type 'boolean |
280 | :group 'pages) | |
98d87352 | 281 | |
0d2d639a | 282 | \f |
98d87352 | 283 | ;;; Key bindings for page handling functions |
0d2d639a JB |
284 | |
285 | (global-unset-key "\C-x\C-p") | |
286 | ||
287 | (defvar ctl-x-ctl-p-map (make-sparse-keymap) | |
288 | "Keymap for subcommands of C-x C-p, which are for page handling.") | |
289 | ||
290 | (define-key ctl-x-map "\C-p" 'ctl-x-ctl-p-prefix) | |
291 | (fset 'ctl-x-ctl-p-prefix ctl-x-ctl-p-map) | |
292 | ||
293 | (define-key ctl-x-ctl-p-map "\C-n" 'next-page) | |
294 | (define-key ctl-x-ctl-p-map "\C-p" 'previous-page) | |
295 | (define-key ctl-x-ctl-p-map "\C-a" 'add-new-page) | |
296 | (define-key ctl-x-ctl-p-map "\C-m" 'mark-page) | |
297 | (define-key ctl-x-ctl-p-map "\C-s" 'search-pages) | |
298 | (define-key ctl-x-ctl-p-map "s" 'sort-pages-buffer) | |
299 | (define-key ctl-x-ctl-p-map "\C-l" 'set-page-delimiter) | |
300 | (define-key ctl-x-ctl-p-map "\C-d" 'pages-directory) | |
301 | (define-key ctl-x-ctl-p-map "d" 'pages-directory-for-addresses) | |
302 | ||
303 | \f | |
98d87352 | 304 | ;;; Page movement function definitions |
0d2d639a JB |
305 | |
306 | (defun next-page (&optional count) | |
307 | "Move to the next page bounded by the `page-delimiter' variable. | |
308 | With arg (prefix if interactive), move that many pages." | |
309 | (interactive "p") | |
310 | (or count (setq count 1)) | |
311 | (widen) | |
312 | ;; Cannot use forward-page because of problems at page boundaries. | |
313 | (while (and (> count 0) (not (eobp))) | |
314 | (if (re-search-forward page-delimiter nil t) | |
315 | nil | |
316 | (goto-char (point-max))) | |
317 | (setq count (1- count))) | |
817d6535 JB |
318 | ;; If COUNT is negative, we want to go back -COUNT + 1 page boundaries. |
319 | ;; The first page boundary we reach is the top of the current page, | |
320 | ;; which doesn't count. | |
321 | (while (and (< count 1) (not (bobp))) | |
0d2d639a JB |
322 | (if (re-search-backward page-delimiter nil t) |
323 | (goto-char (match-beginning 0)) | |
324 | (goto-char (point-min))) | |
325 | (setq count (1+ count))) | |
326 | (narrow-to-page) | |
327 | (goto-char (point-min)) | |
328 | (recenter 0)) | |
329 | ||
330 | (defun previous-page (&optional count) | |
331 | "Move to the previous page bounded by the `page-delimiter' variable. | |
332 | With arg (prefix if interactive), move that many pages." | |
333 | (interactive "p") | |
334 | (or count (setq count 1)) | |
335 | (next-page (- count))) | |
336 | ||
337 | \f | |
98d87352 | 338 | ;;; Adding and searching pages |
0d2d639a JB |
339 | |
340 | (defun add-new-page (header-line) | |
98d87352 RS |
341 | "Insert new page. Prompt for header line. |
342 | ||
343 | If point is in the pages directory buffer, insert the new page in the | |
344 | buffer associated with the directory. | |
345 | ||
346 | Insert the new page just before current page if | |
347 | pages-directory-for-adding-new-page-before-current-page-p variable | |
348 | is non-nil. Else insert at exact location of point. | |
349 | ||
350 | Narrow to new page if | |
351 | pages-directory-for-adding-page-narrowing-p variable | |
352 | is non-nil. | |
353 | ||
db95369b | 354 | Page begins with a `^L' as the default page-delimiter. |
98d87352 | 355 | Use \\[set-page-delimiter] to change the page-delimiter. |
0d2d639a JB |
356 | Point is left in the body of page." |
357 | (interactive "sHeader line: ") | |
358 | (widen) | |
98d87352 | 359 | ;; If in pages directory buffer |
db95369b | 360 | (if (eq major-mode 'pages-directory-mode) |
98d87352 RS |
361 | (progn |
362 | ;; Add new page before or after current page? | |
363 | (if pages-directory-for-adding-new-page-before-current-page-p | |
364 | (pages-directory-goto) | |
365 | (pages-directory-goto) | |
366 | (forward-page) | |
367 | (or (eobp) (forward-line -1))))) | |
368 | (widen) | |
369 | ;; Move point before current delimiter if desired. | |
370 | (and pages-directory-for-adding-new-page-before-current-page-p | |
371 | (if (re-search-backward page-delimiter nil t) | |
372 | (goto-char (match-beginning 0)) | |
373 | ;; If going to beginning of file, insert a page-delimiter | |
374 | ;; before current first page. | |
375 | (goto-char (point-min)) | |
376 | (insert | |
377 | (format "%s\n" | |
378 | ;; Remove leading `^' from page-delimiter string | |
379 | (if (eq '^ (car (read-from-string page-delimiter))) | |
db95369b | 380 | (substring page-delimiter 1)))) |
98d87352 RS |
381 | (goto-char (point-min)))) |
382 | ;; Insert page delimiter at beginning of line. | |
383 | (if (not (looking-at "^.")) (forward-line 1)) | |
db95369b | 384 | (insert (format "%s\n%s\n\n\n" |
98d87352 RS |
385 | (if (eq '^ (car (read-from-string page-delimiter))) |
386 | (substring page-delimiter 1)) | |
387 | header-line)) | |
388 | (forward-line -1) | |
389 | (and pages-directory-for-adding-page-narrowing-p (narrow-to-page))) | |
0d2d639a JB |
390 | |
391 | (defvar pages-last-search nil | |
392 | "Value of last regexp searched for. Initially, nil.") | |
393 | ||
394 | (defun search-pages (regexp) | |
395 | "Search for REGEXP, starting from point, and narrow to page it is in." | |
396 | (interactive (list | |
397 | (read-string | |
398 | (format "Search for `%s' (end with RET): " | |
399 | (or pages-last-search "regexp"))))) | |
400 | (if (equal regexp "") | |
401 | (setq regexp pages-last-search) | |
402 | (setq pages-last-search regexp)) | |
403 | (widen) | |
404 | (re-search-forward regexp) | |
405 | (narrow-to-page)) | |
406 | ||
407 | \f | |
98d87352 | 408 | ;;; Sorting pages |
0d2d639a JB |
409 | |
410 | (autoload 'sort-subr "sort" "Primary function for sorting." t nil) | |
411 | ||
412 | (defun sort-pages-in-region (reverse beg end) | |
db95369b | 413 | "Sort pages in region alphabetically. Prefix arg means reverse order. |
0d2d639a JB |
414 | |
415 | Called from a program, there are three arguments: | |
416 | REVERSE (non-nil means reverse order), BEG and END (region to sort)." | |
417 | ||
418 | ;;; This sort function handles ends of pages differently than | |
419 | ;;; `sort-pages' and works better with lists of addresses and similar | |
420 | ;;; files. | |
421 | ||
422 | (interactive "P\nr") | |
423 | (save-restriction | |
424 | (narrow-to-region beg end) | |
425 | (goto-char (point-min)) | |
426 | ;;; `sort-subr' takes three arguments | |
427 | (sort-subr reverse | |
428 | ||
429 | ;; NEXTRECFUN is called with point at the end of the | |
430 | ;; previous record. It moves point to the start of the | |
431 | ;; next record. | |
432 | (function (lambda () | |
433 | (re-search-forward page-delimiter nil t) | |
434 | (skip-chars-forward " \t\n") | |
435 | )) | |
436 | ||
437 | ;; ENDRECFUN is is called with point within the record. | |
438 | ;; It should move point to the end of the record. | |
439 | (function (lambda () | |
440 | (if (re-search-forward | |
441 | page-delimiter | |
442 | nil | |
443 | t) | |
444 | (goto-char (match-beginning 0)) | |
445 | (goto-char (point-max)))))))) | |
446 | ||
447 | (defun sort-pages-buffer (&optional reverse) | |
db95369b | 448 | "Sort pages alphabetically in buffer. Prefix arg means reverse order. |
0d2d639a JB |
449 | \(Non-nil arg if not interactive.\)" |
450 | ||
451 | (interactive "P") | |
452 | (or reverse (setq reverse nil)) | |
453 | (widen) | |
454 | (let ((beginning (point-min)) | |
455 | (end (point-max))) | |
456 | (sort-pages-in-region reverse beginning end))) | |
457 | ||
458 | \f | |
98d87352 | 459 | ;;; Pages directory ancillary definitions |
0d2d639a JB |
460 | |
461 | (defvar pages-directory-previous-regexp nil | |
462 | "Value of previous regexp used by `pages-directory'. | |
463 | \(This regular expression may be used to select only those pages that | |
464 | contain matches to the regexp.\)") | |
465 | ||
466 | (defvar pages-buffer nil | |
467 | "The buffer for which the pages-directory function creates the directory.") | |
468 | ||
469 | (defvar pages-directory-prefix "*Directory for:" | |
470 | "Prefix of name of temporary buffer for pages-directory.") | |
471 | ||
472 | (defvar pages-pos-list nil | |
473 | "List containing the positions of the pages in the pages-buffer.") | |
474 | ||
2600f4e4 RS |
475 | (defvar pages-target-buffer) |
476 | ||
764e5002 SM |
477 | (defvar pages-directory-mode-map |
478 | (let ((map (make-sparse-keymap))) | |
479 | (define-key map "\C-c\C-c" 'pages-directory-goto) | |
480 | (define-key map "\C-c\C-p\C-a" 'add-new-page) | |
481 | (define-key map [mouse-2] 'pages-directory-goto-with-mouse) | |
482 | map) | |
0d2d639a | 483 | "Keymap for the pages-directory-buffer.") |
764e5002 | 484 | (defvaralias 'pages-directory-map 'pages-directory-mode-map) |
98d87352 | 485 | |
98526426 | 486 | (defvar original-page-delimiter "^\f" |
98d87352 | 487 | "Default page delimiter.") |
0d2d639a JB |
488 | |
489 | (defun set-page-delimiter (regexp reset-p) | |
490 | "Set buffer local value of page-delimiter to REGEXP. | |
491 | Called interactively with a prefix argument, reset `page-delimiter' to | |
492 | its original value. | |
493 | ||
494 | In a program, non-nil second arg causes first arg to be ignored and | |
495 | resets the page-delimiter to the original value." | |
db95369b | 496 | |
0d2d639a JB |
497 | (interactive |
498 | (if current-prefix-arg | |
98526426 | 499 | (list original-page-delimiter "^\f") |
0d2d639a JB |
500 | (list (read-string "Set page-delimiter to regexp: " page-delimiter) |
501 | nil))) | |
502 | (make-local-variable 'original-page-delimiter) | |
503 | (make-local-variable 'page-delimiter) | |
504 | (setq original-page-delimiter | |
505 | (or original-page-delimiter page-delimiter)) | |
506 | (if (not reset-p) | |
507 | (setq page-delimiter regexp) | |
508 | (setq page-delimiter original-page-delimiter)) | |
32226619 | 509 | (if (called-interactively-p 'interactive) |
0d2d639a JB |
510 | (message "The value of `page-delimiter' is now: %s" page-delimiter))) |
511 | ||
512 | \f | |
98d87352 | 513 | ;;; Pages directory main definitions |
0d2d639a JB |
514 | |
515 | (defun pages-directory | |
516 | (pages-list-all-headers-p count-lines-p &optional regexp) | |
517 | "Display a directory of the page headers in a temporary buffer. | |
518 | A header is the first non-blank line after the page-delimiter. | |
519 | \\[pages-directory-mode] | |
520 | You may move point to one of the lines in the temporary buffer, | |
521 | then use \\<pages-directory-goto> to go to the same line in the pages buffer. | |
522 | ||
523 | In interactive use: | |
524 | ||
525 | 1. With no prefix arg, display all headers. | |
526 | ||
527 | 2. With prefix arg, display the headers of only those pages that | |
528 | contain matches to a regular expression for which you are | |
529 | prompted. | |
530 | ||
531 | 3. With numeric prefix arg, for every page, print the number of | |
532 | lines within each page. | |
533 | ||
534 | 4. With negative numeric prefix arg, for only those pages that | |
535 | match a regular expression, print the number of lines within | |
536 | each page. | |
537 | ||
538 | When called from a program, non-nil first arg means list all headers; | |
539 | non-nil second arg means print numbers of lines in each page; if first | |
540 | arg is nil, optional third arg is regular expression. | |
541 | ||
542 | If the buffer is narrowed, the `pages-directory' command creates a | |
543 | directory for only the accessible portion of the buffer." | |
db95369b | 544 | |
0d2d639a JB |
545 | (interactive |
546 | (cond ((not current-prefix-arg) | |
547 | (list t nil nil)) | |
db95369b | 548 | ((listp current-prefix-arg) |
0d2d639a JB |
549 | (list nil |
550 | nil | |
551 | (read-string | |
552 | (format "Select according to `%s' (end with RET): " | |
553 | (or pages-directory-previous-regexp "regexp"))))) | |
554 | ((> (prefix-numeric-value current-prefix-arg) 0) | |
555 | (list t t nil)) | |
db95369b | 556 | ((< (prefix-numeric-value current-prefix-arg) 0) |
0d2d639a JB |
557 | (list nil |
558 | t | |
559 | (read-string | |
560 | (format "Select according to `%s' (end with RET): " | |
561 | (or pages-directory-previous-regexp "regexp"))))))) | |
db95369b | 562 | |
0d2d639a JB |
563 | (if (equal regexp "") |
564 | (setq regexp pages-directory-previous-regexp) | |
565 | (setq pages-directory-previous-regexp regexp)) | |
db95369b | 566 | |
32226619 | 567 | (if (called-interactively-p 'interactive) |
0d2d639a JB |
568 | (message "Creating directory for: %s " |
569 | (buffer-name))) | |
db95369b | 570 | |
2600f4e4 | 571 | (let ((pages-target-buffer (current-buffer)) |
0d2d639a | 572 | (pages-directory-buffer |
e6945ec7 | 573 | (concat pages-directory-prefix " " (buffer-name))) |
0d2d639a JB |
574 | (linenum 1) |
575 | (pages-buffer-original-position (point)) | |
576 | (pages-buffer-original-page 0)) | |
db95369b | 577 | |
0d2d639a JB |
578 | ;; `with-output-to-temp-buffer' binds the value of the variable |
579 | ;; `standard-output' to the buffer named as its first argument, | |
580 | ;; but does not switch to that buffer. | |
581 | (with-output-to-temp-buffer pages-directory-buffer | |
9a529312 | 582 | (with-current-buffer standard-output |
0d2d639a JB |
583 | (pages-directory-mode) |
584 | (insert | |
585 | "==== Pages Directory: use `C-c C-c' to go to page under cursor. ====" ?\n) | |
2600f4e4 | 586 | (setq pages-buffer pages-target-buffer) |
0d2d639a | 587 | (setq pages-pos-list nil)) |
db95369b | 588 | |
0d2d639a | 589 | (if pages-list-all-headers-p |
db95369b | 590 | |
0d2d639a JB |
591 | ;; 1. If no prefix argument, list all headers |
592 | (save-excursion | |
593 | (goto-char (point-min)) | |
db95369b | 594 | |
0d2d639a JB |
595 | ;; (a) Point is at beginning of buffer; but the first |
596 | ;; page may not begin with a page-delimiter | |
597 | (save-restriction | |
598 | ;; If page delimiter is at beginning of buffer, skip it | |
599 | (if (and (save-excursion | |
600 | (re-search-forward page-delimiter nil t)) | |
601 | (= 1 (match-beginning 0))) | |
602 | (goto-char (match-end 0))) | |
603 | (narrow-to-page) | |
604 | (pages-copy-header-and-position count-lines-p)) | |
db95369b | 605 | |
0d2d639a JB |
606 | ;; (b) Search within pages buffer for next page-delimiter |
607 | (while (re-search-forward page-delimiter nil t) | |
608 | (pages-copy-header-and-position count-lines-p))) | |
db95369b | 609 | |
0d2d639a JB |
610 | ;; 2. Else list headers whose pages match regexp. |
611 | (save-excursion | |
612 | ;; REMOVED save-restriction AND widen FROM HERE | |
613 | (goto-char (point-min)) | |
db95369b | 614 | |
0d2d639a JB |
615 | ;; (a) Handle first page |
616 | (save-restriction | |
617 | (narrow-to-page) | |
618 | ;; search for selection regexp | |
619 | (if (save-excursion (re-search-forward regexp nil t)) | |
620 | (pages-copy-header-and-position count-lines-p))) | |
db95369b | 621 | |
0d2d639a JB |
622 | ;; (b) Search for next page-delimiter |
623 | (while (re-search-forward page-delimiter nil t) | |
624 | (save-restriction | |
625 | (narrow-to-page) | |
626 | ;; search for selection regexp | |
627 | (if (save-excursion (re-search-forward regexp nil t)) | |
628 | (pages-copy-header-and-position count-lines-p) | |
629 | ))))) | |
db95369b | 630 | |
0d2d639a JB |
631 | (set-buffer standard-output) |
632 | ;; Put positions in increasing order to go with buffer. | |
633 | (setq pages-pos-list (nreverse pages-pos-list)) | |
32226619 | 634 | (if (called-interactively-p 'interactive) |
0d2d639a | 635 | (message "%d matching lines in: %s" |
2600f4e4 | 636 | (length pages-pos-list) (buffer-name pages-target-buffer)))) |
0d2d639a JB |
637 | (pop-to-buffer pages-directory-buffer) |
638 | (sit-for 0) ; otherwise forward-line fails if N > window height. | |
639 | (forward-line (if (= 0 pages-buffer-original-page) | |
640 | 1 | |
641 | pages-buffer-original-page)))) | |
0d56ae89 GM |
642 | |
643 | (defvar pages-buffer-original-position) | |
644 | (defvar pages-buffer-original-page) | |
645 | (defvar pages-buffer-original-page) | |
0d2d639a JB |
646 | |
647 | (defun pages-copy-header-and-position (count-lines-p) | |
648 | "Copy page header and its position to the Pages Directory. | |
649 | Only arg non-nil, count lines in page and insert before header. | |
650 | Used by `pages-directory' function." | |
db95369b | 651 | |
0d2d639a JB |
652 | (let (position line-count) |
653 | ||
654 | (if count-lines-p | |
655 | (save-excursion | |
656 | (save-restriction | |
657 | (narrow-to-page) | |
658 | (setq line-count (count-lines (point-min) (point-max)))))) | |
659 | ||
660 | ;; Keep track of page for later cursor positioning | |
661 | (if (<= (point) pages-buffer-original-position) | |
662 | (setq pages-buffer-original-page | |
663 | (1+ pages-buffer-original-page))) | |
db95369b | 664 | |
0d2d639a JB |
665 | (save-excursion |
666 | ;; go to first non-blank char after the page-delimiter | |
db95369b | 667 | (skip-chars-forward " \t\n") |
0d2d639a | 668 | ;; set the marker here; this the place to which the |
db95369b | 669 | ;; `pages-directory-goto' command will go |
0d2d639a JB |
670 | (setq position (make-marker)) |
671 | (set-marker position (point)) | |
672 | (let ((start (point)) | |
5ed619e0 | 673 | (end (line-end-position)) |
a2b327b6 | 674 | inserted-at) |
0d2d639a JB |
675 | ;; change to directory buffer |
676 | (set-buffer standard-output) | |
db95369b | 677 | ;; record page position |
0d2d639a JB |
678 | (setq pages-pos-list (cons position pages-pos-list)) |
679 | ;; insert page header | |
a2b327b6 | 680 | (setq inserted-at (point)) |
2600f4e4 | 681 | (insert-buffer-substring pages-target-buffer start end) |
db95369b | 682 | (add-text-properties inserted-at (point) |
dc44c48c EZ |
683 | '(mouse-face highlight |
684 | help-echo "mouse-2: go to this page")) | |
cac7e5a8 | 685 | (put-text-property inserted-at (point) 'rear-nonsticky 'highlight)) |
db95369b | 686 | |
0d2d639a JB |
687 | (if count-lines-p |
688 | (save-excursion | |
689 | (beginning-of-line) | |
690 | (insert (format "%3d: " line-count)))) | |
db95369b | 691 | |
0d2d639a | 692 | (terpri)) |
e6945ec7 | 693 | (end-of-line 1))) |
0d2d639a | 694 | |
f8da45ad | 695 | (defun pages-directory-mode () |
0d2d639a JB |
696 | "Mode for handling the pages-directory buffer. |
697 | ||
698 | Move point to one of the lines in this buffer, then use \\[pages-directory-goto] to go | |
699 | to the same line in the pages buffer." | |
f8da45ad RS |
700 | |
701 | (kill-all-local-variables) | |
764e5002 | 702 | (use-local-map pages-directory-mode-map) |
f8da45ad RS |
703 | (setq major-mode 'pages-directory-mode) |
704 | (setq mode-name "Pages-Directory") | |
0d2d639a JB |
705 | (make-local-variable 'pages-buffer) |
706 | (make-local-variable 'pages-pos-list) | |
764e5002 SM |
707 | (make-local-variable 'pages-directory-buffer-narrowing-p) |
708 | (run-mode-hooks 'pages-directory-mode-hook)) | |
0d2d639a JB |
709 | |
710 | (defun pages-directory-goto () | |
711 | "Go to the corresponding line in the pages buffer." | |
712 | ||
713 | ;;; This function is mostly a copy of `occur-mode-goto-occurrence' | |
714 | ||
715 | (interactive) | |
716 | (if (or (not pages-buffer) | |
717 | (not (buffer-name pages-buffer))) | |
718 | (progn | |
719 | (setq pages-buffer nil | |
720 | pages-pos-list nil) | |
e8af40ee | 721 | (error "Buffer in which pages were found is deleted"))) |
0d2d639a JB |
722 | (beginning-of-line) |
723 | (let* ((pages-number (1- (count-lines (point-min) (point)))) | |
724 | (pos (nth pages-number pages-pos-list)) | |
725 | (end-of-directory-p (eobp)) | |
726 | (narrowing-p pages-directory-buffer-narrowing-p)) | |
db95369b | 727 | (pop-to-buffer pages-buffer) |
0d2d639a JB |
728 | (widen) |
729 | (if end-of-directory-p | |
730 | (goto-char (point-max)) | |
731 | (goto-char (marker-position pos))) | |
732 | (if narrowing-p (narrow-to-page)))) | |
733 | ||
a2b327b6 RS |
734 | (defun pages-directory-goto-with-mouse (event) |
735 | "Go to the corresponding line under the mouse pointer in the pages buffer." | |
736 | (interactive "e") | |
9a529312 | 737 | (with-current-buffer (window-buffer (posn-window (event-end event))) |
a2b327b6 RS |
738 | (save-excursion |
739 | (goto-char (posn-point (event-end event))) | |
740 | (pages-directory-goto)))) | |
0d2d639a | 741 | \f |
98d87352 | 742 | ;;; The `pages-directory-for-addresses' function and ancillary code |
0d2d639a JB |
743 | |
744 | (defun pages-directory-for-addresses (&optional filename) | |
745 | "Find addresses file and display its directory. | |
746 | By default, create and display directory of `pages-addresses-file-name'. | |
747 | Optional argument is FILENAME. In interactive use, with prefix | |
748 | argument, prompt for file name and provide completion. | |
749 | ||
750 | Move point to one of the lines in the displayed directory, | |
98d87352 RS |
751 | then use \\[pages-directory-goto] to go to the same line |
752 | in the addresses buffer. | |
753 | ||
754 | If pages-directory-for-addresses-goto-narrowing-p is non-nil, | |
755 | `pages-directory-goto' narrows addresses buffer to entry. | |
756 | ||
757 | If pages-directory-for-addresses-buffer-keep-windows-p is nil, | |
db95369b | 758 | this command deletes other windows when it displays the addresses |
98d87352 | 759 | directory." |
0d2d639a JB |
760 | |
761 | (interactive | |
762 | (list (if current-prefix-arg | |
763 | (read-file-name "Filename: " pages-addresses-file-name)))) | |
764 | ||
32226619 | 765 | (if (called-interactively-p 'interactive) |
0d2d639a JB |
766 | (message "Creating directory for: %s " |
767 | (or filename pages-addresses-file-name))) | |
768 | (if (file-exists-p (or filename pages-addresses-file-name)) | |
769 | (progn | |
770 | (set-buffer | |
771 | (find-file-noselect | |
772 | (expand-file-name | |
773 | (or filename pages-addresses-file-name)))) | |
774 | (widen) | |
775 | (pages-directory t nil nil) | |
73aee91d RC |
776 | ;; by RJC, 2006 Jun 11: including this causes failure; it results in |
777 | ;; the message "Buffer in which pages were found is deleted" | |
778 | ;; (pages-directory-address-mode) | |
98d87352 RS |
779 | (setq pages-directory-buffer-narrowing-p |
780 | pages-directory-for-addresses-goto-narrowing-p) | |
781 | (or pages-directory-for-addresses-buffer-keep-windows-p | |
782 | (delete-other-windows)) | |
0d2d639a JB |
783 | (save-excursion |
784 | (goto-char (point-min)) | |
5ed619e0 | 785 | (delete-region (point) (line-end-position)) |
0d2d639a JB |
786 | (insert |
787 | "=== Address List Directory: use `C-c C-c' to go to page under cursor. ===") | |
788 | (set-buffer-modified-p nil) | |
789 | )) | |
790 | (error "No addresses file found!"))) | |
791 | ||
764e5002 SM |
792 | (define-derived-mode pages-directory-address-mode pages-directory-mode |
793 | "Addresses Directory" | |
0d2d639a JB |
794 | "Mode for handling the Addresses Directory buffer. |
795 | ||
98d87352 RS |
796 | Move point to one of the lines in this buffer, |
797 | then use \\[pages-directory-goto] to go | |
0d2d639a | 798 | to the same line in the pages buffer." |
764e5002 | 799 | :syntax-table nil) |
0d2d639a | 800 | |
98d87352 | 801 | (provide 'page-ext) |
ab5796a9 | 802 | |
e8af40ee | 803 | ;;; page-ext.el ends here |