1 ;;; mpuz.el --- multiplication puzzle for GNU Emacs
3 ;; Copyright (C) 1990, 2001-2011 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 (random t
) ; randomize
40 (defcustom mpuz-silent
'error
41 "Set this to nil if you want dings on inputs.
42 t means never ding, and `error' means only ding on wrong input."
43 :type
'(choice (const :tag
"No" nil
)
45 (const :tag
"If correct" error
))
48 (defcustom mpuz-solve-when-trivial t
49 "Solve any row that can be trivially calculated from what you've found."
53 (defcustom mpuz-allow-double-multiplicator nil
54 "Allow 2nd factors like 33 or 77."
58 (defface mpuz-unsolved
59 '((((class color
)) (:foreground
"red1" :bold t
))
61 "Face to use for letters to be solved."
65 '((((class color
)) (:foreground
"green1" :bold t
))
67 "Face to use for solved digits."
71 '((((class color
)) (:foreground
"blue" :bold t
))
73 "Face to use for trivial digits solved for you."
77 '((t (:inherit variable-pitch
)))
78 "Face to use for text on right."
82 ;; Mpuz mode and keymaps
83 ;;----------------------
84 (defcustom mpuz-mode-hook nil
85 "Hook to run upon entry to mpuz."
90 (let ((map (make-sparse-keymap)))
91 (define-key map
"a" 'mpuz-try-letter
)
92 (define-key map
"b" 'mpuz-try-letter
)
93 (define-key map
"c" 'mpuz-try-letter
)
94 (define-key map
"d" 'mpuz-try-letter
)
95 (define-key map
"e" 'mpuz-try-letter
)
96 (define-key map
"f" 'mpuz-try-letter
)
97 (define-key map
"g" 'mpuz-try-letter
)
98 (define-key map
"h" 'mpuz-try-letter
)
99 (define-key map
"i" 'mpuz-try-letter
)
100 (define-key map
"j" 'mpuz-try-letter
)
101 (define-key map
"A" 'mpuz-try-letter
)
102 (define-key map
"B" 'mpuz-try-letter
)
103 (define-key map
"C" 'mpuz-try-letter
)
104 (define-key map
"D" 'mpuz-try-letter
)
105 (define-key map
"E" 'mpuz-try-letter
)
106 (define-key map
"F" 'mpuz-try-letter
)
107 (define-key map
"G" 'mpuz-try-letter
)
108 (define-key map
"H" 'mpuz-try-letter
)
109 (define-key map
"I" 'mpuz-try-letter
)
110 (define-key map
"J" 'mpuz-try-letter
)
111 (define-key map
"\C-g" 'mpuz-offer-abort
)
112 (define-key map
"?" 'describe-mode
)
114 "Local keymap to use in Mult Puzzle.")
119 "Multiplication puzzle mode.
121 You have to guess which letters stand for which digits in the
122 multiplication displayed inside the `*Mult Puzzle*' buffer.
124 You may enter a guess for a letter's value by typing first the letter,
125 then the digit. Thus, to guess that A=3, type `A 3'.
127 To leave the game to do other editing work, just switch buffers.
128 Then you may resume the game with M-x mpuz.
129 You may abort a game by typing \\<mpuz-mode-map>\\[mpuz-offer-abort]."
131 (kill-all-local-variables)
132 (setq major-mode
'mpuz-mode
133 mode-name
"Mult Puzzle"
135 (use-local-map mpuz-mode-map
)
136 (run-mode-hooks 'mpuz-mode-hook
))
139 ;; Some variables for statistics
140 ;;------------------------------
141 (defvar mpuz-nb-errors
0
142 "Number of errors made in current game.")
144 (defvar mpuz-nb-completed-games
0
145 "Number of games completed.")
147 (defvar mpuz-nb-cumulated-errors
0
148 "Number of errors made in previous games.")
151 ;; Some variables for game tracking
152 ;;---------------------------------
153 (defvar mpuz-in-progress nil
154 "True if a game is currently in progress.")
156 (defvar mpuz-found-digits
(make-bool-vector 10 nil
)
157 "A vector recording which digits have been decrypted.")
159 (defvar mpuz-trivial-digits
(make-bool-vector 10 nil
)
160 "A vector recording which digits have been solved for you.")
162 (defmacro mpuz-digit-solved-p
(digit)
163 `(or (aref mpuz-found-digits
,digit
)
164 (aref mpuz-trivial-digits
,digit
)))
167 ;; A puzzle uses a permutation of [0..9] into itself.
168 ;; We use both the permutation and its inverse.
169 ;;---------------------------------------------------
170 (defvar mpuz-digit-to-letter
(make-vector 10 0)
171 "A permutation from [0..9] to [0..9].")
173 (defvar mpuz-letter-to-digit
(make-vector 10 0)
174 "The inverse of mpuz-digit-to-letter.")
176 (defmacro mpuz-to-digit
(letter)
177 (list 'aref
'mpuz-letter-to-digit letter
))
179 (defmacro mpuz-to-letter
(digit)
180 (list 'aref
'mpuz-digit-to-letter digit
))
182 (defun mpuz-build-random-perm ()
183 "Initialize puzzle coding with a random permutation."
184 (let ((letters (list 0 1 2 3 4 5 6 7 8 9)) ; new cons cells, because of delq
188 (setq elem
(nth (random index
) letters
)
189 letters
(delq elem letters
)
191 (aset mpuz-digit-to-letter index elem
)
192 (aset mpuz-letter-to-digit elem index
))))
195 ;; A puzzle also uses a board displaying a multiplication.
196 ;; Every digit appears in the board, crypted or not.
197 ;;------------------------------------------------------
198 (defvar mpuz-board
(make-vector 10 nil
)
199 "The board associates to any digit the list of squares where it appears.")
201 (defun mpuz-put-number-on-board (number row
&rest l
)
202 "Put (last digit of) NUMBER on ROW and COLUMNS of the puzzle board."
205 (setq digit
(% number
10)
206 number
(/ number
10))
207 (aset mpuz-board digit
`((,row .
,(car l
)) ,@(aref mpuz-board digit
)))
210 (defun mpuz-check-all-solved (&optional row col
)
211 "Check whether all digits have been solved. Return t if yes."
213 (let (A B1 B2 C D E squares
)
214 (and mpuz-solve-when-trivial
217 (cond ((or (and (setq B1
(or B1
(mpuz-check-all-solved 4 7))
218 B2
(or B2
(mpuz-check-all-solved 4 9))
219 E
(or E
(mpuz-check-all-solved 10))
220 A
(or A
(mpuz-check-all-solved 2)))
222 (and E
(or A
(and B1 B2
))))
226 ((and (setq D
(or D
(mpuz-check-all-solved 8))
227 C
(or C
(mpuz-check-all-solved 6)))
230 ((and E
(not (eq C D
)))
231 (mpuz-solve (if D
6 8)))
232 ((and A
(not (eq B2 C
)))
233 (mpuz-solve (if C
4 6) (if C
9)))
234 ((and A
(not (eq B1 D
)))
235 (mpuz-solve (if D
4 8) (if D
7)))
236 ((and (not A
) (or (and B2 C
) (and B1 D
)))
239 (mapc (lambda (digit)
240 (and (not (mpuz-digit-solved-p digit
)) ; unsolved
241 (setq squares
(aref mpuz-board digit
))
244 (member (cons row col
) squares
)
246 squares
) ; and appearing in the puzzle!
247 (throw 'solved nil
)))
248 [0 1 2 3 4 5 6 7 8 9]))
252 ;; To build a puzzle, we take two random numbers and multiply them.
253 ;; We also take a random permutation for encryption.
254 ;; The random numbers are only use to see which digit appears in which square
255 ;; of the board. Everything is stored in individual squares.
256 ;;---------------------------------------------------------------------------
257 (defun mpuz-random-puzzle ()
258 "Draw random values to be multiplied in a puzzle."
259 (mpuz-build-random-perm)
260 (fillarray mpuz-board nil
) ; erase the board
261 ;; A,B,C,D & E, are the five rows of our multiplication.
262 ;; Choose random values, discarding cases with leading zeros in C or D.
263 (let* ((A (if mpuz-allow-double-multiplicator
(+ 112 (random 888))
264 (+ 125 (random 875))))
266 (B1 (+ min
(random (- 10 min
))))
268 (while (if (= B1
(setq B2
(+ min
(random (- 10 min
)))))
269 (not mpuz-allow-double-multiplicator
)))
273 ;; Individual digits are now put on their respective squares.
274 ;; [NB: A square is a pair (row . column) of the screen.]
275 (mpuz-put-number-on-board A
2 9 7 5)
276 (mpuz-put-number-on-board (+ (* B1
10) B2
) 4 9 7)
277 (mpuz-put-number-on-board C
6 9 7 5 3)
278 (mpuz-put-number-on-board D
8 7 5 3 1)
279 (mpuz-put-number-on-board E
10 9 7 5 3 1)))
283 (defconst mpuz-framework
286 Number of errors (this game): 0
290 Number of completed games: 0
292 --------- Average number of errors: 0.00
294 "The general picture of the puzzle screen, as a string.")
296 (defun mpuz-create-buffer ()
297 "Create (or recreate) the puzzle buffer. Return it."
298 (let ((buf (get-buffer-create "*Mult Puzzle*"))
299 (face '(face mpuz-text
))
301 (with-current-buffer buf
303 (insert mpuz-framework
)
304 (set-text-properties 13 42 face
)
305 (set-text-properties 79 105 face
)
306 (set-text-properties 128 153 face
)
309 (mpuz-paint-statistics))
312 (defun mpuz-paint-number (n &optional eol words
)
314 (let (buffer-read-only)
315 (delete-region (point)
316 (progn (backward-word (or words
1)) (point)))
319 (defun mpuz-paint-errors ()
320 "Paint error count on the puzzle screen."
321 (mpuz-switch-to-window)
322 (goto-char (point-min))
324 (mpuz-paint-number (prin1-to-string mpuz-nb-errors
)))
326 (defun mpuz-paint-statistics ()
327 "Paint statistics about previous games on the puzzle screen."
328 (goto-char (point-min))
330 (mpuz-paint-number (prin1-to-string mpuz-nb-completed-games
))
333 (if (zerop mpuz-nb-completed-games
)
335 (/ (+ 0.0 mpuz-nb-cumulated-errors
)
336 mpuz-nb-completed-games
)))
339 (defun mpuz-paint-board ()
340 "Paint board situation on the puzzle screen."
341 (mpuz-switch-to-window)
342 (mapc 'mpuz-paint-digit
[0 1 2 3 4 5 6 7 8 9])
343 (goto-char (point-min)))
345 (defun mpuz-paint-digit (digit)
346 "Paint all occurrences of DIGIT on the puzzle board."
347 (let ((char (if (mpuz-digit-solved-p digit
)
349 (+ (mpuz-to-letter digit
) ?A
)))
351 ,(cond ((aref mpuz-trivial-digits digit
) 'mpuz-trivial
)
352 ((aref mpuz-found-digits digit
) 'mpuz-solved
)
355 (mapc (lambda (square)
356 (goto-char (point-min))
357 (forward-line (1- (car square
))) ; line before column!
358 (move-to-column (cdr square
))
360 (set-text-properties (1- (point)) (point) face
)
362 (aref mpuz-board digit
))))
364 (defun mpuz-get-buffer ()
365 "Get the puzzle buffer if it exists."
366 (get-buffer "*Mult Puzzle*"))
368 (defun mpuz-switch-to-window ()
369 "Find or create the Mult-Puzzle buffer, and display it."
370 (let ((buf (mpuz-get-buffer)))
371 (or buf
(setq buf
(mpuz-create-buffer)))
372 (switch-to-buffer buf
)
373 (setq buffer-read-only t
)
379 (defun mpuz-start-new-game ()
380 "Start a new puzzle."
381 (message "Here we go...")
382 (setq mpuz-nb-errors
0
384 (fillarray mpuz-found-digits nil
) ; initialize mpuz-found-digits
385 (fillarray mpuz-trivial-digits nil
)
387 (mpuz-switch-to-window)
394 "Multiplication puzzle with GNU Emacs."
397 (mpuz-switch-to-window)
400 (mpuz-start-new-game)))
402 (defun mpuz-offer-abort ()
403 "Ask if user wants to abort current puzzle."
405 (if (y-or-n-p "Abort game? ")
406 (let ((buf (mpuz-get-buffer)))
407 (message "Mult Puzzle aborted.")
408 (setq mpuz-in-progress nil
410 (fillarray mpuz-board nil
)
411 (if buf
(kill-buffer buf
)))
414 (defun mpuz-ask-for-try ()
415 "Ask for user proposal in puzzle."
416 (message "Your try?"))
418 (defun mpuz-ding (error)
419 "Dings, unless global variable `mpuz-silent' forbids it."
420 (cond ((eq mpuz-silent t
))
421 ((not mpuz-silent
) (ding t
))
424 (defun mpuz-try-letter ()
425 "Propose a digit for a letter in puzzle."
428 (let (letter-char digit digit-char message
)
429 (setq letter-char
(upcase last-command-event
)
430 digit
(mpuz-to-digit (- letter-char ?A
)))
431 (cond ((mpuz-digit-solved-p digit
)
432 (message "%c already solved." letter-char
)
434 ((null (aref mpuz-board digit
))
435 (message "%c does not appear." letter-char
)
437 ((progn (message "%c = " letter-char
)
438 ;; <char> has been entered.
439 ;; Print "<char> =" and
440 ;; read <num> or = <num>
441 (setq digit-char
(read-char))
442 (if (eq digit-char ?
=)
443 (setq digit-char
(read-char)))
444 (or (> digit-char ?
9) (< digit-char ?
0))) ; bad input
445 (message "%c = %c" letter-char digit-char
)
448 (mpuz-try-proposal letter-char digit-char
))))
449 (if (y-or-n-p "Start a new game? ")
450 (mpuz-start-new-game)
451 (message "OK. I won't."))))
453 (defun mpuz-try-proposal (letter-char digit-char
)
454 "Propose LETTER-CHAR as code for DIGIT-CHAR."
455 (let* ((letter (- letter-char ?A
))
456 (digit (- digit-char ?
0))
457 (correct-digit (mpuz-to-digit letter
))
458 (game mpuz-nb-completed-games
))
459 (cond ((mpuz-digit-solved-p correct-digit
)
460 (message "%c has already been found." (+ correct-digit ?
0)))
461 ((mpuz-digit-solved-p digit
)
462 (message "%c has already been placed." digit-char
))
463 ((= digit correct-digit
)
464 (message "%c = %c correct!" letter-char digit-char
)
466 (aset mpuz-found-digits digit t
) ; Mark digit as solved
467 (and (mpuz-check-all-solved)
469 (t ;;; incorrect guess
470 (message "%c = %c incorrect!" letter-char digit-char
)
472 (setq mpuz-nb-errors
(1+ mpuz-nb-errors
))
473 (mpuz-paint-errors)))))
475 (defun mpuz-close-game ()
476 "Housecleaning when puzzle has been solved."
477 (setq mpuz-in-progress nil
478 mpuz-nb-cumulated-errors
(+ mpuz-nb-cumulated-errors mpuz-nb-errors
)
479 mpuz-nb-completed-games
(1+ mpuz-nb-completed-games
))
480 (mpuz-paint-statistics)
481 (let ((message (format "Puzzle solved with %d error%s. That's %s"
483 (if (= mpuz-nb-errors
1) "" "s")
484 (cond ((= mpuz-nb-errors
0) "perfect!")
485 ((= mpuz-nb-errors
1) "very good!")
486 ((= mpuz-nb-errors
2) "good.")
487 ((= mpuz-nb-errors
3) "not bad.")
488 ((= mpuz-nb-errors
4) "not too bad...")
489 ((< mpuz-nb-errors
10) "bad!")
490 ((< mpuz-nb-errors
15) "awful.")
491 (t "not serious.")))))
492 (message "%s" message
)
494 (if (y-or-n-p (concat message
" Start a new game? "))
495 (mpuz-start-new-game)
496 (message "Good Bye!"))))
498 (defun mpuz-solve (&optional row col
)
499 "Find solution for autosolving."
500 (mapc (lambda (digit)
501 (or (mpuz-digit-solved-p digit
)
504 (member (cons row col
) (aref mpuz-board digit
))
505 (assq row
(aref mpuz-board digit
)))))
506 (aset mpuz-trivial-digits digit t
)))
507 [0 1 2 3 4 5 6 7 8 9])
510 (defun mpuz-show-solution (row)
511 "Display solution for debugging purposes."
513 (mpuz-switch-to-window)
514 (mpuz-solve (if row
(* 2 (prefix-numeric-value row
))))
516 (if (mpuz-check-all-solved)
521 ;;; mpuz.el ends here