;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; Maintain a chess game that is being played or viewed
;;
;; $Revision$

;;; Commentary:

;; A chess game is represented by a set of tags that describe the
;; game, and a list of plies representing the main variation.

(require 'chess-ply)
(require 'chess-algebraic)
(require 'chess-fen)

(defvar chess-illegal nil)
(put 'chess-illegal 'error-conditions '(error))

(defconst chess-game-default-tags
  `(("Event"	   . "Computer chess game")
    ("Round"	   . "-")
    ("Site"	   . ,(system-name))
    ("White"	   . "?")
    ("Black"	   . "?")
    ("Result"	   . "*")
    ("TimeControl" . "-")))

(defsubst chess-game-hooks (game)
  "Return the tags alist associated with GAME."
  (car game))

(defsubst chess-game-set-hooks (game hooks)
  "Return the tags alist associated with GAME."
  (setcar game hooks))

(defun chess-game-add-hook (game function &optional data prepend)
  "Return the tags alist associated with GAME."
  (let ((hooks (chess-game-hooks game)))
    (if (null hooks)
	(chess-game-set-hooks game (list (cons function data)))
      (if prepend
	  (chess-game-set-hooks game (cons (cons function data) hooks))
	(nconc hooks (list (cons function data)))))))

(defsubst chess-game-remove-hook (game function)
  "Return the tags alist associated with GAME."
  (chess-game-set-hooks game (assq-delete-all function
					      (chess-game-hooks game))))

(defsubst chess-game-run-hooks (game &rest args)
  "Return the tags alist associated with GAME."
  (dolist (hook (chess-game-hooks game))
    (apply (car hook) game (cdr hook) args)))


(defsubst chess-game-search-function (game)
  "Return the tags alist associated with GAME."
  (cadr game))

(defsubst chess-game-set-search-function (game func)
  "Return the tags alist associated with GAME."
  (setcar (cdr game) func)
  (chess-game-run-hooks game 'rule-change))


(defsubst chess-game-tags (game)
  "Return the tags alist associated with GAME."
  (nth 2 game))

(defsubst chess-game-set-tags (game tags)
  "Return the tags alist associated with GAME."
  (setcar (nthcdr 2 game) tags)
  (chess-game-run-hooks game 'set-tags))

(defsubst chess-game-tag (game tag)
  "Return the value for TAG in GAME."
  (let ((tags (chess-game-tags game)))
    (and tags (cdr (assoc tag tags)))))

(defun chess-game-set-tag (game tag value)
  "Set a TAG for GAME to VALUE."
  (let ((tags (chess-game-tags game)))
    (if (null tags)
	(chess-game-set-tags game (list (cons tag value)))
      (let ((entry (assoc tag tags)))
	(if entry
	    (setcdr entry value)
	  (nconc tags (list (cons tag value)))))))
  (chess-game-run-hooks game 'set-tag tag))

(defsubst chess-game-del-tag (game tag)
  "Set a TAG for GAME to VALUE."
  (chess-game-set-tags game (assq-delete-all tag (chess-game-tags game)))
  (chess-game-run-hooks game 'delete-tag tag))


(defsubst chess-game-plies (game)
  "Return the tags alist associated with GAME."
  (nth 3 game))

(defsubst chess-game-set-plies (game plies)
  "Return the tags alist associated with GAME."
  (setcdr (nthcdr 2 game) plies)
  (chess-game-run-hooks game 'set-plies))

(defsubst chess-game-index (game)
  "Return the GAME's current position index."
  (1- (length (chess-game-plies game))))

(defsubst chess-game-seq (game)
  "Return the current GAME sequence."
  (1+ (/ (chess-game-index game) 2)))

(defsubst chess-game-side-to-move (game)
  (chess-pos-side-to-move (chess-game-pos game)))

(defun chess-game-ply (game &optional index)
  "Return the position related to GAME's INDEX position."
  (if index
      (nth index (chess-game-plies game))
    (car (last (chess-game-plies game)))))

(defun chess-game-add-ply (game ply)
  "Return the position related to GAME's INDEX position."
  (let ((plies (chess-game-plies game)))
    (if plies
	(nconc plies (list ply))
      (chess-game-set-plies game (list ply)))))

(defsubst chess-game-pos (game &optional index)
  "Return the position related to GAME's INDEX position."
  (car (chess-game-ply game index)))


(defun chess-game-create (&optional position search-func tags)
  "Create a new chess game object.
Optionally use the given starting POSITION (which is recorded using
the game's FEN tag).
SEARCH-FUNC specifies the function used to test the legality of moves.
TAGS is the starting set of game tags (which can always be changed
later using the various tag-related methods)."
  (let ((game
	 (list nil
	       (or search-func 'chess-standard-search-position)
	       tags
	       (list (chess-ply-create (or position
					   (chess-pos-create)))))))
    (dolist (tag (cons (cons "Date" (format-time-string "%Y.%m.%d"))
		       chess-game-default-tags))
      (unless (chess-game-tag game (car tag))
	(chess-game-set-tag game (car tag) (cdr tag))))
    game))

(defun chess-game-move (game ply)
  "Make a move in the current GAME, from FROM to TO.
This creates a new position and adds it to the main variation.
The 'changes' of the last ply reflect whether the game is currently in
progress (nil), if it is drawn, resigned, mate, etc."
  (let ((current-ply (chess-game-ply game))
	(changes (chess-ply-changes ply))
	(position (chess-ply-pos ply)))
    (unless (equal position (chess-ply-pos current-ply))
      (error "Positions do not match"))
    (unless (funcall (chess-game-search-function game)
		     position (cadr (chess-ply-changes ply))
		     (chess-pos-piece position (car (chess-ply-changes ply))))
      (signal 'chess-illegal "Illegal move"))
    (chess-ply-set-changes current-ply changes)
    (cond
     ((or (memq ':draw changes)
	  (memq ':perpetual changes)
	  (memq ':repetition changes)
	  (memq ':stalemate changes))
      (chess-game-set-tag game "Result" "1/2-1/2"))
     ((or (memq ':resign changes)
	  (memq ':checkmate changes))
      (chess-game-set-tag game "Result" (if (chess-game-side-to-move game)
					    "0-1" "1-0")))
     (t
      (chess-game-add-ply game (chess-ply-create
				(chess-ply-next-pos current-ply)))
      (chess-game-run-hooks game 'move current-ply)))))

;; A few convenience functions

(defsubst chess-game-legal-plies (game)
  "Return all legal plies from GAME's current position."
  (chess-legal-plies (chess-game-pos game)
		     (chess-game-search-function game)))

(defsubst chess-game-algebraic-to-ply (game move)
  (chess-algebraic-to-ply (chess-game-pos game) move
			  (chess-game-search-function game)))

(defsubst chess-game-ply-to-algebraic (game &optional ply long)
  (chess-ply-to-algebraic (or ply (chess-game-ply game)) long
			  (chess-game-search-function game)))

(provide 'chess-game)

;;; chess-game.el ends here