-;;; chess.el --- Play chess in Emacs
+;;; chess.el --- Play chess in GNU Emacs
-;; Copyright (C) 2001 John Wiegley <johnw@gnu.org>
+;; Copyright (C) 2001, 2014 Free Software Foundation, Inc.
-;; Emacs Lisp Archive Entry
-;; Filename: chess.el
-;; Version: 2.0
-;; Keywords: games
;; Author: John Wiegley <johnw@gnu.org>
-;; Maintainer: John Wiegley <johnw@gnu.org>
-;; Description: Play chess in Emacs
-;; URL: http://www.gci-net.com/~johnw/Emacs/packages/chess.tar.gz
-;; Compatibility: Emacs20, Emacs21, XEmacs21
+;; Maintainer: Mario Lang <mlang@delysid.org>
+;; Version: 2.0.4
+;; Package-Requires: ((cl-lib "0.5"))
+;; Keywords: games
+;; Compatibility: Emacs24
-;; This file is not part of GNU Emacs.
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
-;; This is free software; you can redistribute it and/or modify it under
-;; the terms of the GNU General Public License as published by the Free
-;; Software Foundation; either version 2, or (at your option) any later
-;; version.
-;;
-;; This is distributed in the hope that it will be useful, but WITHOUT
-;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-;; for more details.
-;;
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-;; MA 02111-1307, USA.
+;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Welcome to Emacs Chess, a chess playing module for GNU Emacs.
;;
-;; This program will not play chess against you; it is not a chess
-;; computer. It can use a chess computer, however, to simulate your
-;; opponent's moves. This is decided when you choose your opponent.
-;; You must, of course, have that chess computer installed. See the
-;; top of chess-player.el for more information.
+;; chess.el is an Emacs Lisp library and several clients on top of the
+;; underlying library functionality for performing various activities
+;; related to the game of chess.
;;
-;; To just get a chessboard up, put the following in your .emacs file:
+;; Type `M-x chess', and play chess against one of the default engine modules.
;;
-;; (add-to-list 'load-list "<the path to Emacs Chess>")
+;; Type `C-u M-x chess' to select a specific engine.
+;; You can play against various external chess computer programs, like
+;; crafty, fruit, glaurung, gnuchess, phalanx, sjeng and stockfish.
+;; There is also an Emacs based chess computer module (ai) which does not
+;; require any external programs. However, the internal AI is not very strong.
;;
-;; (autoload 'chess "chess" "Play a game of chess" t)
+;; To play against another human on a different machine running GNU Emacs,
+;; type `C-u M-x chess RET network RET'.
+;; To play on one of the internet chess servers, type `M-x chess-ics'.
;;
-;; Now you can type `M-x chess', and play chess against anyone else in
-;; the room with you, without having to install anything more.
+;; If you'd like to view or edit Portable Game Notation (PGN) files,
+;; `chess-pgn-mode' provides a text-mode derived mode which can display the
+;; chess position at point.
+;;
+;; To improve your chessaility, `M-x chess-tutorial' provides a simple knight
+;; movement exercise to get you started, and `M-x chess-puzzle' can be used
+;; to solve puzzle collections in EPD or PGN format.
+;;
+;; There are some different types of chessboard display modules available.
+;; * A simple character based display (chess-plain).
+;; * A more verbose ASCII chessboard (chess-ics1).
+;; * A graphical chessboard display which uses images (chess-images).
+;;
+;; The variable `chess-default-display' controls which display modules
+;; are tried when a chessboard should be displayed. By default, chess-images
+;; is tried first. If Emacs is not running in a graphical environment,
+;; chess-ics1 is used instead. To enable the chess-plain display module,
+;; customize `chess-default-display' accordingly.
;;
;; Once this is working, the next thing to do is to customize
-;; `chess-use-modules'. This is a list of functionality modules used
-;; by chess.el to provide its functionality. You can enable or
+;; `chess-default-modules'. This is a list of functionality modules used
+;; by chess.el to provide additional functionality. You can enable or
;; disable modules so that Emacs Chess better suites your tastes.
;; Those modules in turn often have configuration variables, and
;; appropriate documentation at the top of the related file.
;; displays, opponents, analysis programs, etc. See the documentation
;; in chess-module.el to learn more.
;;
-;; There is no documentation for this program other than what exists
-;; in the source files. This is because the source files aim at being
-;; self documenting, and as chess is such a simple game, most chess
-;; players aren't going to need to know much about this program in
-;; particular.
-;;
-;; However, most people will probably be interested in reading the top
+;; Most people will probably also be interested in reading the top
;; of chess-display.el and chess-pgn.el, which describe the user
;; interface commands available in each of those buffer types.
(require 'chess-game)
(require 'chess-display)
(require 'chess-engine)
-(require 'chess-pgn)
(defgroup chess nil
"An Emacs chess playing program."
- :group 'games)
+ :group 'games
+ :link '(custom-manual "(chess)Top"))
-(defconst chess-version "2.0a8"
+(defconst chess-version "2.0.4"
"The version of the Emacs chess program.")
-(defcustom chess-default-display (if (display-graphic-p)
- 'chess-images 'chess-ics1)
- "Default module set to be used when starting a chess session."
- :type 'sexp
+(defcustom chess-default-display
+ '(chess-images chess-ics1 chess-plain)
+ "Default display to be used when starting a chess session.
+A list indicates a series of alternatives if the first display is
+not available."
+ :type '(choice symbol (repeat symbol))
:group 'chess)
-(defcustom chess-default-engine 'chess-gnuchess
- "Default engine to be used when starting a chess session."
- :type 'sexp
+(defcustom chess-default-modules
+ '((chess-sound chess-announce)
+ ;;chess-autosave ml (2014-06-06): module not fully working
+ chess-clock
+ ;;chess-kibitz jww (2002-04-30): not fully supported yet
+ ;;chess-chat
+ )
+ "Modules to be used when starting a chess session.
+A sublist indicates a series of alternatives, if the first is not
+available.
+These can do just about anything."
+ :type '(repeat (choice symbol (repeat symbol)))
:group 'chess)
-(defcustom chess-announce-moves t
- "If non-nil, announce when your opponent makes a move.
-This variable can also be a symbol which names a different announcing
-module to use. This happens verbally if 'festival' is installed, or
-if you have sound files installed and a sound play (see
-chess-sound.el). Otherwise it just prints a message in your
-minibuffer, which works well for Emacspeak users."
- :type 'boolean
+(defcustom chess-default-engine
+ '(chess-crafty
+ chess-stockfish chess-glaurung chess-fruit
+ chess-gnuchess chess-phalanx
+ chess-ai)
+ "Default engine to be used when starting a chess session.
+A list indicates a series of alternatives if the first engine is not
+available."
+ :type '(choice symbol (repeat symbol))
:group 'chess)
(defcustom chess-full-name (user-full-name)
:type 'string
:group 'chess)
+(and (fboundp 'font-lock-add-keywords)
+ (font-lock-add-keywords
+ 'emacs-lisp-mode
+ '(("(\\(chess-error\\)\\>" 1 font-lock-warning-face)
+ ("(\\(chess-with-current-buffer\\)\\>" 1 font-lock-keyword-face))))
+
+(defun chess--create-display (module game my-color disable-popup)
+ (let ((display (chess-display-create game module my-color)))
+ (when display
+ (chess-game-set-data game 'my-color my-color)
+ (if disable-popup
+ (chess-display-disable-popup display))
+ display)))
+
+(defun chess--create-engine (module game response-handler ctor-args)
+ (let ((engine (apply 'chess-engine-create module game
+ response-handler ctor-args)))
+ (when engine
+ ;; for the sake of engines which are ready to play now, and
+ ;; which don't need connect/accept negotiation (most
+ ;; computerized engines fall into this category), we need to
+ ;; let them know we're ready to begin
+ (chess-engine-command engine 'ready)
+ engine)))
+
+(defun chess-create-modules (module-list create-func &rest args)
+ "Create modules from MODULE-LIST with CREATE-FUNC and ARGS.
+If an element of MODULE-LIST is a sublist, treat it as alternatives."
+ (let (objects)
+ (dolist (module module-list)
+ (let (object)
+ (if (symbolp module)
+ (if (setq object (apply create-func module args))
+ (push object objects))
+ ;; this module is actually a list, which means keep trying
+ ;; until we find one that works
+ (while module
+ (if (setq object (condition-case nil
+ (apply create-func (car module) args)
+ (error nil)))
+ (progn
+ (push object objects)
+ (setq module nil))
+ (setq module (cdr module)))))))
+ (nreverse objects)))
+
(chess-message-catalog 'english
- '((no-images-fallback . "Could not find suitable chess images; using ics1 display")))
+ '((no-engines-found
+ . "Could not find any chess engines to play against; install gnuchess!")))
;;;###autoload
(defun chess (&optional engine disable-popup engine-response-handler
&rest engine-ctor-args)
- "Start a game of chess, playing against ENGINE (a module name)."
+ "Start a game of chess, playing against ENGINE (a module name).
+With prefix argument, prompt for the engine to play against.
+Otherwise use `chess-default-engine' to determine the engine."
(interactive
(list
(if current-prefix-arg
"none"))))
chess-default-engine)))
- (require chess-default-display)
- (let* ((my-color t) ; we start out as white always
- (game (chess-game-create))
- (display (chess-display-create game chess-default-display
- my-color)))
-
- (when (and (eq chess-default-display 'chess-images)
- (with-current-buffer display
- (null chess-images-size)))
- (chess-message 'no-images-fallback)
- (chess-display-destroy display)
- (require 'chess-ics1)
- (setq display (chess-display-create game 'chess-ics1 my-color)))
-
- (chess-game-set-data game 'my-color my-color)
- (if disable-popup
- (chess-display-disable-popup display))
- (chess-display-set-main display)
-
- (let ((engine-module (or engine chess-default-engine)))
- (when (and engine-module (require engine-module nil t))
- (let ((engine (apply 'chess-engine-create game engine-module nil
- engine-ctor-args)))
- ;; for the sake of engines which are ready to play now, and
- ;; which don't need connect/accept negotiation (most
- ;; computerized engines fall into this category), we need to
- ;; let them know we're ready to begin
- (chess-engine-command engine 'ready))
-
- (when (and (not (eq engine-module 'chess-none))
- chess-announce-moves)
- (if (and (not (eq chess-announce-moves t))
- (symbolp chess-announce-moves))
- (let ((name (symbol-name chess-announce-moves)))
- (require chess-announce-moves)
- (if (funcall (intern (concat name "-available-p")))
- (funcall (intern (concat name "-for-game")) game)))
- (require 'chess-sound)
- (if (chess-sound-available-p)
- (chess-sound-for-game game)
- (require 'chess-announce)
- (if (chess-announce-available-p)
- (chess-announce-for-game game)))))))
-
- (chess-display-update display t)
-
- (cons display engine)))
+ (let ((game (chess-game-create))
+ (my-color t) ; we start out as white always
+ objects)
+
+ ;; all these odd calls are so that `objects' ends up looking like:
+ ;; (ENGINE FIRST-DISPLAY...)
+
+ (setq objects (chess-create-modules (list chess-default-display)
+ 'chess--create-display
+ game my-color disable-popup))
+ (when (car objects)
+ (mapc 'chess-display-update objects)
+ (chess-module-set-leader (car objects))
+ (unless disable-popup
+ (chess-display-popup (car objects))))
+
+ (nconc objects (chess-create-modules chess-default-modules
+ 'chess-module-create game))
+
+ (push (unless (eq engine 'none)
+ (car ;(condition-case nil
+ (chess-create-modules (list (or engine chess-default-engine))
+ 'chess--create-engine game
+ engine-response-handler
+ engine-ctor-args)
+ ; (error nil))
+ ))
+ objects)
+ (unless (car objects)
+ (chess-message 'no-engines-found))
+
+ objects))
+
+;;;###autoload
(defalias 'chess-session 'chess)
;;;###autoload
-(defun chess-read-pgn (&optional file)
- "Read and display a PGN game after point."
- (interactive "P")
- (if (or file (not (search-forward "[Event" nil t)))
- (setq file (read-file-name "Read a PGN game from file: ")))
- (if file
- (find-file file))
- (let ((game (chess-pgn-to-game)))
- (when game
- (require chess-default-display)
- (chess-display-create game chess-default-display
- (chess-game-side-to-move game)))))
-
-(defvar chess-puzzle-locations nil)
-
-(defun chess-puzzle-next ()
- "Play the next puzzle in the collection, selected randomly."
- (interactive)
- (if chess-puzzle-locations
- (chess-puzzle (aref chess-puzzle-locations 0))))
+(define-key menu-bar-games-menu [chess] '(menu-item "Chess" chess :help "Play Chess"))
;;;###autoload
-(defun chess-puzzle (file)
- "Pick a random puzzle from FILE, and solve it against the default engine.
-The spacebar in the display buffer is bound to `chess-puzzle-next',
-making it easy to go on to the next puzzle once you've solved one."
- (interactive "fRead chess puzzles from: ")
- (save-excursion
- (with-current-buffer (find-file-noselect file)
- (when (or (null chess-puzzle-locations)
- (not (equal file (aref chess-puzzle-locations 0))))
- (let (locations)
- (goto-char (point-min))
- (while (search-forward "[Event" nil t)
- (push (point) locations))
- (setq chess-puzzle-locations (vector file locations nil nil)))
- (random t))
- (goto-char (nth (random (length (aref chess-puzzle-locations 1)))
- (aref chess-puzzle-locations 1)))
- (let ((game (chess-pgn-to-game)))
- (when game
- (require chess-default-display)
- (let (puzzle-display)
- (if (buffer-live-p (aref chess-puzzle-locations 2))
- (progn
- (setq puzzle-display (aref chess-puzzle-locations 2))
- (chess-display-set-game puzzle-display game))
- (setq puzzle-display
- (chess-display-create game chess-default-display
- (chess-game-side-to-move game))))
- (aset chess-puzzle-locations 2 puzzle-display)
- ;; setup spacebar as a convenient way to jump to the next puzzle
- (with-current-buffer puzzle-display
- (define-key (current-local-map) [? ] 'chess-puzzle-next)))
- (require chess-default-engine)
- (aset chess-puzzle-locations 3
- (or (and (buffer-live-p (aref chess-puzzle-locations 3))
- (aref chess-puzzle-locations 3))
- (chess-engine-create game chess-default-engine))))))))
+(defun chess-create-display (perspective &optional modules-too)
+ "Create a display, letting the user's customization decide the style.
+If MODULES-TOO is non-nil, also create and associate the modules
+listed in `chess-default-modules'."
+ (if modules-too
+ (let ((display (cadr (chess-session 'none))))
+ (chess-display-set-perspective* display perspective))
+ (car (chess-create-modules (list chess-default-display)
+ 'chess--create-display
+ (chess-game-create) perspective nil))))
(provide 'chess)