1 ;;; sokoban.el --- Implementation of Sokoban for Emacs.
3 ;; Copyright (C) 1998, 2013 Free Software Foundation, Inc.
5 ;; Author: Glynn Clements <glynn.clements@xemacs.org>
11 ;; This file is part of XEmacs.
13 ;; XEmacs is free software; you can redistribute it and/or modify it
14 ;; under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; XEmacs is distributed in the hope that it will be useful, but
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 ;; General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with XEmacs; see the file COPYING. If not, write to the Free
25 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
28 ;;; Synched up with: Not synched.
32 ;; Modified: 1998-01-09, conditionalised use of locate-data-directory
33 ;; Modified: 1998-01-27, added mouse interface code
34 ;; (provided by Sean MacLennan <bn932@freenet.carleton.ca>
35 ;; Modified: 1998-02-06, fixed bug, where sokoban-done wasn't reset to
36 ;; zero in sokoban-restart-level
37 ;; Modified: 1998-02-27, patches from Hrvoje Niksic
38 ;; added bounds check to sokoban-goto-level
40 ;; display level and score in modeline
41 ;; Modified: 1998-06-04, added `undo' feature
42 ;; added number of blocks done/total to score and modeline
43 ;; Modified: 2003-06-14, update email address, remove URL
45 ;; Tested with XEmacs 20.3/4/5 and Emacs 19.34
47 ;; The game is based upon XSokoban, by
48 ;; Michael Bischoff <mbi@mo.math.nat.tu-bs.de>
50 ;; The levels and some of the pixmaps were
51 ;; taken directly from XSokoban
60 ;; ;;;;;;;;;;;;; customization variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
62 (defvar sokoban-use-glyphs t
63 "Non-nil means use glyphs when available.")
65 (defvar sokoban-use-color t
66 "Non-nil means use color when available.")
68 (defvar sokoban-font "-*-courier-medium-r-*-*-*-200-100-75-*-*-iso8859-*"
69 "Name of the font used in X mode.")
71 (defvar sokoban-buffer-name "*Sokoban*")
73 (defvar sokoban-temp-buffer-name " Sokoban-tmp")
75 (defvar sokoban-level-file
76 (if (fboundp 'locate-data-file)
77 (locate-data-file "sokoban.levels")
78 (or (locate-library "sokoban.levels")
79 (let ((file (expand-file-name
82 (file-name-directory load-file-name)))))
83 (and (file-exists-p file) file))
84 (expand-file-name "sokoban.levels" data-directory))))
86 (defvar sokoban-width 20)
87 (defvar sokoban-height 16)
89 (defvar sokoban-buffer-width 20)
90 (defvar sokoban-buffer-height 20)
92 (defvar sokoban-score-x 0)
93 (defvar sokoban-score-y 17)
95 (defvar sokoban-level-data nil)
97 ;; ;;;;;;;;;;;;; constants ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
99 (defconst sokoban-floor-xpm "\
101 static char * floor_xpm[] = {
139 (defconst sokoban-target-xpm "\
141 static char * target_xpm[] = {
161 \" .XXXXX. .XXXXX. \",
162 \" .XXXXX. .XXXXX. \",
181 (defconst sokoban-wall-xpm "\
183 static char * wall_xpm[] = {
187 \" .............................. \",
188 \". ............................ .\",
189 \".. .......................... . \",
190 \"... ........................ . .\",
192 \".... ...................... . .\",
193 \".... ...................... . . \",
194 \".... ...................... . .\",
195 \".... ...................... . . \",
196 \".... ...................... . .\",
197 \".... ...................... . . \",
198 \".... ...................... . .\",
199 \".... ...................... . . \",
200 \".... ...................... . .\",
201 \".... ...................... . . \",
202 \".... ...................... . .\",
203 \".... ...................... . . \",
204 \".... ...................... . .\",
205 \".... ...................... . . \",
206 \".... ...................... . .\",
207 \".... ...................... . . \",
208 \".... ...................... . .\",
209 \".... ...................... . . \",
210 \".... ...................... . .\",
211 \".... ...................... . . \",
212 \".... ...................... . .\",
213 \".... ...................... . . \",
215 \"... . . . . . . . . . . . . . \",
216 \".. . . . . . . . . . . . . . .\",
217 \". . . . . . . . . . . . . . . \",
218 \" . . . . . . . . . . . . . . . \",
222 (defconst sokoban-block-xpm "\
224 static char * block_xpm[] = {
229 \"............................. \",
230 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX. \",
231 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.. \",
232 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.. \",
233 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.X. \",
234 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.X. \",
235 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
236 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
237 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
238 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
239 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
240 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
241 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
242 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
243 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
244 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
245 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
246 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
247 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
248 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
249 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
250 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
251 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
252 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
253 \".............................XX.\",
254 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
255 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX.X.\",
256 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX.X.\",
257 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX..\",
258 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX..\",
259 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX.\",
260 \" .............................\",
264 (defconst sokoban-player-xpm "\
266 static char * player_xpm[] = {
282 \" oo..oo..oo..oo \",
283 \" o....o..o....o \",
284 \" o.o..o..o..o.o \",
285 \" o.o...oo...o.o \",
286 \" o.oo........oo.o \",
287 \" o.oo........oo.o \",
288 \" o.ooo........ooo.o \",
289 \" o.ooo........ooo.o \",
290 \" o.ooo........ooo.o \",
291 \" o.oo........oo.o \",
292 \" o.oo........oo.o \",
293 \" o.o..........o.o \",
294 \" o............o \",
298 \" o.....oo.....o \",
299 \" o......oo......o \",
300 \" o.......oo.......o \",
301 \" o..o..o..oo.oo..o..o \",
302 \" oooooooooooooooooooo \",
306 (defconst sokoban-floor ?\+)
307 ;; note - space character in level file is also allowed to indicate floor
308 (defconst sokoban-target ?\.)
309 (defconst sokoban-wall ?\#)
310 (defconst sokoban-block ?\$)
311 (defconst sokoban-player ?\@)
312 (defconst sokoban-block-on-target ?\*)
314 ;; ;;;;;;;;;;;;; display options ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
316 (defvar sokoban-floor-options
318 [xpm :data ,sokoban-floor-xpm])
322 (color-tty color-tty))
323 (((glyph color-x) [0 0 0])
324 (color-tty "black"))))
326 (defvar sokoban-target-options
328 [xpm :data ,sokoban-target-xpm])
329 ((mono-x mono-tty emacs-tty) ?\.)
333 (color-tty color-tty))
334 (((glyph color-x) [1 1 0.5])
335 (color-tty "yellow"))))
337 (defvar sokoban-wall-options
339 [xpm :data ,sokoban-wall-xpm])
344 (color-tty color-tty)
346 (((glyph color-x) [0 0 1])
347 (color-tty "blue"))))
349 (defvar sokoban-block-options
351 [xpm :data ,sokoban-block-xpm])
352 ((mono-x mono-tty emacs-tty) ?\O)
356 (color-tty color-tty))
357 (((glyph color-x) [1 0 0])
360 (defvar sokoban-player-options
362 [xpm :data ,sokoban-player-xpm])
366 (color-tty color-tty))
367 (((glyph color-x) [0 1 0])
368 (color-tty "green"))))
370 ;; ;;;;;;;;;;;;; variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
372 (defvar sokoban-level 0)
373 (make-variable-buffer-local 'sokoban-level)
374 (defvar sokoban-level-map nil)
375 (make-variable-buffer-local 'sokoban-level-map)
376 (defvar sokoban-targets 0)
377 (make-variable-buffer-local 'sokoban-targets)
379 (make-variable-buffer-local 'sokoban-x)
381 (make-variable-buffer-local 'sokoban-y)
382 (defvar sokoban-moves 0)
383 (make-variable-buffer-local 'sokoban-moves)
384 (defvar sokoban-pushes 0)
385 (make-variable-buffer-local 'sokoban-pushes)
386 (defvar sokoban-done 0)
387 (make-variable-buffer-local 'sokoban-done)
388 (defvar sokoban-mouse-x 0)
389 (make-variable-buffer-local 'sokoban-mouse-x)
390 (defvar sokoban-mouse-y 0)
391 (make-variable-buffer-local 'sokoban-mouse-y)
392 (defvar sokoban-undo-list nil)
393 (make-variable-buffer-local 'sokoban-undo-list)
395 ;; ;;;;;;;;;;;;; keymaps ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
397 (defvar sokoban-mode-map
398 (let ((map (make-sparse-keymap
399 (when (featurep 'xemacs) 'sokoban-mode-map))))
400 (define-key map "n" 'sokoban-start-game)
401 (define-key map "r" 'sokoban-restart-level)
402 (define-key map "g" 'sokoban-goto-level)
404 (define-key map [left] 'sokoban-move-left)
405 (define-key map [right] 'sokoban-move-right)
406 (define-key map [up] 'sokoban-move-up)
407 (define-key map [down] 'sokoban-move-down)
409 (when (featurep 'xemacs)
410 (define-key map [button2] 'sokoban-mouse-event-start)
411 (define-key map [button2up] 'sokoban-mouse-event-end))
413 (define-key map [down-mouse-2] 'sokoban-mouse-event-start)
414 (define-key map [mouse-2] 'sokoban-mouse-event-end)
415 ;; On some systems (OS X) middle mouse is difficult.
416 ;; FIXME: Use follow-link?
417 (define-key map [down-mouse-1] 'sokoban-mouse-event-start)
418 (define-key map [mouse-1] 'sokoban-mouse-event-end)
420 (define-key map [(control ?/)] 'sokoban-undo)
423 ;; ;;;;;;;;;;;;;;;; level file parsing functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
425 (defconst sokoban-level-regexp "^;LEVEL [0-9]+$")
427 (defconst sokoban-comment-regexp "^;")
429 (defun sokoban-init-level-data ()
430 (setq sokoban-level-data nil)
431 (with-current-buffer (find-file-noselect sokoban-level-file)
432 (if (fboundp 'read-only-mode)
434 (setq buffer-read-only t))
435 (goto-char (point-min))
436 (re-search-forward sokoban-level-regexp nil t)
439 (while (looking-at sokoban-comment-regexp)
441 (let ((data (make-vector sokoban-height nil))
442 (fmt (format "%%-%ds" sokoban-width)))
443 (dotimes (y sokoban-height)
445 (looking-at sokoban-comment-regexp))
446 (aset data y (format fmt "")))
448 (let ((start (point))
449 (end (line-end-position)))
452 (format fmt (buffer-substring start end)))
453 (goto-char (1+ end))))))
454 (push data sokoban-level-data)))
455 (kill-buffer (current-buffer))
456 (setq sokoban-level-data (nreverse sokoban-level-data))))
458 ;; ;;;;;;;;;;;;;;;; game functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
460 (defun sokoban-display-options ()
461 (let ((options (make-vector 256 nil)))
464 (cond ((= c sokoban-floor)
465 sokoban-floor-options)
466 ((= c sokoban-target)
467 sokoban-target-options)
469 sokoban-wall-options)
471 sokoban-block-options)
472 ((= c sokoban-player)
473 sokoban-player-options)
478 (defun sokoban-get-level-data ()
479 (setq sokoban-level-map (nth (1- sokoban-level) sokoban-level-data)
481 (dotimes (y sokoban-height)
482 (dotimes (x sokoban-width)
483 (let ((c (aref (aref sokoban-level-map y) x)))
485 ((= c sokoban-target)
486 (incf sokoban-targets))
487 ((= c sokoban-block-on-target)
488 (incf sokoban-targets)
490 ((= c ?\040) ;; treat space characters in level file as floor
491 (aset (aref sokoban-level-map y) x sokoban-floor)))))))
493 (defun sokoban-get-floor (x y)
494 (let ((c (aref (aref sokoban-level-map y) x)))
495 (if (or (= c sokoban-target)
496 (= c sokoban-block-on-target))
500 (defun sokoban-init-buffer ()
501 (gamegrid-init-buffer sokoban-buffer-width
502 sokoban-buffer-height
504 (dotimes (y sokoban-height)
505 (dotimes (x sokoban-width)
506 (let ((c (aref (aref sokoban-level-map y) x)))
507 (if (= c sokoban-player)
510 (if (= c sokoban-block-on-target)
511 (setq c sokoban-block))
512 (gamegrid-set-cell x y c)))))
514 (defun sokoban-draw-score ()
515 (let ((strings (vector (format "Moves: %05d" sokoban-moves)
516 (format "Pushes: %05d" sokoban-pushes)
517 (format "Done: %d/%d"
521 (let* ((string (aref strings y))
522 (len (length string)))
524 (gamegrid-set-cell (+ sokoban-score-x x)
525 (+ sokoban-score-y y)
527 (setq mode-line-format
528 (format "Sokoban: Level: %3d Moves: %05d Pushes: %05d Done: %d/%d"
529 sokoban-level sokoban-moves sokoban-pushes
530 sokoban-done sokoban-targets))
531 (force-mode-line-update))
533 (defun sokoban-add-move (dx dy)
534 (push (list 'move dx dy) sokoban-undo-list)
536 (sokoban-draw-score))
538 (defun sokoban-add-push (dx dy)
539 (push (list 'push dx dy) sokoban-undo-list)
541 (incf sokoban-pushes)
542 (sokoban-draw-score))
544 (defun sokoban-undo ()
545 "Undo previous Sokoban change."
547 ;; FIXME: Use the normal undo (via `apply' undo entries).
548 (if (null sokoban-undo-list)
549 (message "Nothing to undo")
550 (let* ((entry (pop sokoban-undo-list))
554 (cond ((eq type 'push)
555 (let* ((x (+ sokoban-x dx))
557 (c (sokoban-get-floor x y)))
558 (gamegrid-set-cell x y c)
559 (if (eq c sokoban-target)
561 (gamegrid-set-cell sokoban-x sokoban-y sokoban-block)
562 (setq c (sokoban-get-floor sokoban-x sokoban-y))
563 (if (eq c sokoban-target)
564 (incf sokoban-done)))
565 (setq sokoban-x (- sokoban-x dx))
566 (setq sokoban-y (- sokoban-y dy))
567 (gamegrid-set-cell sokoban-x sokoban-y sokoban-player)
568 (decf sokoban-pushes)
569 (decf sokoban-moves))
571 (let ((c (sokoban-get-floor sokoban-x sokoban-y)))
572 (gamegrid-set-cell sokoban-x sokoban-y c))
573 (setq sokoban-x (- sokoban-x dx))
574 (setq sokoban-y (- sokoban-y dy))
575 (gamegrid-set-cell sokoban-x sokoban-y sokoban-player)
576 (decf sokoban-moves))
578 (message "Invalid entry in sokoban-undo-list")))
579 (sokoban-draw-score))))
581 (defun sokoban-move (dx dy)
582 (let* ((x (+ sokoban-x dx))
584 (c (gamegrid-get-cell x y)))
585 (cond ((or (eq c sokoban-floor)
586 (eq c sokoban-target))
587 (gamegrid-set-cell sokoban-x
589 (sokoban-get-floor sokoban-x
593 (gamegrid-set-cell sokoban-x
596 (sokoban-add-move dx dy))
597 ((eq c sokoban-block)
600 (cc (gamegrid-get-cell xx yy)))
601 (cond ((or (eq cc sokoban-floor)
602 (eq cc sokoban-target))
603 (if (eq (sokoban-get-floor x y) sokoban-target)
605 (gamegrid-set-cell xx yy sokoban-block)
606 (gamegrid-set-cell x y sokoban-player)
607 (gamegrid-set-cell sokoban-x
609 (sokoban-get-floor sokoban-x
613 (if (eq (sokoban-get-floor xx yy) sokoban-target)
615 (sokoban-add-push dx dy)
616 (cond ((= sokoban-done sokoban-targets)
618 (sokoban-next-level))))))))))
620 (defun sokoban-event-x (event)
621 (let ((x (gamegrid-event-x event)))
622 (if (featurep 'xemacs)
624 ;; 32.0 is the pixel width of the xpm image
625 (floor x (/ 32.0 (frame-char-width))))))
627 (defun sokoban-event-y (event)
628 (let ((y (gamegrid-event-y event)))
629 (if (featurep 'xemacs)
631 (floor y (/ 32.0 (frame-char-height))))))
633 (defun sokoban-mouse-event-start (event)
634 "Record the beginning of a mouse click."
636 (setq sokoban-mouse-x (sokoban-event-x event))
637 (setq sokoban-mouse-y (sokoban-event-y event)))
639 (defun sokoban-mouse-event-end (event)
640 "Move according to the clicked position."
642 (let* ((x (sokoban-event-x event))
643 (y (sokoban-event-y event))
645 (dy (- y sokoban-y)))
647 ;; Ensure that press and release are in the same square
648 ;; (which allows you to abort a move)
649 ((not (and (eq sokoban-mouse-x x) (eq sokoban-mouse-y y)))
651 ;; Check that the move isn't diagonal
652 ((not (or (eq dx 0) (eq dy 0)))
669 (setq dy (1+ dy)))))))
671 (defun sokoban-move-left ()
672 "Move one square left."
676 (defun sokoban-move-right ()
677 "Move one square right."
681 (defun sokoban-move-up ()
682 "Move one square up."
686 (defun sokoban-move-down ()
687 "Move one square down."
691 (defun sokoban-restart-level ()
692 "Restart the current level."
694 (setq sokoban-moves 0
697 sokoban-undo-list nil)
698 (sokoban-get-level-data)
699 (sokoban-init-buffer)
700 (sokoban-draw-score))
702 (defun sokoban-next-level ()
704 (sokoban-restart-level))
706 (defun sokoban-goto-level (level)
707 "Jump to a specified LEVEL."
708 (interactive "nLevel: ")
709 (when (or (< level 1)
710 (> level (length sokoban-level-data)))
711 (signal 'args-out-of-range
712 (list "No such level number"
713 level 1 (> level (length sokoban-level-data)))))
714 (setq sokoban-level level)
715 (sokoban-restart-level))
717 (defun sokoban-start-game ()
718 "Start a new game of Sokoban."
720 (setq sokoban-level 0)
721 (sokoban-next-level))
723 (put 'sokoban-mode 'mode-class 'special)
725 (unless (featurep 'xemacs)
726 (easy-menu-define sokoban-popup-menu nil "Popup menu for Sokoban mode."
728 ["Restart this level" sokoban-restart-level]
729 ["Start new game" sokoban-start-game]
730 ["Go to specific level" sokoban-goto-level]))
731 (define-key sokoban-mode-map [down-mouse-3] sokoban-popup-menu))
733 (define-derived-mode sokoban-mode special-mode "Sokoban"
734 "A mode for playing Sokoban.
736 sokoban-mode keybindings:
737 \\{sokoban-mode-map}"
739 (when (featurep 'xemacs)
740 (setq mode-popup-menu
742 ["Restart this level" sokoban-restart-level]
743 ["Start new game" sokoban-start-game]
744 ["Go to specific level" sokoban-goto-level])))
746 (set (make-local-variable 'gamegrid-use-glyphs) sokoban-use-glyphs)
747 (set (make-local-variable 'gamegrid-use-color) sokoban-use-color)
748 (set (make-local-variable 'gamegrid-font) sokoban-font)
750 (gamegrid-init (sokoban-display-options))
752 (if (null sokoban-level-data)
753 (sokoban-init-level-data)))
759 Push the blocks onto the target squares.
761 sokoban-mode keybindings:
763 \\[sokoban-start-game] Starts a new game of Sokoban
764 \\[sokoban-restart-level] Restarts the current level
765 \\[sokoban-goto-level] Jumps to a specified level
766 \\[sokoban-move-left] Move one square to the left
767 \\[sokoban-move-right] Move one square to the right
768 \\[sokoban-move-up] Move one square up
769 \\[sokoban-move-down] Move one square down"
772 (switch-to-buffer sokoban-buffer-name)
773 (gamegrid-kill-timer)
775 (sokoban-start-game))
778 (unless (featurep 'xemacs)
779 (define-key-after ; install a menu entry
780 (lookup-key global-map [menu-bar tools games])
782 '(menu-item "Sokoban" sokoban)
787 ;;; sokoban.el ends here