(minibuffer-default-add-shell-commands): Fix doc-string typo.
[emacs.git] / lisp / gnus / nndir.el
blobd00ca9e2effd5b47d84b8e616f488b12041c4754
1 ;;; nndir.el --- single directory newsgroup access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
28 (require 'nnheader)
29 (require 'nnmh)
30 (require 'nnml)
31 (require 'nnoo)
32 (eval-when-compile (require 'cl))
34 (nnoo-declare nndir
35 nnml nnmh)
37 (defvoo nndir-directory nil
38 "Where nndir will look for groups."
39 nnml-current-directory nnmh-current-directory)
41 (defvoo nndir-nov-is-evil nil
42 "*Non-nil means that nndir will never retrieve NOV headers."
43 nnml-nov-is-evil)
47 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
48 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
49 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
51 (defvoo nndir-status-string "" nil nnmh-status-string)
52 (defconst nndir-version "nndir 1.0")
56 ;;; Interface functions.
58 (nnoo-define-basics nndir)
60 (deffoo nndir-open-server (server &optional defs)
61 (setq nndir-directory
62 (or (cadr (assq 'nndir-directory defs))
63 server))
64 (unless (assq 'nndir-directory defs)
65 (push `(nndir-directory ,server) defs))
66 (push `(nndir-current-group
67 ,(file-name-nondirectory (directory-file-name nndir-directory)))
68 defs)
69 (push `(nndir-top-directory
70 ,(file-name-directory (directory-file-name nndir-directory)))
71 defs)
72 (nnoo-change-server 'nndir server defs)
73 (let (err)
74 (cond
75 ((not (condition-case arg
76 (file-exists-p nndir-directory)
77 (ftp-error (setq err (format "%s" arg)))))
78 (nndir-close-server)
79 (nnheader-report
80 'nndir (or err "No such file or directory: %s" nndir-directory)))
81 ((not (file-directory-p (file-truename nndir-directory)))
82 (nndir-close-server)
83 (nnheader-report 'nndir "Not a directory: %s" nndir-directory))
85 (nnheader-report 'nndir "Opened server %s using directory %s"
86 server nndir-directory)
87 t))))
89 (nnoo-map-functions nndir
90 (nnml-retrieve-headers 0 nndir-current-group 0 0)
91 (nnml-request-article 0 nndir-current-group 0 0)
92 (nnmh-request-group nndir-current-group 0 0)
93 (nnml-close-group nndir-current-group 0)
94 (nnml-request-list (nnoo-current-server 'nndir) nndir-directory)
95 (nnml-request-newsgroups (nnoo-current-server 'nndir) nndir-directory))
97 (provide 'nndir)
99 ;; arch-tag: 56f09f68-0e4e-4816-818a-df80b4a394c8
100 ;;; nndir.el ends here