1 ;;; gamegrid.el --- library for implementing grid-based games on Emacs
3 ;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 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 (defun gamegrid-setup-default-font ()
310 (intern (concat "gamegrid-face-" (buffer-name)))))
311 (when (eq gamegrid-display-mode 'glyph)
312 (let ((max-height nil))
313 (loop for c from 0 to 255 do
314 (let ((glyph (aref gamegrid-display-table c)))
315 (when (and (listp glyph) (eq (car glyph) 'image))
316 (let ((height (cdr (image-size glyph))))
317 (if (or (null max-height)
318 (< max-height height))
319 (setq max-height height))))))
320 (when (and max-height (< max-height 1))
321 (let ((default-font-height (face-attribute 'default :height))
322 (resy (/ (display-pixel-height) (/ (display-mm-height) 25.4)))
323 point-size pixel-size)
324 (setq point-size (/ (* (float default-font-height) max-height) 10)
325 pixel-size (floor (* resy (/ point-size 72.27)))
326 point-size (* (/ pixel-size resy) 72.27))
327 (face-spec-set gamegrid-face
328 `((t :height ,(floor (* point-size 10))))))))))
330 (defun gamegrid-initialize-display ()
331 (setq gamegrid-display-mode (gamegrid-display-type))
332 (setq gamegrid-display-table (make-display-table))
333 (setq gamegrid-face-table (make-vector 256 nil))
334 (loop for c from 0 to 255 do
335 (let* ((spec (aref gamegrid-display-options c))
336 (glyph (gamegrid-make-glyph (car spec) (caddr spec)))
337 (face (gamegrid-make-face (cadr spec) (caddr spec))))
338 (aset gamegrid-face-table c face)
339 (aset gamegrid-display-table c glyph)))
340 (gamegrid-setup-default-font)
341 (gamegrid-set-display-table)
342 (setq cursor-type nil))
345 (defun gamegrid-set-face (c)
346 (if (eq gamegrid-display-mode 'glyph)
347 (add-text-properties (1- (point)) (point)
348 (list 'display (list (aref gamegrid-display-table c))))
349 (put-text-property (1- (point))
352 (aref gamegrid-face-table c))))
354 (defun gamegrid-cell-offset (x y)
355 (+ gamegrid-buffer-start
356 (* (1+ gamegrid-buffer-width) y)
359 ;; ;;;;;;;;;;;;;;;; grid functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
361 (defun gamegrid-get-cell (x y)
362 (char-after (gamegrid-cell-offset x y)))
364 (defun gamegrid-set-cell (x y c)
366 (let ((buffer-read-only nil))
367 (goto-char (gamegrid-cell-offset x y))
370 (gamegrid-set-face c))))
372 (defun gamegrid-init-buffer (width height blank)
373 (setq gamegrid-buffer-width width
374 gamegrid-buffer-height height)
376 (make-string width blank)
378 (buffer-read-only nil))
380 (setq gamegrid-buffer-start (point))
383 ;; Adjust the height of the default face to the height of the
384 ;; images. Unlike XEmacs, Emacs doesn't allow to make the default
385 ;; face buffer-local; so we do this with an overlay.
386 (when (eq gamegrid-display-mode 'glyph)
387 (overlay-put (make-overlay (point-min) (point-max))
388 'face gamegrid-face))
389 (goto-char (point-min))))
391 (defun gamegrid-init (options)
392 (setq buffer-read-only t
395 gamegrid-display-options options)
396 (buffer-disable-undo (current-buffer))
397 (gamegrid-initialize-display))
399 ;; ;;;;;;;;;;;;;;;; timer functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
401 (defun gamegrid-start-timer (period func)
403 (if (featurep 'xemacs)
404 (start-itimer "Gamegrid"
411 (run-with-timer period
416 (defun gamegrid-set-timer (delay)
418 (if (fboundp 'set-itimer-restart)
419 (set-itimer-restart gamegrid-timer delay)
420 (timer-set-time gamegrid-timer
421 (list (aref gamegrid-timer 1)
422 (aref gamegrid-timer 2)
423 (aref gamegrid-timer 3))
426 (defun gamegrid-kill-timer ()
428 (if (featurep 'xemacs)
429 (delete-itimer gamegrid-timer)
430 (cancel-timer gamegrid-timer)))
431 (setq gamegrid-timer nil))
433 ;; ;;;;;;;;;;;;;;; high score functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
435 (defun gamegrid-add-score (file score)
436 "Add the current score to the high score file.
438 On POSIX systems there may be a shared game directory for all users in
439 which the scorefiles are kept. On such systems Emacs doesn't create
440 the score file FILE in this directory, if it doesn't already exist. In
441 this case Emacs searches for FILE in the directory specified by
442 `gamegrid-user-score-file-directory' and creates it there, if
445 To add the score file for a game to the system wide shared game
446 directory, create the file with the shell command \"touch\" in this
447 directory and make sure that it is owned by the correct user and
448 group. You probably need special user privileges to do this.
450 On non-POSIX systems Emacs searches for FILE in the directory
451 specified by the variable `temporary-file-directory'. If necessary,
452 FILE is created there."
455 (gamegrid-add-score-insecure file score))
457 (gamegrid-add-score-with-update-game-score file score))))
460 ;; On POSIX systems there are four cases to distinguish:
462 ;; 1. FILE is an absolute filename. Then it should be a file in
463 ;; temporary file directory. This is the way,
464 ;; `gamegrid-add-score' was supposed to be used in the past and
465 ;; is covered here for backward-compatibility.
467 ;; 2. The helper program "update-game-score" is setuid and the
468 ;; file FILE does already exist in a system wide shared game
469 ;; directory. This should be the normal case on POSIX systems,
470 ;; if the game was installed system wide. Use
471 ;; "update-game-score" to add the score to the file in the
472 ;; shared game directory.
474 ;; 3. "update-game-score" is setuid, but the file FILE does *not*
475 ;; exist in the system wide shared game directory. Use
476 ;; `gamegrid-add-score-insecure' to create--if necessary--and
477 ;; update FILE. This is for the case that a user has installed
478 ;; a game on her own.
480 ;; 4. "update-game-score" is not setuid. Use it to create/update
481 ;; FILE in the user's home directory. There is presumably no
482 ;; shared game directory.
484 (defvar gamegrid-shared-game-dir)
486 (defun gamegrid-add-score-with-update-game-score (file score)
487 (let* ((result nil) ;; What is this good for? -- os
488 (gamegrid-shared-game-dir
489 (not (zerop (logand (file-modes
490 (expand-file-name "update-game-score"
493 (cond ((file-name-absolute-p file)
494 (gamegrid-add-score-insecure file score))
495 ((and gamegrid-shared-game-dir
496 (file-exists-p (expand-file-name file shared-game-score-directory)))
497 ;; Use the setuid "update-game-score" program to update a
498 ;; system-wide score file.
499 (gamegrid-add-score-with-update-game-score-1 file
500 (expand-file-name file shared-game-score-directory) score))
501 ;; Else: Add the score to a score file in the user's home
503 (gamegrid-shared-game-dir
504 ;; If `gamegrid-shared-game-dir' is non-nil, then
505 ;; "update-gamescore" program is setuid, so don't use it.
506 (unless (file-exists-p
507 (directory-file-name gamegrid-user-score-file-directory))
508 (make-directory gamegrid-user-score-file-directory t))
509 (gamegrid-add-score-insecure file score
510 gamegrid-user-score-file-directory))
511 (t (let ((f (expand-file-name
512 gamegrid-user-score-file-directory)))
513 (when (file-writable-p f)
514 (unless (eq (car-safe (file-attributes f))
517 (setq f (expand-file-name file f))
518 (unless (file-exists-p f)
519 (write-region "" nil f nil 'silent nil 'excl)))
520 (gamegrid-add-score-with-update-game-score-1 file f score))))))
522 (defun gamegrid-add-score-with-update-game-score-1 (file target score)
523 (let ((default-directory "/")
524 (errbuf (generate-new-buffer " *update-game-score loss*"))
525 (marker-string (concat
528 (cond ((fboundp 'user-mail-address)
530 ((boundp 'user-mail-address)
534 (current-time-string))))
535 ;; This can be called from a timer, so enable local quits.
541 (expand-file-name "update-game-score" exec-directory)
543 "-m" (int-to-string gamegrid-score-file-length)
544 "-d" (if gamegrid-shared-game-dir
545 (expand-file-name shared-game-score-directory)
546 (file-name-directory target))
548 (int-to-string score)
550 (if (buffer-modified-p errbuf)
552 (display-buffer errbuf)
553 (error "Failed to update game score file"))
554 (kill-buffer errbuf))
555 (let ((buf (find-buffer-visiting target)))
559 (switch-to-buffer buf)
560 (revert-buffer nil t nil)
561 (display-buffer buf))
562 (find-file-read-only target))
563 (goto-char (point-min))
564 (search-forward (concat (int-to-string score)
565 " " (user-login-name) " "
567 (beginning-of-line)))))
569 (defun gamegrid-add-score-insecure (file score &optional directory)
571 (setq file (expand-file-name file (or directory
572 temporary-file-directory)))
573 (find-file-other-window file)
574 (setq buffer-read-only nil)
575 (goto-char (point-max))
576 (insert (format "%05d\t%s\t%s <%s>\n"
578 (current-time-string)
580 (cond ((fboundp 'user-mail-address)
582 ((boundp 'user-mail-address)
585 (sort-fields 1 (point-min) (point-max))
586 (reverse-region (point-min) (point-max))
587 (goto-line (1+ gamegrid-score-file-length))
588 (delete-region (point) (point-max))
589 (setq buffer-read-only t)
593 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
597 ;; arch-tag: a96c2ff4-1c12-427e-bd3d-faeaf174cd46
598 ;;; gamegrid.el ends here