1 ;;; mpuz.el --- multiplication puzzle for GNU Emacs
3 ;; Copyright (C) 1990, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Philippe Schnoebelen <phs@lsv.ens-cachan.fr>
6 ;; Overhauled: Daniel Pfeiffer <occitan@esperanto.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; `M-x mpuz' generates a random multiplication puzzle. This is a
27 ;; multiplication example in which each digit has been consistently replaced
28 ;; with some letter. Your job is to reconstruct the original digits. Type
29 ;; `?' while the mode is active for detailed help.
34 "Multiplication puzzle."
38 (defcustom mpuz-silent
'error
39 "Set this to nil if you want dings on inputs.
40 The value t means never ding, and `error' means only ding on wrong input."
41 :type
'(choice (const :tag
"No" nil
)
43 (const :tag
"If correct" error
))
46 (defcustom mpuz-solve-when-trivial t
47 "Solve any row that can be trivially calculated from what you've found."
51 (defcustom mpuz-allow-double-multiplicator nil
52 "Allow 2nd factors like 33 or 77."
56 (defface mpuz-unsolved
57 '((default :weight bold
)
58 (((class color
)) :foreground
"red1"))
59 "Face for letters to be solved."
63 '((default :weight bold
)
64 (((class color
)) :foreground
"green1"))
65 "Face for solved digits."
69 '((default :weight bold
)
70 (((class color
)) :foreground
"blue"))
71 "Face for trivial digits solved for you."
75 '((t :inherit variable-pitch
))
76 "Face for text on right."
80 ;; Mpuz mode and keymaps
81 ;;----------------------
82 (defcustom mpuz-mode-hook nil
83 "Hook to run upon entry to mpuz."
88 (let ((map (make-sparse-keymap)))
90 (define-key map
(char-to-string ch
) 'mpuz-try-letter
))
91 "abcdefghijABCDEFGHIJ")
92 (define-key map
"\C-g" 'mpuz-offer-abort
)
93 (define-key map
"?" 'describe-mode
)
95 "Local keymap to use in Mult Puzzle.")
98 "Multiplication puzzle mode.
100 You have to guess which letters stand for which digits in the
101 multiplication displayed inside the `*Mult Puzzle*' buffer.
103 You may enter a guess for a letter's value by typing first the letter,
104 then the digit. Thus, to guess that A=3, type `A 3'.
106 To leave the game to do other editing work, just switch buffers.
107 Then you may resume the game with M-x mpuz.
108 You may abort a game by typing \\<mpuz-mode-map>\\[mpuz-offer-abort]."
110 (kill-all-local-variables)
111 (setq major-mode
'mpuz-mode
112 mode-name
"Mult Puzzle"
114 (use-local-map mpuz-mode-map
)
115 (run-mode-hooks 'mpuz-mode-hook
))
118 ;; Some variables for statistics
119 ;;------------------------------
120 (defvar mpuz-nb-errors
0
121 "Number of errors made in current game.")
123 (defvar mpuz-nb-completed-games
0
124 "Number of games completed.")
126 (defvar mpuz-nb-cumulated-errors
0
127 "Number of errors made in previous games.")
130 ;; Some variables for game tracking
131 ;;---------------------------------
132 (defvar mpuz-in-progress nil
133 "True if a game is currently in progress.")
135 (defvar mpuz-found-digits
(make-bool-vector 10 nil
)
136 "A vector recording which digits have been decrypted.")
138 (defvar mpuz-trivial-digits
(make-bool-vector 10 nil
)
139 "A vector recording which digits have been solved for you.")
141 (defmacro mpuz-digit-solved-p
(digit)
142 `(or (aref mpuz-found-digits
,digit
)
143 (aref mpuz-trivial-digits
,digit
)))
146 ;; A puzzle uses a permutation of [0..9] into itself.
147 ;; We use both the permutation and its inverse.
148 ;;---------------------------------------------------
149 (defvar mpuz-digit-to-letter
(make-vector 10 0)
150 "A permutation from [0..9] to [0..9].")
152 (defvar mpuz-letter-to-digit
(make-vector 10 0)
153 "The inverse of `mpuz-digit-to-letter'.")
155 (defmacro mpuz-to-digit
(letter)
156 (list 'aref
'mpuz-letter-to-digit letter
))
158 (defmacro mpuz-to-letter
(digit)
159 (list 'aref
'mpuz-digit-to-letter digit
))
161 (defun mpuz-build-random-perm ()
162 "Initialize puzzle coding with a random permutation."
163 (let ((letters (list 0 1 2 3 4 5 6 7 8 9)) ; new cons cells, because of delq
167 (setq elem
(nth (random index
) letters
)
168 letters
(delq elem letters
)
170 (aset mpuz-digit-to-letter index elem
)
171 (aset mpuz-letter-to-digit elem index
))))
174 ;; A puzzle also uses a board displaying a multiplication.
175 ;; Every digit appears in the board, crypted or not.
176 ;;------------------------------------------------------
177 (defvar mpuz-board
(make-vector 10 nil
)
178 "The board associates to any digit the list of squares where it appears.")
180 (defun mpuz-put-number-on-board (number row
&rest columns
)
181 "Put (last digit of) NUMBER on ROW and COLUMNS of the puzzle board."
183 (dolist (column columns
)
184 (setq digit
(% number
10)
185 number
(/ number
10))
186 (aset mpuz-board digit
`((,row .
,column
) ,@(aref mpuz-board digit
))))))
188 (defun mpuz-check-all-solved (&optional row col
)
189 "Check whether all digits have been solved. Return t if yes."
191 (let (A B1 B2 C D E squares
)
192 (and mpuz-solve-when-trivial
195 (cond ((or (and (setq B1
(or B1
(mpuz-check-all-solved 4 7))
196 B2
(or B2
(mpuz-check-all-solved 4 9))
197 E
(or E
(mpuz-check-all-solved 10))
198 A
(or A
(mpuz-check-all-solved 2)))
200 (and E
(or A
(and B1 B2
))))
204 ((and (setq D
(or D
(mpuz-check-all-solved 8))
205 C
(or C
(mpuz-check-all-solved 6)))
208 ((and E
(not (eq C D
)))
209 (mpuz-solve (if D
6 8)))
210 ((and A
(not (eq B2 C
)))
211 (mpuz-solve (if C
4 6) (if C
9)))
212 ((and A
(not (eq B1 D
)))
213 (mpuz-solve (if D
4 8) (if D
7)))
214 ((and (not A
) (or (and B2 C
) (and B1 D
)))
217 (mapc (lambda (digit)
218 (and (not (mpuz-digit-solved-p digit
)) ; unsolved
219 (setq squares
(aref mpuz-board digit
))
222 (member (cons row col
) squares
)
224 squares
) ; and appearing in the puzzle!
225 (throw 'solved nil
)))
226 [0 1 2 3 4 5 6 7 8 9]))
230 ;; To build a puzzle, we take two random numbers and multiply them.
231 ;; We also take a random permutation for encryption.
232 ;; The random numbers are only use to see which digit appears in which square
233 ;; of the board. Everything is stored in individual squares.
234 ;;---------------------------------------------------------------------------
235 (defun mpuz-random-puzzle ()
236 "Draw random values to be multiplied in a puzzle."
237 (mpuz-build-random-perm)
238 (fillarray mpuz-board nil
) ; erase the board
239 ;; A,B,C,D & E, are the five rows of our multiplication.
240 ;; Choose random values, discarding cases with leading zeros in C or D.
241 (let* ((A (if mpuz-allow-double-multiplicator
(+ 112 (random 888))
242 (+ 125 (random 875))))
244 (B1 (+ min
(random (- 10 min
))))
246 (while (if (= B1
(setq B2
(+ min
(random (- 10 min
)))))
247 (not mpuz-allow-double-multiplicator
)))
251 ;; Individual digits are now put on their respective squares.
252 ;; [NB: A square is a pair (row . column) of the screen.]
253 (mpuz-put-number-on-board A
2 9 7 5)
254 (mpuz-put-number-on-board (+ (* B1
10) B2
) 4 9 7)
255 (mpuz-put-number-on-board C
6 9 7 5 3)
256 (mpuz-put-number-on-board D
8 7 5 3 1)
257 (mpuz-put-number-on-board E
10 9 7 5 3 1)))
261 (defconst mpuz-framework
264 Number of errors (this game): 0
268 Number of completed games: 0
270 --------- Average number of errors: 0.00
272 "The general picture of the puzzle screen, as a string.")
274 (defun mpuz-create-buffer ()
275 "Create (or recreate) the puzzle buffer. Return it."
276 (let ((buf (get-buffer-create "*Mult Puzzle*"))
277 (face '(face mpuz-text
))
279 (with-current-buffer buf
281 (insert mpuz-framework
)
282 (set-text-properties 13 42 face
)
283 (set-text-properties 79 105 face
)
284 (set-text-properties 128 153 face
)
287 (mpuz-paint-statistics))
290 (defun mpuz-paint-number (n &optional eol words
)
292 (let (buffer-read-only)
293 (delete-region (point)
294 (progn (backward-word (or words
1)) (point)))
297 (defun mpuz-paint-errors ()
298 "Paint error count on the puzzle screen."
299 (mpuz-switch-to-window)
300 (goto-char (point-min))
302 (mpuz-paint-number (prin1-to-string mpuz-nb-errors
)))
304 (defun mpuz-paint-statistics ()
305 "Paint statistics about previous games on the puzzle screen."
306 (goto-char (point-min))
308 (mpuz-paint-number (prin1-to-string mpuz-nb-completed-games
))
311 (if (zerop mpuz-nb-completed-games
)
313 (/ (+ 0.0 mpuz-nb-cumulated-errors
)
314 mpuz-nb-completed-games
)))
317 (defun mpuz-paint-board ()
318 "Paint board situation on the puzzle screen."
319 (mpuz-switch-to-window)
320 (mapc 'mpuz-paint-digit
[0 1 2 3 4 5 6 7 8 9])
321 (goto-char (point-min)))
323 (defun mpuz-paint-digit (digit)
324 "Paint all occurrences of DIGIT on the puzzle board."
325 (let ((char (if (mpuz-digit-solved-p digit
)
327 (+ (mpuz-to-letter digit
) ?A
)))
329 ,(cond ((aref mpuz-trivial-digits digit
) 'mpuz-trivial
)
330 ((aref mpuz-found-digits digit
) 'mpuz-solved
)
333 (mapc (lambda (square)
334 (goto-char (point-min))
335 (forward-line (1- (car square
))) ; line before column!
336 (move-to-column (cdr square
))
338 (set-text-properties (1- (point)) (point) face
)
340 (aref mpuz-board digit
))))
342 (defun mpuz-get-buffer ()
343 "Get the puzzle buffer if it exists."
344 (get-buffer "*Mult Puzzle*"))
346 (defun mpuz-switch-to-window ()
347 "Find or create the Mult-Puzzle buffer, and display it."
348 (let ((buf (mpuz-get-buffer)))
349 (or buf
(setq buf
(mpuz-create-buffer)))
350 (switch-to-buffer buf
)
351 (setq buffer-read-only t
)
357 (defun mpuz-start-new-game ()
358 "Start a new puzzle."
359 (message "Here we go...")
360 (setq mpuz-nb-errors
0
362 (fillarray mpuz-found-digits nil
) ; initialize mpuz-found-digits
363 (fillarray mpuz-trivial-digits nil
)
365 (mpuz-switch-to-window)
372 "Multiplication puzzle with GNU Emacs."
375 (mpuz-switch-to-window)
378 (mpuz-start-new-game)))
380 (defun mpuz-offer-abort ()
381 "Ask if user wants to abort current puzzle."
383 (if (y-or-n-p "Abort game? ")
384 (let ((buf (mpuz-get-buffer)))
385 (message "Mult Puzzle aborted.")
386 (setq mpuz-in-progress nil
388 (fillarray mpuz-board nil
)
389 (if buf
(kill-buffer buf
)))
392 (defun mpuz-ask-for-try ()
393 "Ask for user proposal in puzzle."
394 (message "Your try?"))
396 (defun mpuz-ding (error)
397 "Dings, unless global variable `mpuz-silent' forbids it."
398 (cond ((eq mpuz-silent t
))
399 ((not mpuz-silent
) (ding t
))
402 (defun mpuz-try-letter ()
403 "Propose a digit for a letter in puzzle."
406 (let (letter-char digit digit-char
)
407 (setq letter-char
(upcase last-command-event
)
408 digit
(mpuz-to-digit (- letter-char ?A
)))
409 (cond ((mpuz-digit-solved-p digit
)
410 (message "%c already solved." letter-char
)
412 ((null (aref mpuz-board digit
))
413 (message "%c does not appear." letter-char
)
415 ((progn (message "%c = " letter-char
)
416 ;; <char> has been entered.
417 ;; Print "<char> =" and
418 ;; read <num> or = <num>
419 (setq digit-char
(read-char))
420 (if (eq digit-char ?
=)
421 (setq digit-char
(read-char)))
422 (or (> digit-char ?
9) (< digit-char ?
0))) ; bad input
423 (message "%c = %c" letter-char digit-char
)
426 (mpuz-try-proposal letter-char digit-char
))))
427 (if (y-or-n-p "Start a new game? ")
428 (mpuz-start-new-game)
429 (message "OK. I won't."))))
431 (defun mpuz-try-proposal (letter-char digit-char
)
432 "Propose LETTER-CHAR as code for DIGIT-CHAR."
433 (let* ((letter (- letter-char ?A
))
434 (digit (- digit-char ?
0))
435 (correct-digit (mpuz-to-digit letter
)))
436 (cond ((mpuz-digit-solved-p correct-digit
)
437 (message "%c has already been found." (+ correct-digit ?
0)))
438 ((mpuz-digit-solved-p digit
)
439 (message "%c has already been placed." digit-char
))
440 ((= digit correct-digit
)
441 (message "%c = %c correct!" letter-char digit-char
)
443 (aset mpuz-found-digits digit t
) ; Mark digit as solved
444 (and (mpuz-check-all-solved)
446 (t ;;; incorrect guess
447 (message "%c = %c incorrect!" letter-char digit-char
)
449 (setq mpuz-nb-errors
(1+ mpuz-nb-errors
))
450 (mpuz-paint-errors)))))
452 (defun mpuz-close-game ()
453 "Housecleaning when puzzle has been solved."
454 (setq mpuz-in-progress nil
455 mpuz-nb-cumulated-errors
(+ mpuz-nb-cumulated-errors mpuz-nb-errors
)
456 mpuz-nb-completed-games
(1+ mpuz-nb-completed-games
))
457 (mpuz-paint-statistics)
458 (let ((message (format "Puzzle solved with %d error%s. That's %s"
460 (if (= mpuz-nb-errors
1) "" "s")
461 (cond ((= mpuz-nb-errors
0) "perfect!")
462 ((= mpuz-nb-errors
1) "very good!")
463 ((= mpuz-nb-errors
2) "good.")
464 ((= mpuz-nb-errors
3) "not bad.")
465 ((= mpuz-nb-errors
4) "not too bad...")
466 ((< mpuz-nb-errors
10) "bad!")
467 ((< mpuz-nb-errors
15) "awful.")
468 (t "not serious.")))))
469 (message "%s" message
)
471 (if (y-or-n-p (concat message
" Start a new game? "))
472 (mpuz-start-new-game)
473 (message "Good Bye!"))))
475 (defun mpuz-solve (&optional row col
)
476 "Find solution for autosolving."
477 (mapc (lambda (digit)
478 (or (mpuz-digit-solved-p digit
)
481 (member (cons row col
) (aref mpuz-board digit
))
482 (assq row
(aref mpuz-board digit
)))))
483 (aset mpuz-trivial-digits digit t
)))
484 [0 1 2 3 4 5 6 7 8 9])
487 (defun mpuz-show-solution (row)
488 "Display solution for debugging purposes."
490 (mpuz-switch-to-window)
491 (mpuz-solve (if row
(* 2 (prefix-numeric-value row
))))
493 (if (mpuz-check-all-solved)
498 ;;; mpuz.el ends here