Mercurial > emacs
annotate lisp/play/cookie1.el @ 67955:6f397fdf1671
*** empty log message ***
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 31 Dec 2005 11:47:05 +0000 |
parents | 34bd8e434dd7 |
children | 836785857446 edf295560b5a |
rev | line source |
---|---|
3383 | 1 ;;; cookie1.el --- retrieve random phrases from fortune cookie files |
2321 | 2 |
64701
34bd8e434dd7
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
3 ;; Copyright (C) 1993, 2002, 2003, 2004, 2005 Free Software Foundation, Inc. |
2321 | 4 |
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 ;; Maintainer: FSF | |
30858
b9f0d1526fea
Add `extensions' to keywords, since it's internal.
Dave Love <fx@gnu.org>
parents:
30514
diff
changeset
|
7 ;; Keywords: games, extensions |
2321 | 8 ;; Created: Mon Mar 22 17:06:26 1993 |
9 | |
10 ;; This file is part of GNU Emacs. | |
11 | |
12 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 ;; it under the terms of the GNU General Public License as published by | |
14 ;; the Free Software Foundation; either version 2, or (at your option) | |
15 ;; any later version. | |
16 | |
17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 ;; GNU General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
14169 | 23 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
64085 | 24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 ;; Boston, MA 02110-1301, USA. | |
2321 | 26 |
27 ;;; Commentary: | |
28 | |
29 ;; Support for random cookie fetches from phrase files, used for such | |
30 ;; critical applications as emulating Zippy the Pinhead and confounding | |
31 ;; the NSA Trunk Trawler. | |
32 ;; | |
33 ;; The two entry points are `cookie' and `cookie-insert'. The helper | |
4405 | 34 ;; function `shuffle-vector' may be of interest to programmers. |
2321 | 35 ;; |
2381
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
36 ;; The code expects phrase files to be in one of two formats: |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
37 ;; |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
38 ;; * ITS-style LINS format (strings terminated by ASCII 0 characters, |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
39 ;; leading whitespace ignored). |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
40 ;; |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
41 ;; * UNIX fortune file format (quotes terminated by %% on a line by itself). |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
42 ;; |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
43 ;; Everything up to the first delimiter is treated as a comment. Other |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
44 ;; formats could be supported by adding alternates to the regexp |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
45 ;; `cookie-delimiter'. |
2321 | 46 ;; |
30514
42bf9adb59a3
Add explanation of how to make cookie.el
Gerd Moellmann <gerd@gnu.org>
parents:
20887
diff
changeset
|
47 ;; strfile(1) is the program used to compile the files for fortune(6). |
42bf9adb59a3
Add explanation of how to make cookie.el
Gerd Moellmann <gerd@gnu.org>
parents:
20887
diff
changeset
|
48 ;; In order to achieve total compatibility with strfile(1), cookie files |
42bf9adb59a3
Add explanation of how to make cookie.el
Gerd Moellmann <gerd@gnu.org>
parents:
20887
diff
changeset
|
49 ;; should start with two consecutive delimiters (and no comment). |
42bf9adb59a3
Add explanation of how to make cookie.el
Gerd Moellmann <gerd@gnu.org>
parents:
20887
diff
changeset
|
50 ;; |
2321 | 51 ;; This code derives from Steve Strassman's 1987 spook.el package, but |
2381
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
52 ;; has been generalized so that it supports multiple simultaneous |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
53 ;; cookie databases and fortune files. It is intended to be called |
f8ae5fc2c196
(cookie) Enhanced it to handle both LINS files and UNIX fortune files.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2322
diff
changeset
|
54 ;; from other packages such as yow.el and spook.el. |
2322 | 55 ;; |
56 ;; TO DO: teach cookie-snarf to auto-detect ITS PINS or UNIX fortune(6) | |
57 ;; format and do the right thing. | |
2321 | 58 |
59 ;;; Code: | |
60 | |
61 ; Randomize the seed in the random number generator. | |
62 (random t) | |
63 | |
20887
bb0f5fde5973
(cookie-snarf): Use match-beginning on the delimiter.
Richard M. Stallman <rms@gnu.org>
parents:
14307
diff
changeset
|
64 (defconst cookie-delimiter "\n%%\n\\|\n%\n\\|\0" |
2321 | 65 "Delimiter used to separate cookie file entries.") |
66 | |
4090
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
67 (defvar cookie-cache (make-vector 511 0) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
68 "Cache of cookie files that have already been snarfed.") |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
69 |
4151
e6d5beaca907
(cookie, cookie-insert, cookie-snarf, shuffle-vector): Autoload these.
Roland McGrath <roland@gnu.org>
parents:
4090
diff
changeset
|
70 ;;;###autoload |
2321 | 71 (defun cookie (phrase-file startmsg endmsg) |
41666
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
72 "Return a random phrase from PHRASE-FILE. |
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
73 When the phrase file is read in, display STARTMSG at the beginning |
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
74 of load, ENDMSG at the end." |
2321 | 75 (let ((cookie-vector (cookie-snarf phrase-file startmsg endmsg))) |
76 (shuffle-vector cookie-vector) | |
77 (aref cookie-vector 1))) | |
78 | |
4151
e6d5beaca907
(cookie, cookie-insert, cookie-snarf, shuffle-vector): Autoload these.
Roland McGrath <roland@gnu.org>
parents:
4090
diff
changeset
|
79 ;;;###autoload |
2321 | 80 (defun cookie-insert (phrase-file &optional count startmsg endmsg) |
41666
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
81 "Insert random phrases from PHRASE-FILE; COUNT of them. |
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
82 When the phrase file is read in, display STARTMSG at the beginning |
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
83 of load, ENDMSG at the end." |
2321 | 84 (let ((cookie-vector (cookie-snarf phrase-file startmsg endmsg))) |
85 (shuffle-vector cookie-vector) | |
86 (let ((start (point))) | |
87 (insert ?\n) | |
88 (cookie1 (min (- (length cookie-vector) 1) (or count 1)) cookie-vector) | |
89 (insert ?\n) | |
90 (fill-region-as-paragraph start (point) nil)))) | |
91 | |
92 (defun cookie1 (arg cookie-vec) | |
93 "Inserts a cookie phrase ARG times." | |
94 (cond ((zerop arg) t) | |
95 (t (insert (aref cookie-vec arg)) | |
96 (insert " ") | |
97 (cookie1 (1- arg) cookie-vec)))) | |
98 | |
4151
e6d5beaca907
(cookie, cookie-insert, cookie-snarf, shuffle-vector): Autoload these.
Roland McGrath <roland@gnu.org>
parents:
4090
diff
changeset
|
99 ;;;###autoload |
2321 | 100 (defun cookie-snarf (phrase-file startmsg endmsg) |
4736
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
101 "Reads in the PHRASE-FILE, returns it as a vector of strings. |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
102 Emit STARTMSG and ENDMSG before and after. Caches the result; second |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
103 and subsequent calls on the same file won't go to disk." |
4090
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
104 (let ((sym (intern-soft phrase-file cookie-cache))) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
105 (and sym (not (equal (symbol-function sym) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
106 (nth 5 (file-attributes phrase-file)))) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
107 (yes-or-no-p (concat phrase-file |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
108 " has changed. Read new contents? ")) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
109 (setq sym nil)) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
110 (if sym |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
111 (symbol-value sym) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
112 (setq sym (intern phrase-file cookie-cache)) |
14307
8f846c3889c8
(cookie-snarf): Pass proper format string to message.
Karl Heuer <kwzh@gnu.org>
parents:
14169
diff
changeset
|
113 (message "%s" startmsg) |
4090
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
114 (save-excursion |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
115 (let ((buf (generate-new-buffer "*cookie*")) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
116 (result nil)) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
117 (set-buffer buf) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
118 (fset sym (nth 5 (file-attributes phrase-file))) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
119 (insert-file-contents (expand-file-name phrase-file)) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
120 (re-search-forward cookie-delimiter) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
121 (while (progn (skip-chars-forward " \t\n\r\f") (not (eobp))) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
122 (let ((beg (point))) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
123 (re-search-forward cookie-delimiter) |
20887
bb0f5fde5973
(cookie-snarf): Use match-beginning on the delimiter.
Richard M. Stallman <rms@gnu.org>
parents:
14307
diff
changeset
|
124 (setq result (cons (buffer-substring beg (match-beginning 0)) |
4090
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
125 result)))) |
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
126 (kill-buffer buf) |
14307
8f846c3889c8
(cookie-snarf): Pass proper format string to message.
Karl Heuer <kwzh@gnu.org>
parents:
14169
diff
changeset
|
127 (message "%s" endmsg) |
4090
afa2afad53c4
(cookie-cache): New defvar.
Roland McGrath <roland@gnu.org>
parents:
3432
diff
changeset
|
128 (set sym (apply 'vector result))))))) |
2321 | 129 |
4736
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
130 (defun read-cookie (prompt phrase-file startmsg endmsg &optional require-match) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
131 "Prompt with PROMPT and read with completion among cookies in PHRASE-FILE. |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
132 STARTMSG and ENDMSG are passed along to `cookie-snarf'. |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
133 Optional fifth arg REQUIRE-MATCH non-nil forces a matching cookie." |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
134 ;; Make sure the cookies are in the cache. |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
135 (or (intern-soft phrase-file cookie-cache) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
136 (cookie-snarf phrase-file startmsg endmsg)) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
137 (completing-read prompt |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
138 (let ((sym (intern phrase-file cookie-cache))) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
139 ;; We cache the alist form of the cookie in a property. |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
140 (or (get sym 'completion-alist) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
141 (let* ((alist nil) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
142 (vec (cookie-snarf phrase-file |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
143 startmsg endmsg)) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
144 (i (length vec))) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
145 (while (> (setq i (1- i)) 0) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
146 (setq alist (cons (list (aref vec i)) alist))) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
147 (put sym 'completion-alist alist)))) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
148 nil require-match nil nil)) |
6aeb2227ed30
(read-cookie): New function.
Roland McGrath <roland@gnu.org>
parents:
4405
diff
changeset
|
149 |
2321 | 150 ; Thanks to Ian G Batten <BattenIG@CS.BHAM.AC.UK> |
151 ; [of the University of Birmingham Computer Science Department] | |
152 ; for the iterative version of this shuffle. | |
153 ; | |
4151
e6d5beaca907
(cookie, cookie-insert, cookie-snarf, shuffle-vector): Autoload these.
Roland McGrath <roland@gnu.org>
parents:
4090
diff
changeset
|
154 ;;;###autoload |
2321 | 155 (defun shuffle-vector (vector) |
41666
5cd64b3e28c3
(cookie, cookie-insert, shuffle-vector): Doc fixes.
Pavel Janík <Pavel@Janik.cz>
parents:
30858
diff
changeset
|
156 "Randomly permute the elements of VECTOR (all permutations equally likely)." |
2321 | 157 (let ((i 0) |
158 j | |
159 temp | |
160 (len (length vector))) | |
161 (while (< i len) | |
4405 | 162 (setq j (+ i (random (- len i)))) |
2321 | 163 (setq temp (aref vector i)) |
164 (aset vector i (aref vector j)) | |
165 (aset vector j temp) | |
166 (setq i (1+ i)))) | |
167 vector) | |
168 | |
3388 | 169 (provide 'cookie1) |
2321 | 170 |
52401 | 171 ;;; arch-tag: 4a8a8712-df6a-4f34-b030-108a1b47f9f2 |
3432 | 172 ;;; cookie1.el ends here |