1 ;;; sokoban.el --- Implementation of Sokoban for Emacs.
3 ;; Copyright (C) 1998, 2013 Free Software Foundation, Inc.
5 ;; Author: Glynn Clements <glynn.clements@virgin.net>
10 ;; This file is part of XEmacs.
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ;; General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
27 ;;; Synched up with: Not synched.
31 ;; Modified: 1998-01-09, conditionalised use of locate-data-directory
32 ;; Modified: 1998-01-27, added mouse interface code
33 ;; (provided by Sean MacLennan <bn932@freenet.carleton.ca>
34 ;; Modified: 1998-02-06, fixed bug, where sokoban-done wasn't reset to
35 ;; zero in sokoban-restart-level
36 ;; Modified: 1998-02-27, patches from Hrvoje Niksic
37 ;; added bounds check to sokoban-goto-level
39 ;; display level and score in modeline
40 ;; Modified: 1998-06-04, added `undo' feature
41 ;; added number of blocks done/total to score and modeline
42 ;; Modified: 2003-06-14, update email address, remove URL
44 ;; Tested with XEmacs 20.3/4/5 and Emacs 19.34
46 ;; The game is based upon XSokoban, by
47 ;; Michael Bischoff <mbi@mo.math.nat.tu-bs.de>
49 ;; The levels and some of the pixmaps were
50 ;; taken directly from XSokoban
59 ;; ;;;;;;;;;;;;; customization variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
61 (defvar sokoban-use-glyphs t
62 "Non-nil means use glyphs when available.")
64 (defvar sokoban-use-color t
65 "Non-nil means use color when available.")
67 (defvar sokoban-font "-*-courier-medium-r-*-*-*-200-100-75-*-*-iso8859-*"
68 "Name of the font used in X mode.")
70 (defvar sokoban-buffer-name "*Sokoban*")
72 (defvar sokoban-temp-buffer-name " Sokoban-tmp")
74 (defvar sokoban-level-file
75 (if (fboundp 'locate-data-file)
76 (locate-data-file "sokoban.levels")
77 (or (locate-library "sokoban.levels")
78 (let ((file (expand-file-name
81 (file-name-directory load-file-name)))))
82 (and (file-exists-p file) file))
83 (expand-file-name "sokoban.levels" data-directory))))
85 (defvar sokoban-width 20)
86 (defvar sokoban-height 16)
88 (defvar sokoban-buffer-width 20)
89 (defvar sokoban-buffer-height 20)
91 (defvar sokoban-score-x 0)
92 (defvar sokoban-score-y 17)
94 (defvar sokoban-level-data nil)
96 ;; ;;;;;;;;;;;;; constants ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
98 (defconst sokoban-floor-xpm "\
100 static char * floor_xpm[] = {
138 (defconst sokoban-target-xpm "\
140 static char * target_xpm[] = {
160 \" .XXXXX. .XXXXX. \",
161 \" .XXXXX. .XXXXX. \",
180 (defconst sokoban-wall-xpm "\
182 static char * wall_xpm[] = {
186 \" .............................. \",
187 \". ............................ .\",
188 \".. .......................... . \",
189 \"... ........................ . .\",
191 \".... ...................... . .\",
192 \".... ...................... . . \",
193 \".... ...................... . .\",
194 \".... ...................... . . \",
195 \".... ...................... . .\",
196 \".... ...................... . . \",
197 \".... ...................... . .\",
198 \".... ...................... . . \",
199 \".... ...................... . .\",
200 \".... ...................... . . \",
201 \".... ...................... . .\",
202 \".... ...................... . . \",
203 \".... ...................... . .\",
204 \".... ...................... . . \",
205 \".... ...................... . .\",
206 \".... ...................... . . \",
207 \".... ...................... . .\",
208 \".... ...................... . . \",
209 \".... ...................... . .\",
210 \".... ...................... . . \",
211 \".... ...................... . .\",
212 \".... ...................... . . \",
214 \"... . . . . . . . . . . . . . \",
215 \".. . . . . . . . . . . . . . .\",
216 \". . . . . . . . . . . . . . . \",
217 \" . . . . . . . . . . . . . . . \",
221 (defconst sokoban-block-xpm "\
223 static char * block_xpm[] = {
228 \"............................. \",
229 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX. \",
230 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.. \",
231 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.. \",
232 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.X. \",
233 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.X. \",
234 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
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 \".............................XX.\",
253 \".XXXXXXXXXXXXXXXXXXXXXXXXXXX.XX.\",
254 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX.X.\",
255 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX.X.\",
256 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX..\",
257 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX..\",
258 \" .XXXXXXXXXXXXXXXXXXXXXXXXXXX.\",
259 \" .............................\",
263 (defconst sokoban-player-xpm "\
265 static char * player_xpm[] = {
281 \" oo..oo..oo..oo \",
282 \" o....o..o....o \",
283 \" o.o..o..o..o.o \",
284 \" o.o...oo...o.o \",
285 \" o.oo........oo.o \",
286 \" o.oo........oo.o \",
287 \" o.ooo........ooo.o \",
288 \" o.ooo........ooo.o \",
289 \" o.ooo........ooo.o \",
290 \" o.oo........oo.o \",
291 \" o.oo........oo.o \",
292 \" o.o..........o.o \",
293 \" o............o \",
297 \" o.....oo.....o \",
298 \" o......oo......o \",
299 \" o.......oo.......o \",
300 \" o..o..o..oo.oo..o..o \",
301 \" oooooooooooooooooooo \",
305 (defconst sokoban-floor ?\+)
306 ;; note - space character in level file is also allowed to indicate floor
307 (defconst sokoban-target ?\.)
308 (defconst sokoban-wall ?\#)
309 (defconst sokoban-block ?\$)
310 (defconst sokoban-player ?\@)
311 (defconst sokoban-block-on-target ?\*)
313 ;; ;;;;;;;;;;;;; display options ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
315 (defvar sokoban-floor-options
317 [xpm :data ,sokoban-floor-xpm])
321 (color-tty color-tty))
322 (((glyph color-x) [0 0 0])
323 (color-tty "black"))))
325 (defvar sokoban-target-options
327 [xpm :data ,sokoban-target-xpm])
328 ((mono-x mono-tty emacs-tty) ?\.)
332 (color-tty color-tty))
333 (((glyph color-x) [1 1 0.5])
334 (color-tty "yellow"))))
336 (defvar sokoban-wall-options
338 [xpm :data ,sokoban-wall-xpm])
343 (color-tty color-tty)
345 (((glyph color-x) [0 0 1])
346 (color-tty "blue"))))
348 (defvar sokoban-block-options
350 [xpm :data ,sokoban-block-xpm])
351 ((mono-x mono-tty emacs-tty) ?\O)
355 (color-tty color-tty))
356 (((glyph color-x) [1 0 0])
359 (defvar sokoban-player-options
361 [xpm :data ,sokoban-player-xpm])
365 (color-tty color-tty))
366 (((glyph color-x) [0 1 0])
367 (color-tty "green"))))
369 ;; ;;;;;;;;;;;;; variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
371 (defvar sokoban-level 0)
372 (make-variable-buffer-local 'sokoban-level)
373 (defvar sokoban-level-map nil)
374 (make-variable-buffer-local 'sokoban-level-map)
375 (defvar sokoban-targets 0)
376 (make-variable-buffer-local 'sokoban-targets)
378 (make-variable-buffer-local 'sokoban-x)
380 (make-variable-buffer-local 'sokoban-y)
381 (defvar sokoban-moves 0)
382 (make-variable-buffer-local 'sokoban-moves)
383 (defvar sokoban-pushes 0)
384 (make-variable-buffer-local 'sokoban-pushes)
385 (defvar sokoban-done 0)
386 (make-variable-buffer-local 'sokoban-done)
387 (defvar sokoban-mouse-x 0)
388 (make-variable-buffer-local 'sokoban-mouse-x)
389 (defvar sokoban-mouse-y 0)
390 (make-variable-buffer-local 'sokoban-mouse-y)
391 (defvar sokoban-undo-list nil)
392 (make-variable-buffer-local 'sokoban-undo-list)
394 ;; ;;;;;;;;;;;;; keymaps ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
396 (defvar sokoban-mode-map
397 (let ((map (make-sparse-keymap
398 (when (featurep 'xemacs) 'sokoban-mode-map))))
399 (define-key map "n" 'sokoban-start-game)
400 (define-key map "r" 'sokoban-restart-level)
401 (define-key map "g" 'sokoban-goto-level)
403 (define-key map [left] 'sokoban-move-left)
404 (define-key map [right] 'sokoban-move-right)
405 (define-key map [up] 'sokoban-move-up)
406 (define-key map [down] 'sokoban-move-down)
408 (when (featurep 'xemacs)
409 (define-key map [button2] 'sokoban-mouse-event-start)
410 (define-key map [button2up] 'sokoban-mouse-event-end))
412 (define-key map [down-mouse-2] 'sokoban-mouse-event-start)
413 (define-key map [mouse-2] 'sokoban-mouse-event-end)
414 ;; On some systems (OS X) middle mouse is difficult.
415 ;; FIXME: Use follow-link?
416 (define-key map [down-mouse-1] 'sokoban-mouse-event-start)
417 (define-key map [mouse-1] 'sokoban-mouse-event-end)
419 (define-key map [(control ?/)] 'sokoban-undo)
422 ;; ;;;;;;;;;;;;;;;; level file parsing functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
424 (defconst sokoban-level-regexp "^;LEVEL [0-9]+$")
426 (defconst sokoban-comment-regexp "^;")
428 (defun sokoban-init-level-data ()
429 (setq sokoban-level-data nil)
430 (with-current-buffer (find-file-noselect sokoban-level-file)
431 (if (fboundp 'read-only-mode)
433 (setq buffer-read-only t))
434 (goto-char (point-min))
435 (re-search-forward sokoban-level-regexp nil t)
438 (while (looking-at sokoban-comment-regexp)
440 (let ((data (make-vector sokoban-height nil))
441 (fmt (format "%%-%ds" sokoban-width)))
442 (dotimes (y sokoban-height)
444 (looking-at sokoban-comment-regexp))
445 (aset data y (format fmt "")))
447 (let ((start (point))
448 (end (line-end-position)))
451 (format fmt (buffer-substring start end)))
452 (goto-char (1+ end))))))
453 (push data sokoban-level-data)))
454 (kill-buffer (current-buffer))
455 (setq sokoban-level-data (nreverse sokoban-level-data))))
457 ;; ;;;;;;;;;;;;;;;; game functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
459 (defun sokoban-display-options ()
460 (let ((options (make-vector 256 nil)))
463 (cond ((= c sokoban-floor)
464 sokoban-floor-options)
465 ((= c sokoban-target)
466 sokoban-target-options)
468 sokoban-wall-options)
470 sokoban-block-options)
471 ((= c sokoban-player)
472 sokoban-player-options)
477 (defun sokoban-get-level-data ()
478 (setq sokoban-level-map (nth (1- sokoban-level) sokoban-level-data)
480 (dotimes (y sokoban-height)
481 (dotimes (x sokoban-width)
482 (let ((c (aref (aref sokoban-level-map y) x)))
484 ((= c sokoban-target)
485 (incf sokoban-targets))
486 ((= c sokoban-block-on-target)
487 (incf sokoban-targets)
489 ((= c ?\040) ;; treat space characters in level file as floor
490 (aset (aref sokoban-level-map y) x sokoban-floor)))))))
492 (defun sokoban-get-floor (x y)
493 (let ((c (aref (aref sokoban-level-map y) x)))
494 (if (or (= c sokoban-target)
495 (= c sokoban-block-on-target))
499 (defun sokoban-init-buffer ()
500 (gamegrid-init-buffer sokoban-buffer-width
501 sokoban-buffer-height
503 (dotimes (y sokoban-height)
504 (dotimes (x sokoban-width)
505 (let ((c (aref (aref sokoban-level-map y) x)))
506 (if (= c sokoban-player)
509 (if (= c sokoban-block-on-target)
510 (setq c sokoban-block))
511 (gamegrid-set-cell x y c)))))
513 (defun sokoban-draw-score ()
514 (let ((strings (vector (format "Moves: %05d" sokoban-moves)
515 (format "Pushes: %05d" sokoban-pushes)
516 (format "Done: %d/%d"
520 (let* ((string (aref strings y))
521 (len (length string)))
523 (gamegrid-set-cell (+ sokoban-score-x x)
524 (+ sokoban-score-y y)
526 (setq mode-line-format
527 (format "Sokoban: Level: %3d Moves: %05d Pushes: %05d Done: %d/%d"
528 sokoban-level sokoban-moves sokoban-pushes
529 sokoban-done sokoban-targets))
530 (force-mode-line-update))
532 (defun sokoban-add-move (dx dy)
533 (push (list 'move dx dy) sokoban-undo-list)
535 (sokoban-draw-score))
537 (defun sokoban-add-push (dx dy)
538 (push (list 'push dx dy) sokoban-undo-list)
540 (incf sokoban-pushes)
541 (sokoban-draw-score))
543 (defun sokoban-undo ()
544 "Undo previous Sokoban change."
546 ;; FIXME: Use the normal undo (via `apply' undo entries).
547 (if (null sokoban-undo-list)
548 (message "Nothing to undo")
549 (let* ((entry (pop sokoban-undo-list))
553 (cond ((eq type 'push)
554 (let* ((x (+ sokoban-x dx))
556 (c (sokoban-get-floor x y)))
557 (gamegrid-set-cell x y c)
558 (if (eq c sokoban-target)
560 (gamegrid-set-cell sokoban-x sokoban-y sokoban-block)
561 (setq c (sokoban-get-floor sokoban-x sokoban-y))
562 (if (eq c sokoban-target)
563 (incf sokoban-done)))
564 (setq sokoban-x (- sokoban-x dx))
565 (setq sokoban-y (- sokoban-y dy))
566 (gamegrid-set-cell sokoban-x sokoban-y sokoban-player)
567 (decf sokoban-pushes)
568 (decf sokoban-moves))
570 (let ((c (sokoban-get-floor sokoban-x sokoban-y)))
571 (gamegrid-set-cell sokoban-x sokoban-y c))
572 (setq sokoban-x (- sokoban-x dx))
573 (setq sokoban-y (- sokoban-y dy))
574 (gamegrid-set-cell sokoban-x sokoban-y sokoban-player)
575 (decf sokoban-moves))
577 (message "Invalid entry in sokoban-undo-list")))
578 (sokoban-draw-score))))
580 (defun sokoban-move (dx dy)
581 (let* ((x (+ sokoban-x dx))
583 (c (gamegrid-get-cell x y)))
584 (cond ((or (eq c sokoban-floor)
585 (eq c sokoban-target))
586 (gamegrid-set-cell sokoban-x
588 (sokoban-get-floor sokoban-x
592 (gamegrid-set-cell sokoban-x
595 (sokoban-add-move dx dy))
596 ((eq c sokoban-block)
599 (cc (gamegrid-get-cell xx yy)))
600 (cond ((or (eq cc sokoban-floor)
601 (eq cc sokoban-target))
602 (if (eq (sokoban-get-floor x y) sokoban-target)
604 (gamegrid-set-cell xx yy sokoban-block)
605 (gamegrid-set-cell x y sokoban-player)
606 (gamegrid-set-cell sokoban-x
608 (sokoban-get-floor sokoban-x
612 (if (eq (sokoban-get-floor xx yy) sokoban-target)
614 (sokoban-add-push dx dy)
615 (cond ((= sokoban-done sokoban-targets)
617 (sokoban-next-level))))))))))
619 (defun sokoban-event-x (event)
620 (let ((x (gamegrid-event-x event)))
621 (if (featurep 'xemacs)
623 ;; 32.0 is the pixel width of the xpm image
624 (floor x (/ 32.0 (frame-char-width))))))
626 (defun sokoban-event-y (event)
627 (let ((y (gamegrid-event-y event)))
628 (if (featurep 'xemacs)
630 (floor y (/ 32.0 (frame-char-height))))))
632 (defun sokoban-mouse-event-start (event)
633 "Record the beginning of a mouse click."
635 (setq sokoban-mouse-x (sokoban-event-x event))
636 (setq sokoban-mouse-y (sokoban-event-y event)))
638 (defun sokoban-mouse-event-end (event)
639 "Move according to the clicked position."
641 (let* ((x (sokoban-event-x event))
642 (y (sokoban-event-y event))
644 (dy (- y sokoban-y)))
646 ;; Ensure that press and release are in the same square
647 ;; (which allows you to abort a move)
648 ((not (and (eq sokoban-mouse-x x) (eq sokoban-mouse-y y)))
650 ;; Check that the move isn't diagonal
651 ((not (or (eq dx 0) (eq dy 0)))
668 (setq dy (1+ dy)))))))
670 (defun sokoban-move-left ()
671 "Move one square left."
675 (defun sokoban-move-right ()
676 "Move one square right."
680 (defun sokoban-move-up ()
681 "Move one square up."
685 (defun sokoban-move-down ()
686 "Move one square down."
690 (defun sokoban-restart-level ()
691 "Restart the current level."
693 (setq sokoban-moves 0
696 sokoban-undo-list nil)
697 (sokoban-get-level-data)
698 (sokoban-init-buffer)
699 (sokoban-draw-score))
701 (defun sokoban-next-level ()
703 (sokoban-restart-level))
705 (defun sokoban-goto-level (level)
706 "Jump to a specified LEVEL."
707 (interactive "nLevel: ")
708 (when (or (< level 1)
709 (> level (length sokoban-level-data)))
710 (signal 'args-out-of-range
711 (list "No such level number"
712 level 1 (> level (length sokoban-level-data)))))
713 (setq sokoban-level level)
714 (sokoban-restart-level))
716 (defun sokoban-start-game ()
717 "Start a new game of Sokoban."
719 (setq sokoban-level 0)
720 (sokoban-next-level))
722 (put 'sokoban-mode 'mode-class 'special)
724 (unless (featurep 'xemacs)
725 (easy-menu-define sokoban-popup-menu nil "Popup menu for Sokoban mode."
727 ["Restart this level" sokoban-restart-level]
728 ["Start new game" sokoban-start-game]
729 ["Go to specific level" sokoban-goto-level]))
730 (define-key sokoban-mode-map [down-mouse-3] sokoban-popup-menu))
732 (define-derived-mode sokoban-mode special-mode "Sokoban"
733 "A mode for playing Sokoban.
735 sokoban-mode keybindings:
736 \\{sokoban-mode-map}"
738 (when (featurep 'xemacs)
739 (setq mode-popup-menu
741 ["Restart this level" sokoban-restart-level]
742 ["Start new game" sokoban-start-game]
743 ["Go to specific level" sokoban-goto-level])))
745 (set (make-local-variable 'gamegrid-use-glyphs) sokoban-use-glyphs)
746 (set (make-local-variable 'gamegrid-use-color) sokoban-use-color)
747 (set (make-local-variable 'gamegrid-font) sokoban-font)
749 (gamegrid-init (sokoban-display-options))
751 (if (null sokoban-level-data)
752 (sokoban-init-level-data)))
758 Push the blocks onto the target squares.
760 sokoban-mode keybindings:
762 \\[sokoban-start-game] Starts a new game of Sokoban
763 \\[sokoban-restart-level] Restarts the current level
764 \\[sokoban-goto-level] Jumps to a specified level
765 \\[sokoban-move-left] Move one square to the left
766 \\[sokoban-move-right] Move one square to the right
767 \\[sokoban-move-up] Move one square up
768 \\[sokoban-move-down] Move one square down"
771 (switch-to-buffer sokoban-buffer-name)
772 (gamegrid-kill-timer)
774 (sokoban-start-game))
777 (unless (featurep 'xemacs)
778 (define-key-after ; install a menu entry
779 (lookup-key global-map [menu-bar tools games])
781 '(menu-item "Sokoban" sokoban)
786 ;;; sokoban.el ends here