1 ;;; gamegrid.el --- library for implementing grid-based games on Emacs
3 ;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4 ;; 2008 Free Software Foundation, Inc.
6 ;; Author: Glynn Clements <glynn@sensei.co.uk>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it 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 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 ;; ;;;;;;;;;;;;; buffer-local variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
35 (defvar gamegrid-use-glyphs t
36 "Non-nil means use glyphs when available.")
38 (defvar gamegrid-use-color t
39 "Non-nil means use color when available.")
41 (defvar gamegrid-font
"-*-courier-medium-r-*-*-*-140-100-75-*-*-iso8859-*"
42 "Name of the font used in X mode.")
44 (defvar gamegrid-face nil
45 "Indicates the face to use as a default.")
46 (make-variable-buffer-local 'gamegrid-face
)
48 (defvar gamegrid-display-options nil
)
50 (defvar gamegrid-buffer-width
0)
51 (defvar gamegrid-buffer-height
0)
52 (defvar gamegrid-blank
0)
54 (defvar gamegrid-timer nil
)
56 (defvar gamegrid-display-mode nil
)
58 (defvar gamegrid-display-table
)
60 (defvar gamegrid-face-table nil
)
62 (defvar gamegrid-buffer-start
1)
64 (defvar gamegrid-score-file-length
50
65 "Number of high scores to keep")
67 (defvar gamegrid-user-score-file-directory
68 (concat user-emacs-directory
"games")
69 "A directory for game scores which can't be shared.
70 If Emacs was built without support for shared game scores, then this
71 directory will be used.")
73 (make-variable-buffer-local 'gamegrid-use-glyphs
)
74 (make-variable-buffer-local 'gamegrid-use-color
)
75 (make-variable-buffer-local 'gamegrid-font
)
76 (make-variable-buffer-local 'gamegrid-display-options
)
77 (make-variable-buffer-local 'gamegrid-buffer-width
)
78 (make-variable-buffer-local 'gamegrid-buffer-height
)
79 (make-variable-buffer-local 'gamegrid-blank
)
80 (make-variable-buffer-local 'gamegrid-timer
)
81 (make-variable-buffer-local 'gamegrid-display-mode
)
82 (make-variable-buffer-local 'gamegrid-display-table
)
83 (make-variable-buffer-local 'gamegrid-face-table
)
84 (make-variable-buffer-local 'gamegrid-buffer-start
)
85 (make-variable-buffer-local 'gamegrid-score-file-length
)
87 ;; ;;;;;;;;;;;;; global variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
89 (defvar gamegrid-grid-x-face nil
)
90 (defvar gamegrid-mono-x-face nil
)
91 (defvar gamegrid-mono-tty-face nil
)
93 ;; ;;;;;;;;;;;;; constants ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
95 (defconst gamegrid-glyph-height
16)
97 (defconst gamegrid-xpm
"\
99 static char *noname[] = {
100 /* width height ncolors chars_per_pixel */
107 \"---------------+\",
108 \"--------------++\",
109 \"--............++\",
110 \"--............++\",
111 \"--............++\",
112 \"--............++\",
113 \"--............++\",
114 \"--............++\",
115 \"--............++\",
116 \"--............++\",
117 \"--............++\",
118 \"--............++\",
119 \"--............++\",
120 \"--............++\",
121 \"-+++++++++++++++\",
125 "XPM format image used for each square")
127 (defvar gamegrid-xbm
"\
129 #define gamegrid_width 16
130 #define gamegrid_height 16
131 static unsigned char gamegrid_bits[] = {
132 0xff, 0xff, 0xff, 0x7f, 0xff, 0x3f, 0xaf, 0x0a, 0x57, 0x15, 0xaf, 0x0a,
133 0x57, 0x15, 0xaf, 0x0a, 0x57, 0x15, 0xaf, 0x0a, 0x57, 0x15, 0xaf, 0x0a,
134 0x57, 0x15, 0x07, 0x00, 0x03, 0x00, 0x01, 0x00 };"
135 "XBM format image used for each square.")
137 ;; ;;;;;;;;;;;;;;;; miscellaneous functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
139 (defsubst gamegrid-characterp
(arg)
140 (if (fboundp 'characterp
)
144 (defsubst gamegrid-event-x
(event)
145 (if (fboundp 'event-x
)
147 (car (posn-col-row (event-end event
)))))
149 (defsubst gamegrid-event-y
(event)
150 (if (fboundp 'event-y
)
152 (cdr (posn-col-row (event-end event
)))))
154 ;; ;;;;;;;;;;;;; display functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
156 (defun gamegrid-color (color shade
)
157 (let* ((v (floor (* shade
255)))
158 (r (* v
(aref color
0)))
159 (g (* v
(aref color
1)))
160 (b (* v
(aref color
2))))
161 (format "#%02x%02x%02x" r g b
)))
163 (defun gamegrid-set-font (face)
166 (set-face-font face gamegrid-font
)
169 (defun gamegrid-setup-face (face color
)
170 (set-face-foreground face color
)
171 (set-face-background face color
)
172 (gamegrid-set-font face
)
174 (set-face-background-pixmap face
[nothing]);; XEmacs
177 (set-face-background-pixmap face nil);; Emacs
180 (defun gamegrid-make-mono-tty-face ()
181 (let ((face (make-face 'gamegrid-mono-tty-face)))
182 (set-face-inverse-video-p face t)
185 (defun gamegrid-make-color-tty-face (color)
186 (let* ((color-str (if (symbolp color) (symbol-value color) color))
187 (name (intern (format "gamegrid-color-tty-face-%s" color-str)))
188 (face (make-face name)))
189 (gamegrid-setup-face face color-str)
192 (defun gamegrid-make-grid-x-face ()
193 (let ((face (make-face 'gamegrid-x-border-face)))
194 (gamegrid-set-font face)
197 (defun gamegrid-make-mono-x-face ()
198 (let ((face (make-face 'gamegrid-mono-x-face))
199 (color (face-foreground 'default)))
202 (cdr-safe (assq 'foreground-color (frame-parameters)))))
203 (gamegrid-setup-face face color)
206 (defun gamegrid-make-color-x-face (color)
207 (let* ((hex (gamegrid-color color 1.0))
208 (name (intern (format "gamegrid-color-x-face-%s" hex)))
209 (face (make-face name)))
210 (gamegrid-setup-face face hex)
213 (defun gamegrid-make-face (data-spec-list color-spec-list)
214 (let ((data (gamegrid-match-spec-list data-spec-list))
215 (color (gamegrid-match-spec-list color-spec-list)))
218 (gamegrid-make-color-x-face color))
220 (unless gamegrid-grid-x-face
221 (setq gamegrid-grid-x-face (gamegrid-make-grid-x-face)))
222 gamegrid-grid-x-face)
224 (unless gamegrid-mono-x-face
225 (setq gamegrid-mono-x-face (gamegrid-make-mono-x-face)))
226 gamegrid-mono-x-face)
228 (gamegrid-make-color-tty-face color))
230 (unless gamegrid-mono-tty-face
231 (setq gamegrid-mono-tty-face (gamegrid-make-mono-tty-face)))
232 gamegrid-mono-tty-face))))
234 (defun gamegrid-colorize-glyph (color)
235 (find-image `((:type xpm :data ,gamegrid-xpm
238 (("col1" . ,(gamegrid-color color 0.6))
239 ("col2" . ,(gamegrid-color color 0.8))
240 ("col3" . ,(gamegrid-color color 1.0))))
241 (:type xbm :data ,gamegrid-xbm
243 :foreground ,(gamegrid-color color 1.0)
244 :background ,(gamegrid-color color 0.5)))))
246 (defun gamegrid-match-spec (spec)
247 (let ((locale (car spec))
249 (and (or (eq locale t)
251 (memq gamegrid-display-mode locale))
252 (and (symbolp locale)
253 (eq gamegrid-display-mode locale)))
256 (defun gamegrid-match-spec-list (spec-list)
258 (or (gamegrid-match-spec (car spec-list))
259 (gamegrid-match-spec-list (cdr spec-list)))))
261 (defun gamegrid-make-glyph (data-spec-list color-spec-list)
262 (let ((data (gamegrid-match-spec-list data-spec-list))
263 (color (gamegrid-match-spec-list color-spec-list)))
264 (cond ((gamegrid-characterp data)
267 (gamegrid-colorize-glyph color))
269 (find-image data)) ;untested!
271 (gamegrid-make-image-from-vector data)))))
273 (defun gamegrid-make-image-from-vector (vect)
274 "Convert an XEmacs style \"glyph\" to an image-spec."
275 (let ((l (list 'image :type)))
276 (dotimes (n (length vect))
277 (setf l (nconc l (list (aref vect n)))))
278 (nconc l (list :ascent 'center))))
280 (defun gamegrid-display-type ()
281 (cond ((and gamegrid-use-glyphs
284 ((and gamegrid-use-color
290 ((and gamegrid-use-color
293 ((display-multi-font-p) ;???
298 (defun gamegrid-set-display-table ()
299 (if (featurep 'xemacs)
300 (add-spec-to-specifier current-display-table
301 gamegrid-display-table
305 (setq buffer-display-table gamegrid-display-table)))
307 (declare-function image-size "image.c" (spec &optional pixels frame))
309 (defun gamegrid-setup-default-font ()
312 (intern (concat "gamegrid-face-" (buffer-name)))))
313 (when (eq gamegrid-display-mode 'glyph)
314 (let ((max-height nil))
315 (loop for c from 0 to 255 do
316 (let ((glyph (aref gamegrid-display-table c)))
317 (when (and (listp glyph) (eq (car glyph) 'image))
318 (let ((height (cdr (image-size glyph))))
319 (if (or (null max-height)
320 (< max-height height))
321 (setq max-height height))))))
322 (when (and max-height (< max-height 1))
323 (let ((default-font-height (face-attribute 'default :height))
324 (resy (/ (display-pixel-height) (/ (display-mm-height) 25.4)))
325 point-size pixel-size)
326 (setq point-size (/ (* (float default-font-height) max-height) 10)
327 pixel-size (floor (* resy (/ point-size 72.27)))
328 point-size (* (/ pixel-size resy) 72.27))
329 (face-spec-set gamegrid-face
330 `((t :height ,(floor (* point-size 10))))))))))
332 (defun gamegrid-initialize-display ()
333 (setq gamegrid-display-mode (gamegrid-display-type))
334 (setq gamegrid-display-table (make-display-table))
335 (setq gamegrid-face-table (make-vector 256 nil))
336 (loop for c from 0 to 255 do
337 (let* ((spec (aref gamegrid-display-options c))
338 (glyph (gamegrid-make-glyph (car spec) (caddr spec)))
339 (face (gamegrid-make-face (cadr spec) (caddr spec))))
340 (aset gamegrid-face-table c face)
341 (aset gamegrid-display-table c glyph)))
342 (gamegrid-setup-default-font)
343 (gamegrid-set-display-table)
344 (setq cursor-type nil))
347 (defun gamegrid-set-face (c)
348 (if (eq gamegrid-display-mode 'glyph)
349 (add-text-properties (1- (point)) (point)
350 (list 'display (list (aref gamegrid-display-table c))))
351 (put-text-property (1- (point))
354 (aref gamegrid-face-table c))))
356 (defun gamegrid-cell-offset (x y)
357 (+ gamegrid-buffer-start
358 (* (1+ gamegrid-buffer-width) y)
361 ;; ;;;;;;;;;;;;;;;; grid functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
363 (defun gamegrid-get-cell (x y)
364 (char-after (gamegrid-cell-offset x y)))
366 (defun gamegrid-set-cell (x y c)
368 (let ((buffer-read-only nil))
369 (goto-char (gamegrid-cell-offset x y))
372 (gamegrid-set-face c))))
374 (defun gamegrid-init-buffer (width height blank)
375 (setq gamegrid-buffer-width width
376 gamegrid-buffer-height height)
378 (make-string width blank)
380 (buffer-read-only nil))
382 (setq gamegrid-buffer-start (point))
385 ;; Adjust the height of the default face to the height of the
386 ;; images. Unlike XEmacs, Emacs doesn't allow to make the default
387 ;; face buffer-local; so we do this with an overlay.
388 (when (eq gamegrid-display-mode 'glyph)
389 (overlay-put (make-overlay (point-min) (point-max))
390 'face gamegrid-face))
391 (goto-char (point-min))))
393 (defun gamegrid-init (options)
394 (setq buffer-read-only t
397 gamegrid-display-options options)
398 (buffer-disable-undo (current-buffer))
399 (gamegrid-initialize-display))
401 ;; ;;;;;;;;;;;;;;;; timer functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
403 (defun gamegrid-start-timer (period func)
405 (if (featurep 'xemacs)
406 (start-itimer "Gamegrid"
413 (run-with-timer period
418 (defun gamegrid-set-timer (delay)
420 (if (fboundp 'set-itimer-restart)
421 (set-itimer-restart gamegrid-timer delay)
422 (timer-set-time gamegrid-timer
423 (list (aref gamegrid-timer 1)
424 (aref gamegrid-timer 2)
425 (aref gamegrid-timer 3))
428 (defun gamegrid-kill-timer ()
430 (if (featurep 'xemacs)
431 (delete-itimer gamegrid-timer)
432 (cancel-timer gamegrid-timer)))
433 (setq gamegrid-timer nil))
435 ;; ;;;;;;;;;;;;;;; high score functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
437 (defun gamegrid-add-score (file score)
438 "Add the current score to the high score file.
440 On POSIX systems there may be a shared game directory for all users in
441 which the scorefiles are kept. On such systems Emacs doesn't create
442 the score file FILE in this directory, if it doesn't already exist. In
443 this case Emacs searches for FILE in the directory specified by
444 `gamegrid-user-score-file-directory' and creates it there, if
447 To add the score file for a game to the system wide shared game
448 directory, create the file with the shell command \"touch\" in this
449 directory and make sure that it is owned by the correct user and
450 group. You probably need special user privileges to do this.
452 On non-POSIX systems Emacs searches for FILE in the directory
453 specified by the variable `temporary-file-directory'. If necessary,
454 FILE is created there."
457 (gamegrid-add-score-insecure file score))
459 (gamegrid-add-score-with-update-game-score file score))))
462 ;; On POSIX systems there are four cases to distinguish:
464 ;; 1. FILE is an absolute filename. Then it should be a file in
465 ;; temporary file directory. This is the way,
466 ;; `gamegrid-add-score' was supposed to be used in the past and
467 ;; is covered here for backward-compatibility.
469 ;; 2. The helper program "update-game-score" is setuid and the
470 ;; file FILE does already exist in a system wide shared game
471 ;; directory. This should be the normal case on POSIX systems,
472 ;; if the game was installed system wide. Use
473 ;; "update-game-score" to add the score to the file in the
474 ;; shared game directory.
476 ;; 3. "update-game-score" is setuid, but the file FILE does *not*
477 ;; exist in the system wide shared game directory. Use
478 ;; `gamegrid-add-score-insecure' to create--if necessary--and
479 ;; update FILE. This is for the case that a user has installed
480 ;; a game on her own.
482 ;; 4. "update-game-score" is not setuid. Use it to create/update
483 ;; FILE in the user's home directory. There is presumably no
484 ;; shared game directory.
486 (defvar gamegrid-shared-game-dir)
488 (defun gamegrid-add-score-with-update-game-score (file score)
489 (let* ((result nil) ;; What is this good for? -- os
490 (gamegrid-shared-game-dir
491 (not (zerop (logand (file-modes
492 (expand-file-name "update-game-score"
495 (cond ((file-name-absolute-p file)
496 (gamegrid-add-score-insecure file score))
497 ((and gamegrid-shared-game-dir
498 (file-exists-p (expand-file-name file shared-game-score-directory)))
499 ;; Use the setuid "update-game-score" program to update a
500 ;; system-wide score file.
501 (gamegrid-add-score-with-update-game-score-1 file
502 (expand-file-name file shared-game-score-directory) score))
503 ;; Else: Add the score to a score file in the user's home
505 (gamegrid-shared-game-dir
506 ;; If `gamegrid-shared-game-dir' is non-nil, then
507 ;; "update-gamescore" program is setuid, so don't use it.
508 (unless (file-exists-p
509 (directory-file-name gamegrid-user-score-file-directory))
510 (make-directory gamegrid-user-score-file-directory t))
511 (gamegrid-add-score-insecure file score
512 gamegrid-user-score-file-directory))
513 (t (let ((f (expand-file-name
514 gamegrid-user-score-file-directory)))
515 (when (file-writable-p f)
516 (unless (eq (car-safe (file-attributes f))
519 (setq f (expand-file-name file f))
520 (unless (file-exists-p f)
521 (write-region "" nil f nil 'silent nil 'excl)))
522 (gamegrid-add-score-with-update-game-score-1 file f score))))))
524 (defun gamegrid-add-score-with-update-game-score-1 (file target score)
525 (let ((default-directory "/")
526 (errbuf (generate-new-buffer " *update-game-score loss*"))
527 (marker-string (concat
530 (cond ((fboundp 'user-mail-address)
532 ((boundp 'user-mail-address)
536 (current-time-string))))
537 ;; This can be called from a timer, so enable local quits.
543 (expand-file-name "update-game-score" exec-directory)
545 "-m" (int-to-string gamegrid-score-file-length)
546 "-d" (if gamegrid-shared-game-dir
547 (expand-file-name shared-game-score-directory)
548 (file-name-directory target))
550 (int-to-string score)
552 (if (buffer-modified-p errbuf)
554 (display-buffer errbuf)
555 (error "Failed to update game score file"))
556 (kill-buffer errbuf))
557 (let ((buf (find-buffer-visiting target)))
561 (switch-to-buffer buf)
562 (revert-buffer nil t nil)
563 (display-buffer buf))
564 (find-file-read-only target))
565 (goto-char (point-min))
566 (search-forward (concat (int-to-string score)
567 " " (user-login-name) " "
569 (beginning-of-line)))))
571 (defun gamegrid-add-score-insecure (file score &optional directory)
573 (setq file (expand-file-name file (or directory
574 temporary-file-directory)))
575 (find-file-other-window file)
576 (setq buffer-read-only nil)
577 (goto-char (point-max))
578 (insert (format "%05d\t%s\t%s <%s>\n"
580 (current-time-string)
582 (cond ((fboundp 'user-mail-address)
584 ((boundp 'user-mail-address)
587 (sort-fields 1 (point-min) (point-max))
588 (reverse-region (point-min) (point-max))
589 (goto-line (1+ gamegrid-score-file-length))
590 (delete-region (point) (point-max))
591 (setq buffer-read-only t)
595 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
599 ;; arch-tag: a96c2ff4-1c12-427e-bd3d-faeaf174cd46
600 ;;; gamegrid.el ends here