1 ;;; solitaire.el --- game of solitaire in Emacs Lisp
3 ;; Copyright (C) 1994, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Jan Schormann <Jan.Schormann@rechen-gilde.de>
7 ;; Created: Fri afternoon, Jun 3, 1994
10 ;; This file is part of GNU Emacs.
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)
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to
24 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; This mode is for playing a well-known game of solitaire
30 ;; in which you jump pegs across other pegs.
32 ;; The game itself is somehow self-explanatory. Read the help text to
33 ;; solitaire, and try it.
37 (defgroup solitaire nil
42 (defvar solitaire-mode-map nil
43 "Keymap for playing solitaire.")
45 (defcustom solitaire-mode-hook nil
46 "Hook to run upon entry to solitaire."
50 (if solitaire-mode-map
52 (setq solitaire-mode-map
(make-sparse-keymap))
53 (suppress-keymap solitaire-mode-map t
)
54 (define-key solitaire-mode-map
"\C-f" 'solitaire-right
)
55 (define-key solitaire-mode-map
"\C-b" 'solitaire-left
)
56 (define-key solitaire-mode-map
"\C-p" 'solitaire-up
)
57 (define-key solitaire-mode-map
"\C-n" 'solitaire-down
)
58 (define-key solitaire-mode-map
[return] 'solitaire-move)
59 (define-key solitaire-mode-map [remap undo] 'solitaire-undo)
60 (define-key solitaire-mode-map " " 'solitaire-do-check)
61 (define-key solitaire-mode-map "q" 'quit-window)
63 (define-key solitaire-mode-map [right] 'solitaire-right)
64 (define-key solitaire-mode-map [left] 'solitaire-left)
65 (define-key solitaire-mode-map [up] 'solitaire-up)
66 (define-key solitaire-mode-map [down] 'solitaire-down)
68 (define-key solitaire-mode-map [S-right] 'solitaire-move-right)
69 (define-key solitaire-mode-map [S-left] 'solitaire-move-left)
70 (define-key solitaire-mode-map [S-up] 'solitaire-move-up)
71 (define-key solitaire-mode-map [S-down] 'solitaire-move-down)
73 (define-key solitaire-mode-map [kp-6] 'solitaire-right)
74 (define-key solitaire-mode-map [kp-4] 'solitaire-left)
75 (define-key solitaire-mode-map [kp-8] 'solitaire-up)
76 (define-key solitaire-mode-map [kp-2] 'solitaire-down)
77 (define-key solitaire-mode-map [kp-5] 'solitaire-center-point)
79 (define-key solitaire-mode-map [S-kp-6] 'solitaire-move-right)
80 (define-key solitaire-mode-map [S-kp-4] 'solitaire-move-left)
81 (define-key solitaire-mode-map [S-kp-8] 'solitaire-move-up)
82 (define-key solitaire-mode-map [S-kp-2] 'solitaire-move-down)
84 (define-key solitaire-mode-map [kp-enter] 'solitaire-move)
85 (define-key solitaire-mode-map [kp-0] 'solitaire-undo)
88 (define-key solitaire-mode-map [?s] 'solitaire-solve)
90 ;; (define-key solitaire-mode-map [kp-0] 'solitaire-hint) - Not yet provided ;)
93 ;; Solitaire mode is suitable only for specially formatted data.
94 (put 'solitaire-mode 'mode-class 'special)
96 (defun solitaire-mode ()
97 "Major mode for playing solitaire.
98 To learn how to play solitaire, see the documentation for function
100 \\<solitaire-mode-map>
101 The usual mnemonic keys move the cursor around the board; in addition,
102 \\[solitaire-move] is a prefix character for actually moving a stone on the board."
104 (kill-all-local-variables)
105 (use-local-map solitaire-mode-map)
106 (setq truncate-lines t)
107 (setq major-mode 'solitaire-mode)
108 (setq mode-name "Solitaire")
109 (run-mode-hooks 'solitaire-mode-hook))
111 (defvar solitaire-stones 0
112 "Counter for the stones that are still there.")
114 (defvar solitaire-center nil
115 "Center of the board.")
117 (defvar solitaire-start nil
118 "Upper left corner of the board.")
120 (defvar solitaire-start-x nil)
121 (defvar solitaire-start-y nil)
123 (defvar solitaire-end nil
124 "Lower right corner of the board.")
126 (defvar solitaire-end-x nil)
127 (defvar solitaire-end-y nil)
129 (defcustom solitaire-auto-eval t
130 "*Non-nil means check for possible moves after each major change.
131 This takes a while, so switch this on if you like to be informed when
132 the game is over, or off, if you are working on a slow machine."
136 (defconst solitaire-valid-directions
137 '(solitaire-left solitaire-right solitaire-up solitaire-down))
140 (defun solitaire (arg)
143 To play Solitaire, type \\[solitaire].
144 \\<solitaire-mode-map>
145 Move around the board using the cursor keys.
146 Move stones using \\[solitaire-move] followed by a direction key.
147 Undo moves using \\[solitaire-undo].
148 Check for possible moves using \\[solitaire-do-check].
149 \(The variable `solitaire-auto-eval' controls whether to automatically
150 check after each move or undo)
154 I don't know who invented this game, but it seems to be rather old and
155 its origin seems to be northern Africa. Here's how to play:
156 Initially, the board will look similar to this:
175 Let's call the o's stones and the .'s holes. One stone fits into one
176 hole. As you can see, all holes but one are occupied by stones. The
177 aim of the game is to get rid of all but one stone, leaving that last
178 one in the middle of the board if you're cool.
180 A stone can be moved if there is another stone next to it, and a hole
181 after that one. Thus there must be three fields in a row, either
182 horizontally or vertically, up, down, left or right, which look like
185 Then the first stone is moved to the hole, jumping over the second,
186 which therefore is taken away. The above thus `evaluates' to: . . o
188 That's all. Here's the board after two moves:
204 Pick your favourite shortcuts:
206 \\{solitaire-mode-map}"
209 (switch-to-buffer "*Solitaire*")
211 (setq buffer-read-only t)
212 (setq solitaire-stones 32)
213 (solitaire-insert-board)
214 (solitaire-build-modeline)
215 (goto-char (point-max))
216 (setq solitaire-center (search-backward "."))
217 (setq buffer-undo-list (list (point)))
218 (set-buffer-modified-p nil))
220 (defun solitaire-build-modeline ()
221 (setq mode-line-format
222 (list "" "---" 'mode-line-buffer-identification
223 (if (< 1 solitaire-stones)
224 (format "--> There are %d stones left <--" solitaire-stones)
226 'global-mode-string " %[(" 'mode-name 'minor-mode-alist "%n"
228 (force-mode-line-update))
230 (defun solitaire-insert-board ()
231 (let* ((buffer-read-only nil)
234 (hsep (cond ((> w 26) " ")
237 (vsep (cond ((> h 17) "\n\n")
239 (indent (make-string (/ (- w 7 (* 6 (length hsep))) 2) ?\ )))
241 (insert (make-string (/ (- h 7 (if (> h 12) 3 0)
242 (* 6 (1- (length vsep)))) 2) ?\n))
243 (if (or (string= vsep "\n\n") (> h 12))
245 (insert (format "%sLe Solitaire\n" indent))
246 (insert (format "%s============\n\n" indent))))
248 (setq solitaire-start (point))
249 (setq solitaire-start-x (current-column))
250 (setq solitaire-start-y (solitaire-current-line))
251 (insert (format " %s %so%so%so%s" hsep hsep hsep hsep vsep))
252 (insert (format "%s %s %so%so%so%s" indent hsep hsep hsep hsep vsep))
253 (insert (format "%so%so%so%so%so%so%so%s" indent hsep hsep hsep hsep hsep hsep vsep))
254 (insert (format "%so%so%so%s" indent hsep hsep hsep))
255 (setq solitaire-center (point))
256 (insert (format ".%so%so%so%s" hsep hsep hsep vsep))
257 (insert (format "%so%so%so%so%so%so%so%s" indent hsep hsep hsep hsep hsep hsep vsep))
258 (insert (format "%s %s %so%so%so%s" indent hsep hsep hsep hsep vsep))
259 (insert (format "%s %s %so%so%so%s %s " indent hsep hsep hsep hsep hsep hsep))
260 (setq solitaire-end (point))
261 (setq solitaire-end-x (current-column))
262 (setq solitaire-end-y (solitaire-current-line))
265 (defun solitaire-right ()
267 (let ((start (point)))
269 (while (= ?\ (following-char))
271 (if (or (= 0 (following-char))
272 (= ?\ (following-char))
273 (= ?\n (following-char)))
276 (defun solitaire-left ()
278 (let ((start (point)))
280 (while (= ?\ (following-char))
282 (if (or (= 0 (preceding-char))
283 (= ?\ (following-char))
284 (= ?\n (following-char)))
287 (defun solitaire-up ()
289 (let ((start (point))
290 (c (current-column)))
293 (while (and (= ?\n (following-char))
297 (if (or (= 0 (preceding-char))
298 (= ?\ (following-char))
299 (= ?\= (following-char))
300 (= ?\n (following-char)))
304 (defun solitaire-down ()
306 (let ((start (point))
307 (c (current-column)))
310 (while (and (= ?\n (following-char))
314 (if (or (= 0 (following-char))
315 (= ?\ (following-char))
316 (= ?\n (following-char)))
319 (defun solitaire-center-point ()
321 (goto-char solitaire-center))
323 (defun solitaire-move-right () (interactive) (solitaire-move '[right]))
324 (defun solitaire-move-left () (interactive) (solitaire-move '[left]))
325 (defun solitaire-move-up () (interactive) (solitaire-move '[up]))
326 (defun solitaire-move-down () (interactive) (solitaire-move '[down]))
328 (defun solitaire-possible-move (movesymbol)
329 "Check if a move is possible from current point in the specified direction.
330 MOVESYMBOL specifies the direction.
331 Returns either a string, indicating cause of contraindication, or a
332 list containing three numbers: starting field, skipped field (from
333 which a stone will be taken away) and target."
336 (if (memq movesymbol solitaire-valid-directions)
337 (let ((start (point))
338 (skip (progn (funcall movesymbol) (point)))
339 (target (progn (funcall movesymbol) (point))))
342 (if (or (/= ?o (char-after start))
343 (/= ?o (char-after skip))
344 (/= ?. (char-after target)))
346 (list start skip target))))
347 "Not a valid direction")))
349 (defun solitaire-move (dir)
350 "Pseudo-prefix command to move a stone in Solitaire."
351 (interactive "kMove where? ")
352 (let* ((class (solitaire-possible-move (lookup-key solitaire-mode-map dir)))
353 (buffer-read-only nil))
356 (let ((start (car class))
357 (skip (car (cdr class)))
358 (target (car (cdr (cdr class)))))
369 (setq solitaire-stones (1- solitaire-stones))
370 (solitaire-build-modeline)
371 (if solitaire-auto-eval (solitaire-do-check))))))
373 (defun solitaire-undo (arg)
374 "Undo a move in Solitaire."
376 (let ((buffer-read-only nil))
379 (setq solitaire-stones
381 (goto-char solitaire-end)
382 (while (search-backward "o" solitaire-start 'done)
383 (and (>= (current-column) solitaire-start-x)
384 (<= (current-column) solitaire-end-x)
385 (>= (solitaire-current-line) solitaire-start-y)
386 (<= (solitaire-current-line) solitaire-end-y)
387 (setq count (1+ count))))
389 (solitaire-build-modeline)
390 (if solitaire-auto-eval (solitaire-do-check)))
392 (defun solitaire-check ()
394 (if (= 1 solitaire-stones)
396 (goto-char solitaire-end)
398 (while (search-backward "o" solitaire-start 'done)
399 (and (>= (current-column) solitaire-start-x)
400 (<= (current-column) solitaire-end-x)
401 (>= (solitaire-current-line) solitaire-start-y)
402 (<= (solitaire-current-line) solitaire-end-y)
405 (if (listp (solitaire-possible-move movesymbol))
406 (setq count (1+ count))))
407 solitaire-valid-directions)))
410 (defun solitaire-do-check (&optional arg)
411 "Check for any possible moves in Solitaire."
413 (let ((moves (solitaire-check)))
414 (cond ((= 1 solitaire-stones)
415 (message "Yeah! You made it! Only the King is left!"))
417 (message "Sorry, no more possible moves."))
419 (message "There is one possible move."))
420 (t (message "There are %d possible moves." moves)))))
422 (defun solitaire-current-line ()
423 "Return the vertical position of point.
424 Seen in info on text lines."
425 (+ (count-lines (point-min) (point))
426 (if (= (current-column) 0) 1 0)
429 ;; And here's the spoiler:)
430 (defun solitaire-solve ()
431 "Spoil solitaire by solving the game for you - nearly ...
432 ... stops with five stones left ;)"
434 (let ((allmoves [up up S-down up left left S-right up up left S-down
435 up up right right S-left down down down S-up up
436 S-down down down down S-up left left down
437 S-right left left up up S-down right right right
438 S-left left S-right right right right S-left
439 right down down S-up down down left left S-right
440 up up up S-down down S-up up up up S-down up
441 right right S-left down right right down S-up
442 left left left S-right right S-left down down
443 left S-right S-up S-left S-left S-down S-right
444 up S-right left left])
445 ;; down down S-up left S-right
447 (solitaire-auto-eval nil))
448 (solitaire-center-point)
450 (if (memq op '(S-left S-right S-up S-down))
452 (execute-kbd-macro (vector op))
453 (if (memq op '(S-left S-right S-up S-down))
456 (solitaire-do-check))
460 ;;; arch-tag: 1b18ee1c-1e79-4a5b-8658-9560b82e63dd
461 ;;; solitaire.el ends here