Commit | Line | Data |
---|---|---|
8eb74eec | 1 | ;;; cookie1.el --- retrieve random phrases from fortune cookie files |
d5edbd11 ER |
2 | |
3 | ;; Copyright (C) 1993 Free Software Foundation, Inc. | |
4 | ||
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 | ;; Maintainer: FSF | |
7 | ;; Keywords: games | |
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 | |
b578f267 EN |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
d5edbd11 ER |
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 | |
c5eeaf52 | 34 | ;; function `shuffle-vector' may be of interest to programmers. |
d5edbd11 | 35 | ;; |
45b44a5a ER |
36 | ;; The code expects phrase files to be in one of two formats: |
37 | ;; | |
38 | ;; * ITS-style LINS format (strings terminated by ASCII 0 characters, | |
39 | ;; leading whitespace ignored). | |
40 | ;; | |
41 | ;; * UNIX fortune file format (quotes terminated by %% on a line by itself). | |
42 | ;; | |
43 | ;; Everything up to the first delimiter is treated as a comment. Other | |
44 | ;; formats could be supported by adding alternates to the regexp | |
45 | ;; `cookie-delimiter'. | |
d5edbd11 ER |
46 | ;; |
47 | ;; This code derives from Steve Strassman's 1987 spook.el package, but | |
45b44a5a ER |
48 | ;; has been generalized so that it supports multiple simultaneous |
49 | ;; cookie databases and fortune files. It is intended to be called | |
50 | ;; from other packages such as yow.el and spook.el. | |
cf597dc8 ER |
51 | ;; |
52 | ;; TO DO: teach cookie-snarf to auto-detect ITS PINS or UNIX fortune(6) | |
53 | ;; format and do the right thing. | |
d5edbd11 ER |
54 | |
55 | ;;; Code: | |
56 | ||
57 | ; Randomize the seed in the random number generator. | |
58 | (random t) | |
59 | ||
45b44a5a | 60 | (defconst cookie-delimiter "\n%%\n\\|\0" |
d5edbd11 ER |
61 | "Delimiter used to separate cookie file entries.") |
62 | ||
4054367c RM |
63 | (defvar cookie-cache (make-vector 511 0) |
64 | "Cache of cookie files that have already been snarfed.") | |
65 | ||
f58c6f70 | 66 | ;;;###autoload |
d5edbd11 ER |
67 | (defun cookie (phrase-file startmsg endmsg) |
68 | "Return a random phrase from PHRASE-FILE. When the phrase file | |
69 | is read in, display STARTMSG at beginning of load, ENDMSG at end." | |
70 | (let ((cookie-vector (cookie-snarf phrase-file startmsg endmsg))) | |
71 | (shuffle-vector cookie-vector) | |
72 | (aref cookie-vector 1))) | |
73 | ||
f58c6f70 | 74 | ;;;###autoload |
d5edbd11 ER |
75 | (defun cookie-insert (phrase-file &optional count startmsg endmsg) |
76 | "Insert random phrases from PHRASE-FILE; COUNT of them. When the phrase file | |
77 | is read in, display STARTMSG at beginning of load, ENDMSG at end." | |
78 | (let ((cookie-vector (cookie-snarf phrase-file startmsg endmsg))) | |
79 | (shuffle-vector cookie-vector) | |
80 | (let ((start (point))) | |
81 | (insert ?\n) | |
82 | (cookie1 (min (- (length cookie-vector) 1) (or count 1)) cookie-vector) | |
83 | (insert ?\n) | |
84 | (fill-region-as-paragraph start (point) nil)))) | |
85 | ||
86 | (defun cookie1 (arg cookie-vec) | |
87 | "Inserts a cookie phrase ARG times." | |
88 | (cond ((zerop arg) t) | |
89 | (t (insert (aref cookie-vec arg)) | |
90 | (insert " ") | |
91 | (cookie1 (1- arg) cookie-vec)))) | |
92 | ||
f58c6f70 | 93 | ;;;###autoload |
d5edbd11 | 94 | (defun cookie-snarf (phrase-file startmsg endmsg) |
b81d991d RM |
95 | "Reads in the PHRASE-FILE, returns it as a vector of strings. |
96 | Emit STARTMSG and ENDMSG before and after. Caches the result; second | |
97 | and subsequent calls on the same file won't go to disk." | |
4054367c RM |
98 | (let ((sym (intern-soft phrase-file cookie-cache))) |
99 | (and sym (not (equal (symbol-function sym) | |
100 | (nth 5 (file-attributes phrase-file)))) | |
101 | (yes-or-no-p (concat phrase-file | |
102 | " has changed. Read new contents? ")) | |
103 | (setq sym nil)) | |
104 | (if sym | |
105 | (symbol-value sym) | |
106 | (setq sym (intern phrase-file cookie-cache)) | |
4120f5f5 | 107 | (message "%s" startmsg) |
4054367c RM |
108 | (save-excursion |
109 | (let ((buf (generate-new-buffer "*cookie*")) | |
110 | (result nil)) | |
111 | (set-buffer buf) | |
112 | (fset sym (nth 5 (file-attributes phrase-file))) | |
113 | (insert-file-contents (expand-file-name phrase-file)) | |
114 | (re-search-forward cookie-delimiter) | |
115 | (while (progn (skip-chars-forward " \t\n\r\f") (not (eobp))) | |
116 | (let ((beg (point))) | |
117 | (re-search-forward cookie-delimiter) | |
118 | (setq result (cons (buffer-substring beg (1- (point))) | |
119 | result)))) | |
120 | (kill-buffer buf) | |
4120f5f5 | 121 | (message "%s" endmsg) |
4054367c | 122 | (set sym (apply 'vector result))))))) |
d5edbd11 | 123 | |
b81d991d RM |
124 | (defun read-cookie (prompt phrase-file startmsg endmsg &optional require-match) |
125 | "Prompt with PROMPT and read with completion among cookies in PHRASE-FILE. | |
126 | STARTMSG and ENDMSG are passed along to `cookie-snarf'. | |
127 | Optional fifth arg REQUIRE-MATCH non-nil forces a matching cookie." | |
128 | ;; Make sure the cookies are in the cache. | |
129 | (or (intern-soft phrase-file cookie-cache) | |
130 | (cookie-snarf phrase-file startmsg endmsg)) | |
131 | (completing-read prompt | |
132 | (let ((sym (intern phrase-file cookie-cache))) | |
133 | ;; We cache the alist form of the cookie in a property. | |
134 | (or (get sym 'completion-alist) | |
135 | (let* ((alist nil) | |
136 | (vec (cookie-snarf phrase-file | |
137 | startmsg endmsg)) | |
138 | (i (length vec))) | |
139 | (while (> (setq i (1- i)) 0) | |
140 | (setq alist (cons (list (aref vec i)) alist))) | |
141 | (put sym 'completion-alist alist)))) | |
142 | nil require-match nil nil)) | |
143 | ||
d5edbd11 ER |
144 | ; Thanks to Ian G Batten <BattenIG@CS.BHAM.AC.UK> |
145 | ; [of the University of Birmingham Computer Science Department] | |
146 | ; for the iterative version of this shuffle. | |
147 | ; | |
f58c6f70 | 148 | ;;;###autoload |
d5edbd11 ER |
149 | (defun shuffle-vector (vector) |
150 | "Randomly permute the elements of VECTOR (all permutations equally likely)" | |
151 | (let ((i 0) | |
152 | j | |
153 | temp | |
154 | (len (length vector))) | |
155 | (while (< i len) | |
c5eeaf52 | 156 | (setq j (+ i (random (- len i)))) |
d5edbd11 ER |
157 | (setq temp (aref vector i)) |
158 | (aset vector i (aref vector j)) | |
159 | (aset vector j temp) | |
160 | (setq i (1+ i)))) | |
161 | vector) | |
162 | ||
3aa7cce7 | 163 | (provide 'cookie1) |
d5edbd11 | 164 | |
20a82895 | 165 | ;;; cookie1.el ends here |