cgit.sxemacs.org Git - gnus/blob - lisp/nnoo.el

   1 ;;; nnoo.el --- OO Gnus Backends
   2 ;; Copyright (C) 1996,97 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   5 ;; Keywords: news
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'nnheader)
  29 (eval-when-compile (require 'cl))
  30
  31 (defvar nnoo-definition-alist nil)
  32 (defvar nnoo-state-alist nil)
  33 (defvar nnoo-parent-backend nil)
  34
  35 (defmacro defvoo (var init &optional doc &rest map)
  36   "The same as `defvar', only takes list of variables to MAP to."
  37   `(prog1
  38        ,(if doc
  39             `(defvar ,var ,init ,doc)
  40           `(defvar ,var ,init))
  41      (nnoo-define ',var ',map)))
  42 (put 'defvoo 'lisp-indent-function 2)
  43 (put 'defvoo 'edebug-form-spec '(var init &optional doc &rest map))
  44
  45 (defmacro deffoo (func args &rest forms)
  46   "The same as `defun', only register FUNC."
  47   `(prog1
  48        (defun ,func ,args ,@forms)
  49      (nnoo-register-function ',func)))
  50 (put 'deffoo 'lisp-indent-function 2)
  51 (put 'deffoo 'edebug-form-spec '(&define name lambda-list def-body))
  52
  53 (defun nnoo-register-function (func)
  54   (let ((funcs (nthcdr 3 (assoc (nnoo-backend func)
  55                                 nnoo-definition-alist))))
  56     (unless funcs
  57       (error "%s belongs to a backend that hasn't been declared" func))
  58     (setcar funcs (cons func (car funcs)))))
  59
  60 (defmacro nnoo-declare (backend &rest parents)
  61   `(eval-and-compile
  62      (push (list ',backend
  63                  (mapcar (lambda (p) (list p)) ',parents)
  64                  nil nil)
  65            nnoo-definition-alist)
  66      (push (list ',backend "*internal-non-initialized-backend*")
  67            nnoo-state-alist)))
  68 (put 'nnoo-declare 'lisp-indent-function 1)
  69
  70 (defun nnoo-parents (backend)
  71   (nth 1 (assoc backend nnoo-definition-alist)))
  72
  73 (defun nnoo-variables (backend)
  74   (nth 2 (assoc backend nnoo-definition-alist)))
  75
  76 (defun nnoo-functions (backend)
  77   (nth 3 (assoc backend nnoo-definition-alist)))
  78
  79 (defmacro nnoo-import (backend &rest imports)
  80   `(nnoo-import-1 ',backend ',imports))
  81 (put 'nnoo-import 'lisp-indent-function 1)
  82
  83 (defun nnoo-import-1 (backend imports)
  84   (let ((call-function
  85          (if (symbolp (car imports)) (pop imports) 'nnoo-parent-function))
  86         imp functions function)
  87     (while (setq imp (pop imports))
  88       (setq functions
  89             (or (cdr imp)
  90                 (nnoo-functions (car imp))))
  91       (while functions
  92         (unless (fboundp
  93                  (setq function
  94                        (nnoo-symbol backend
  95                                     (nnoo-rest-symbol (car functions)))))
  96           (eval `(deffoo ,function (&rest args)
  97                    (,call-function ',backend ',(car functions) args))))
  98         (pop functions)))))
  99
 100 (defun nnoo-parent-function (backend function args)
 101   (let ((pbackend (nnoo-backend function))
 102         (nnoo-parent-backend backend))
 103     (nnoo-change-server pbackend
 104                         (nnoo-current-server backend)
 105                         (cdr (assq pbackend (nnoo-parents backend))))
 106     (apply function args)))
 107
 108 (defun nnoo-execute (backend function &rest args)
 109   "Execute FUNCTION on behalf of BACKEND."
 110   (let ((pbackend (nnoo-backend function))
 111         (nnoo-parent-backend backend))
 112     (nnoo-change-server pbackend
 113                         (nnoo-current-server backend)
 114                         (cdr (assq pbackend (nnoo-parents backend))))
 115     (apply function args)))
 116
 117 (defmacro nnoo-map-functions (backend &rest maps)
 118   `(nnoo-map-functions-1 ',backend ',maps))
 119 (put 'nnoo-map-functions 'lisp-indent-function 1)
 120
 121 (defun nnoo-map-functions-1 (backend maps)
 122   (let (m margs i)
 123     (while (setq m (pop maps))
 124       (setq i 0
 125             margs nil)
 126       (while (< i (length (cdr m)))
 127         (if (numberp (nth i (cdr m)))
 128             (push `(nth ,i args) margs)
 129           (push (nth i (cdr m)) margs))
 130         (incf i))
 131       (eval `(deffoo ,(nnoo-symbol backend (nnoo-rest-symbol (car m)))
 132                  (&rest args)
 133                (nnoo-parent-function ',backend ',(car m)
 134                                      ,(cons 'list (nreverse margs))))))))
 135
 136 (defun nnoo-backend (symbol)
 137   (string-match "^[^-]+-" (symbol-name symbol))
 138   (intern (substring (symbol-name symbol) 0 (1- (match-end 0)))))
 139
 140 (defun nnoo-rest-symbol (symbol)
 141   (string-match "^[^-]+-" (symbol-name symbol))
 142   (intern (substring (symbol-name symbol) (match-end 0))))
 143
 144 (defun nnoo-symbol (backend symbol)
 145   (intern (format "%s-%s" backend symbol)))
 146
 147 (defun nnoo-define (var map)
 148   (let* ((backend (nnoo-backend var))
 149          (def (assq backend nnoo-definition-alist))
 150          (parents (nth 1 def)))
 151     (unless def
 152       (error "%s belongs to a backend that hasn't been declared" var))
 153     (setcar (nthcdr 2 def)
 154             (delq (assq var (nth 2 def)) (nth 2 def)))
 155     (setcar (nthcdr 2 def)
 156             (cons (cons var (symbol-value var))
 157                   (nth 2 def)))
 158     (while map
 159       (nconc (assq (nnoo-backend (car map)) parents)
 160              (list (list (pop map) var))))))
 161
 162 (defun nnoo-change-server (backend server defs)
 163   (let* ((bstate (cdr (assq backend nnoo-state-alist)))
 164          (current (car bstate))
 165          (parents (nnoo-parents backend))
 166          (server (if nnoo-parent-backend
 167                      (format "%s+%s" nnoo-parent-backend server)
 168                    server))
 169          (bvariables (nnoo-variables backend))
 170          state def)
 171     ;; If we don't have a current state, we push an empty state
 172     ;; onto the alist.
 173     (unless bstate
 174       (push (setq bstate (list backend nil))
 175             nnoo-state-alist)
 176       (pop bstate))
 177     (if (equal server current)
 178         t
 179       (nnoo-push-server backend current)
 180       (setq state (or (cdr (assoc server (cddr bstate)))
 181                       (nnoo-variables backend)))
 182       (while state
 183         (set (caar state) (cdar state))
 184         (pop state))
 185       (setcar bstate server)
 186       (unless (cdr (assoc server (cddr bstate)))
 187         (while (setq def (pop defs))
 188           (unless (assq (car def) bvariables)
 189             (nconc bvariables
 190                    (list (cons (car def) (and (boundp (car def))
 191                                               (symbol-value (car def)))))))
 192           (set (car def) (cadr def))))
 193       (while parents
 194         (nnoo-change-server
 195          (caar parents) (format "%s+%s" backend server)
 196          (mapcar (lambda (def) (list (car def) (symbol-value (cadr def))))
 197                  (cdar parents)))
 198         (pop parents))))
 199   t)
 200
 201 (defun nnoo-push-server (backend current)
 202   (let ((bstate (assq backend nnoo-state-alist))
 203         (defs (nnoo-variables backend)))
 204     ;; Remove the old definition.
 205     (setcdr (cdr bstate) (delq (assoc current (cddr bstate)) (cddr bstate)))
 206     ;; If this is the first time we push the server (i. e., this is
 207     ;; the nil server), then we update the default values of
 208     ;; all the variables to reflect the current values.
 209     (when (equal current "*internal-non-initialized-backend*")
 210       (let ((defaults (nnoo-variables backend))
 211             def)
 212         (while (setq def (pop defaults))
 213           (setcdr def (symbol-value (car def))))))
 214     (let (state)
 215       (while defs
 216         (push (cons (caar defs) (symbol-value (caar defs)))
 217               state)
 218         (pop defs))
 219       (nconc bstate (list (cons current state))))))
 220
 221 (defsubst nnoo-current-server-p (backend server)
 222   (equal (nnoo-current-server backend) server))
 223
 224 (defun nnoo-current-server (backend)
 225   (nth 1 (assq backend nnoo-state-alist)))
 226
 227 (defun nnoo-close-server (backend &optional server)
 228   (unless server
 229     (setq server (nnoo-current-server backend)))
 230   (when server
 231     (let* ((bstate (cdr (assq backend nnoo-state-alist)))
 232            (defs (assoc server (cdr bstate))))
 233       (when bstate
 234         (setcar bstate nil)
 235         (setcdr bstate (delq defs (cdr bstate)))
 236         (pop defs)
 237         (while defs
 238           (set (car (pop defs)) nil)))))
 239   t)
 240
 241 (defun nnoo-close (backend)
 242   (setq nnoo-state-alist
 243         (delq (assq backend nnoo-state-alist)
 244               nnoo-state-alist))
 245   t)
 246
 247 (defun nnoo-status-message (backend server)
 248   (nnheader-get-report backend))
 249
 250 (defun nnoo-server-opened (backend server)
 251   (and (nnoo-current-server-p backend server)
 252        nntp-server-buffer
 253        (buffer-name nntp-server-buffer)))
 254
 255 (defmacro nnoo-define-basics (backend)
 256   "Define `close-server', `server-opened' and `status-message'."
 257   `(eval-and-compile
 258      (nnoo-define-basics-1 ',backend)))
 259
 260 (defun nnoo-define-basics-1 (backend)
 261   (let ((functions '(close-server server-opened status-message)))
 262     (while functions
 263       (eval `(deffoo ,(nnoo-symbol backend (car functions))
 264                  (&optional server)
 265                (,(nnoo-symbol 'nnoo (pop functions)) ',backend server)))))
 266   (eval `(deffoo ,(nnoo-symbol backend 'open-server)
 267              (server &optional defs)
 268            (nnoo-change-server ',backend server defs))))
 269
 270 (defmacro nnoo-define-skeleton (backend)
 271   "Define all required backend functions for BACKEND.
 272 All functions will return nil and report an error."
 273   `(eval-and-compile
 274      (nnoo-define-skeleton-1 ',backend)))
 275
 276 (defun nnoo-define-skeleton-1 (backend)
 277   (let ((functions '(retrieve-headers
 278                      request-close request-article
 279                      request-group close-group
 280                      request-list request-post request-list-newsgroups))
 281         function fun)
 282     (while (setq function (pop functions))
 283       (when (not (fboundp (setq fun (nnoo-symbol backend function))))
 284         (eval `(deffoo ,fun
 285                    (&rest args)
 286                  (nnheader-report ',backend ,(format "%s-%s not implemented"
 287                                                      backend function))))))))
 288 (provide 'nnoo)
 289
 290 ;;; nnoo.el ends here.