Mercurial > emacs
annotate lisp/play/fortune.el @ 41309:8c4c4027c7bd
(cperl-perldoc): Require man before binding `manual-program'.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Tue, 20 Nov 2001 14:20:41 +0000 |
parents | 2d351e49dc96 |
children | 0d8b17d428b5 |
rev | line source |
---|---|
38425
c6e12c6b1498
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
38397
diff
changeset
|
1 ;;; fortune.el --- use fortune to create signatures |
38524 | 2 |
37426 | 3 ;; Copyright (C) 1999, 2001 Free Software Foundation, Inc. |
25480 | 4 |
5 ;; Author: Holger Schauer <Holger.Schauer@gmx.de> | |
6 ;; Keywords: games utils mail | |
7 | |
38425
c6e12c6b1498
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
38397
diff
changeset
|
8 ;; This file is part of GNU Emacs. |
25480 | 9 |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
24 | |
25 ;;; Commentary: | |
26 ;; This utility allows you to automatically cut regions to a fortune | |
27 ;; file. In case that the region stems from an article buffer (mail or | |
28 ;; news), it will try to automatically determine the author of the | |
29 ;; fortune. It will also allow you to compile your fortune-database | |
30 ;; as well as providing a function to extract a fortune for use as your | |
31 ;; signature. | |
32 ;; Of course, it can simply display a fortune, too. | |
33 ;; Use prefix arguments to specify different fortune databases. | |
34 | |
35 ;;; Installation: | |
36 | |
38524 | 37 ;; Please check the customize settings -- you will at least have to |
38 ;; modify the values of `fortune-dir' and `fortune-file'. | |
25480 | 39 |
40 ;; I then use this in my .gnus: | |
41 ;;(message "Making new signature: %s" (fortune-to-signature "~/fortunes/")) | |
42 ;; This automagically creates a new signature when starting up Gnus. | |
43 ;; Note that the call to fortune-to-signature specifies a directory in which | |
44 ;; several fortune-files and their databases are stored. | |
45 | |
46 ;; If you like to get a new signature for every message, you can also hook | |
47 ;; it into message-mode: | |
38524 | 48 ;; (add-hook 'message-setup-hook 'fortune-to-signature) |
25480 | 49 ;; This time no fortune-file is specified, so fortune-to-signature would use |
50 ;; the default-file as specified by fortune-file. | |
51 | |
52 ;; I have also this in my .gnus: | |
53 ;;(add-hook 'gnus-article-mode-hook | |
54 ;; '(lambda () | |
55 ;; (define-key gnus-article-mode-map "i" 'fortune-from-region))) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
56 ;; which allows marking a region and then pressing "i" so that the marked |
25480 | 57 ;; region will be automatically added to my favourite fortune-file. |
58 | |
59 ;;; Code: | |
60 | |
61 ;;; ************** | |
62 ;;; Customizable Settings | |
63 (defgroup fortune nil | |
64 "Settings for fortune." | |
38524 | 65 :link '(emacs-commentary-link "fortune.el") |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
66 :version "21.1" |
25480 | 67 :group 'games) |
68 (defgroup fortune-signature nil | |
69 "Settings for use of fortune for signatures." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
70 :group 'fortune |
25480 | 71 :group 'mail) |
72 | |
73 (defcustom fortune-dir "~/docs/ascii/misc/fortunes/" | |
74 "*The directory to look in for local fortune cookies files." | |
38524 | 75 :type 'directory |
76 :group 'fortune) | |
77 (defcustom fortune-file | |
78 (expand-file-name "usenet" fortune-dir) | |
25480 | 79 "*The file in which local fortune cookies will be stored." |
38524 | 80 :type 'file |
81 :group 'fortune) | |
25480 | 82 (defcustom fortune-database-extension ".dat" |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
83 "The extension of the corresponding fortune database. |
25480 | 84 Normally you won't have a reason to change it." |
38524 | 85 :type 'string |
86 :group 'fortune) | |
25480 | 87 (defcustom fortune-program "fortune" |
88 "Program to select a fortune cookie." | |
38524 | 89 :type 'string |
90 :group 'fortune) | |
25480 | 91 (defcustom fortune-program-options "" |
38524 | 92 "Options to pass to the fortune program (a string)." |
93 :type 'string | |
94 :group 'fortune) | |
25480 | 95 (defcustom fortune-strfile "strfile" |
96 "Program to compute a new fortune database." | |
38524 | 97 :type 'string |
98 :group 'fortune) | |
25480 | 99 (defcustom fortune-strfile-options "" |
38524 | 100 "Options to pass to the strfile program (a string)." |
101 :type 'string | |
102 :group 'fortune) | |
25480 | 103 (defcustom fortune-quiet-strfile-options "> /dev/null" |
104 "Text added to the command for running `strfile'. | |
105 By default it discards the output produced by `strfile'. | |
106 Set this to \"\" if you would like to see the output." | |
38524 | 107 :type 'string |
108 :group 'fortune) | |
25480 | 109 |
110 (defcustom fortune-always-compile t | |
111 "*Non-nil means automatically compile fortune files. | |
112 If nil, you must invoke `fortune-compile' manually to do that." | |
38524 | 113 :type 'boolean |
114 :group 'fortune) | |
25480 | 115 (defcustom fortune-author-line-prefix " -- " |
116 "Prefix to put before the author name of a fortunate." | |
38524 | 117 :type 'string |
118 :group 'fortune-signature) | |
25480 | 119 (defcustom fortune-fill-column fill-column |
120 "Fill column for fortune files." | |
38524 | 121 :type 'integer |
122 :group 'fortune-signature) | |
25480 | 123 (defcustom fortune-from-mail "private e-mail" |
124 "String to use to characterize that the fortune comes from an e-mail. | |
125 No need to add an `in'." | |
126 :type 'string | |
127 :group 'fortune-signature) | |
128 (defcustom fortune-sigstart "" | |
129 "*Some text to insert before the fortune cookie, in a mail signature." | |
38524 | 130 :type 'string |
131 :group 'fortune-signature) | |
25480 | 132 (defcustom fortune-sigend "" |
133 "*Some text to insert after the fortune cookie, in a mail signature." | |
38524 | 134 :type 'string |
135 :group 'fortune-signature) | |
25480 | 136 |
137 | |
138 ;; not customizable settings | |
139 (defvar fortune-buffer-name "*fortune*") | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
140 (defconst fortune-end-sep "\n%\n") |
25480 | 141 |
142 | |
143 ;;; ************** | |
144 ;;; Inserting a new fortune | |
145 (defun fortune-append (string &optional interactive file) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
146 "Appends STRING to the fortune FILE. |
25480 | 147 |
148 If INTERACTIVE is non-nil, don't compile the fortune file afterwards." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
149 (setq file (expand-file-name |
25480 | 150 (substitute-in-file-name (or file fortune-file)))) |
151 (if (file-directory-p file) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
152 (error "Cannot append fortune to directory %s" file)) |
25480 | 153 (if interactive ; switch to file and return buffer |
154 (find-file-other-frame file) | |
155 (find-file-noselect file)) | |
156 (let ((fortune-buffer (get-file-buffer file))) | |
157 | |
158 (set-buffer fortune-buffer) | |
159 (goto-char (point-max)) | |
160 (setq fill-column fortune-fill-column) | |
161 (setq auto-fill-inhibit-regexp "^%") | |
162 (turn-on-auto-fill) | |
163 (insert string fortune-end-sep) | |
164 (unless interactive | |
165 (save-buffer) | |
166 (if fortune-always-compile | |
167 (fortune-compile file))))) | |
168 | |
169 (defun fortune-ask-file () | |
170 "Asks the user for a file-name." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
171 (expand-file-name |
25480 | 172 (read-file-name |
173 "Fortune file to use: " | |
174 fortune-dir nil nil ""))) | |
175 | |
37426 | 176 ;;;###autoload |
25480 | 177 (defun fortune-add-fortune (string file) |
178 "Add STRING to a fortune file FILE. | |
179 | |
180 Interactively, if called with a prefix argument, | |
181 read the file name to use. Otherwise use the value of `fortune-file'." | |
182 (interactive | |
183 (list (read-string "Fortune: ") | |
184 (if current-prefix-arg (fortune-ask-file)))) | |
185 (fortune-append string t file)) | |
186 | |
37426 | 187 ;;;###autoload |
25480 | 188 (defun fortune-from-region (beg end file) |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
189 "Append the current region to a local fortune-like data file. |
25480 | 190 |
191 Interactively, if called with a prefix argument, | |
192 read the file name to use. Otherwise use the value of `fortune-file'." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
193 (interactive |
25480 | 194 (list (region-beginning) (region-end) |
195 (if current-prefix-arg (fortune-ask-file)))) | |
196 (let ((string (buffer-substring beg end)) | |
197 author newsgroup help-point) | |
198 ;; try to determine author ... | |
199 (save-excursion | |
200 (goto-char (point-min)) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
201 (setq help-point |
25480 | 202 (search-forward-regexp |
203 "^From: \\(.*\\)$" | |
204 (point-max) t)) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
205 (if help-point |
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
206 (setq author (buffer-substring (match-beginning 1) help-point)) |
25480 | 207 (setq author "An unknown author"))) |
208 ;; ... and newsgroup | |
209 (save-excursion | |
210 (goto-char (point-min)) | |
211 (setq help-point | |
212 (search-forward-regexp | |
213 "^Newsgroups: \\(.*\\)$" | |
214 (point-max) t)) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
215 (if help-point |
25480 | 216 (setq newsgroup (buffer-substring (match-beginning 1) help-point)) |
37428
6586c75e5eda
(fortune-from-region): Use `eq' instead of `eql'.
Gerd Moellmann <gerd@gnu.org>
parents:
37426
diff
changeset
|
217 (setq newsgroup (if (or (eq major-mode 'gnus-article-mode) |
6586c75e5eda
(fortune-from-region): Use `eq' instead of `eql'.
Gerd Moellmann <gerd@gnu.org>
parents:
37426
diff
changeset
|
218 (eq major-mode 'vm-mode) |
6586c75e5eda
(fortune-from-region): Use `eq' instead of `eql'.
Gerd Moellmann <gerd@gnu.org>
parents:
37426
diff
changeset
|
219 (eq major-mode 'rmail-mode)) |
25480 | 220 fortune-from-mail |
221 "unknown")))) | |
222 | |
223 ;; append entry to end of fortune file, and display result | |
224 (setq string (concat "\"" string "\"" | |
225 "\n" | |
226 fortune-author-line-prefix | |
227 author " in " newsgroup)) | |
228 (fortune-append string t file))) | |
229 | |
230 | |
231 ;;; ************** | |
232 ;;; Compile new database with strfile | |
37426 | 233 ;;;###autoload |
25480 | 234 (defun fortune-compile (&optional file) |
235 "Compile fortune file. | |
236 | |
237 If called with a prefix asks for the FILE to compile, otherwise uses | |
238 the value of `fortune-file'. This currently cannot handle directories." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
239 (interactive |
25480 | 240 (list |
241 (if current-prefix-arg | |
242 (fortune-ask-file) | |
243 fortune-file))) | |
244 (let* ((fortune-file (expand-file-name (substitute-in-file-name file))) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
245 (fortune-dat (expand-file-name |
25480 | 246 (substitute-in-file-name |
247 (concat fortune-file fortune-database-extension))))) | |
248 (cond ((file-exists-p fortune-file) | |
249 (if (file-exists-p fortune-dat) | |
250 (cond ((file-newer-than-file-p fortune-file fortune-dat) | |
251 (message "Compiling new fortune database %s" fortune-dat) | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
252 (shell-command |
25480 | 253 (concat fortune-strfile fortune-strfile-options |
254 " " fortune-file fortune-quiet-strfile-options)))))) | |
255 (t (error "Can't compile fortune file %s" fortune-file))))) | |
256 | |
257 | |
258 ;;; ************** | |
259 ;;; Use fortune for signature | |
37426 | 260 ;;;###autoload |
25480 | 261 (defun fortune-to-signature (&optional file) |
262 "Create signature from output of the fortune program. | |
263 | |
264 If called with a prefix asks for the FILE to choose the fortune from, | |
265 otherwise uses the value of `fortune-file'. If you want to have fortune | |
266 choose from a set of files in a directory, call interactively with prefix | |
267 and choose the directory as the fortune-file." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
268 (interactive |
25480 | 269 (list |
270 (if current-prefix-arg | |
271 (fortune-ask-file) | |
272 fortune-file))) | |
273 (save-excursion | |
274 (fortune-in-buffer (interactive-p) file) | |
275 (set-buffer fortune-buffer-name) | |
276 (let* ((fortune (buffer-string)) | |
277 (signature (concat fortune-sigstart fortune fortune-sigend))) | |
278 (setq mail-signature signature) | |
279 (if (boundp 'message-signature) | |
280 (setq message-signature signature))))) | |
281 | |
282 | |
283 ;;; ************** | |
284 ;;; Display fortune | |
285 (defun fortune-in-buffer (interactive &optional file) | |
286 "Put a fortune cookie in the *fortune* buffer. | |
287 | |
288 When INTERACTIVE is nil, don't display it. Optional argument FILE, | |
289 when supplied, specifies the file to choose the fortune from." | |
290 (let ((fortune-buffer (or (get-buffer fortune-buffer-name) | |
291 (generate-new-buffer fortune-buffer-name))) | |
292 (fort-file (expand-file-name | |
293 (substitute-in-file-name | |
294 (or file fortune-file))))) | |
295 (save-excursion | |
296 (set-buffer fortune-buffer) | |
297 (toggle-read-only 0) | |
298 (erase-buffer) | |
299 | |
300 (if fortune-always-compile | |
301 (fortune-compile fort-file)) | |
302 | |
303 (call-process | |
304 fortune-program ;; programm to call | |
305 nil fortune-buffer nil ;; INFILE BUFFER DISPLAYP | |
306 (concat fortune-program-options fort-file))))) | |
307 | |
308 | |
37426 | 309 ;;;###autoload |
25480 | 310 (defun fortune (&optional file) |
311 "Display a fortune cookie. | |
312 | |
313 If called with a prefix asks for the FILE to choose the fortune from, | |
314 otherwise uses the value of `fortune-file'. If you want to have fortune | |
315 choose from a set of files in a directory, call interactively with prefix | |
316 and choose the directory as the fortune-file." | |
30860
d0e5a99cbda1
(fortune) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
25480
diff
changeset
|
317 (interactive |
25480 | 318 (list |
319 (if current-prefix-arg | |
320 (fortune-ask-file) | |
321 fortune-file))) | |
322 (fortune-in-buffer t file) | |
323 (switch-to-buffer (get-buffer fortune-buffer-name)) | |
324 (toggle-read-only 1)) | |
325 | |
326 | |
327 ;;; Provide ourselves. | |
328 (provide 'fortune) | |
329 | |
330 ;;; fortune.el ends here |