;;
;; Basic code for manipulating game databases
;;
-;; $Revision$
-(defvar chess-database-event-handler nil)
+(require 'chess-message)
-(make-variable-buffer-local 'chess-database-event-handler)
+(defgroup chess-database nil
+ "Generic interface to chess database modules."
+ :group 'chess)
-(defmacro chess-with-current-buffer (buffer &rest body)
- `(let ((buf ,buffer))
- (if buf
- (with-current-buffer buf
- ,@body)
- ,@body)))
+(defcustom chess-database-modules '(chess-scid chess-file)
+ "List of database modules to try when `chess-database-open' is called."
+ :type '(repeat (symbol :tag "Module"))
+ :group 'chess-database)
+
+(defvar chess-database-handler nil)
+
+(make-variable-buffer-local 'chess-database-handler)
(chess-message-catalog 'english
'((no-such-database . "There is no such chess database module '%s'")))
-(defun chess-database-open (module file)
+(defun chess-database-do-open (module file)
"Returns the opened database object, or nil."
(let* ((name (symbol-name module))
- (handler (intern-soft (concat name "-handler")))
- buffer)
+ (handler (intern-soft (concat name "-handler"))))
(unless handler
(chess-error 'no-such-database name))
- (when (setq buffer (funcall handler 'open file))
- (with-current-buffer buffer
- (setq chess-database-event-handler handler)
- (add-hook 'kill-buffer-hook 'chess-database-close nil t)
- (add-hook 'after-revert-hook 'chess-database-rescan nil t)
- (current-buffer)))))
+ (let ((buffer (funcall handler 'open file)))
+ (when buffer
+ (with-current-buffer buffer
+ (setq chess-database-handler handler)
+ (add-hook 'kill-buffer-hook 'chess-database-close nil t)
+ (add-hook 'after-revert-hook 'chess-database-rescan nil t)
+ (current-buffer))))))
+
+(defun chess-database-open (file &optional module)
+ "Returns the opened database object, or nil."
+ (if module
+ (chess-database-do-open module file)
+ (let (result)
+ (setq module chess-database-modules)
+ (while module
+ (if (and (require (car module) nil t)
+ (setq result (chess-database-do-open (car module) file)))
+ (setq module nil)
+ (setq module (cdr module))))
+ result)))
(defsubst chess-database-command (database event &rest args)
- (chess-with-current-buffer database
- (apply 'chess-database-event-handler nil (current-buffer)
- event args)))
+ (with-current-buffer database
+ (apply chess-database-handler event args)))
-(defun chess-database-close (database)
+(defun chess-database-close (&optional database)
(let ((buf (or database (current-buffer))))
(when (buffer-live-p buf)
- (chess-database-command buf 'save)
- (chess-database-command buf 'close)
(with-current-buffer buf
- (remove-hook 'kill-buffer-hook 'chess-database-quit t))
+ (remove-hook 'kill-buffer-hook 'chess-database-close t))
+ (chess-database-save buf)
+ (chess-database-command buf 'close)
(kill-buffer buf))))
(defun chess-database-save (database)
(defun chess-database-count (database)
(chess-database-command database 'count))
+(defun chess-database-read-only-p (database)
+ "Return non-nil if DATABASE is read only."
+ (chess-database-command database 'read-only-p))
+
+(defun chess-database-filename (database)
+ "Return the filename of an already opened DATABASE."
+ (chess-database-command database 'filename))
+
(defun chess-database-read (database index)
+ "Return from DATABASE the chess game object at INDEX."
(chess-database-command database 'read index))
(defun chess-database-write (database game)
(chess-database-command database 'replace game index))
(defun chess-database-query (database &rest terms)
- (chess-database-command database 'query terms))
-
-(defun chess-database-event-handler (game database event &rest args)
- (if (eq event 'shutdown)
- (chess-database-close database)
- (chess-with-current-buffer database
- (apply chess-database-event-handler event args))))
+ "Run a query on DATABASE.
+TERMS is partly dependent on the chess-database module in use.
+chess-scid:
+ tree-search GAME: Perform a tree search on the last position of GAME."
+ (apply 'chess-database-command database 'query terms))
(provide 'chess-database)