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

   1 ;;; nnheader.el --- header access macros for Gnus and its backends
   2 ;; Copyright (C) 1987,88,89,90,93,94,95 Free Software Foundation, Inc.
   3
   4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   5 ;;      Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23
  24 ;;; Commentary:
  25
  26 ;; These macros may look very much like the ones in GNUS 4.1. They
  27 ;; are, in a way, but you should note that the indices they use have
  28 ;; been changed from the internal GNUS format to the NOV format. Makes
  29 ;; it possible to read headers from XOVER much faster.
  30 ;;
  31 ;; The format of a header is now:
  32 ;; [number subject from date id references chars lines xref]
  33 ;;
  34 ;; (That last entry is defined as "misc" in the NOV format, but Gnus
  35 ;; uses it for xrefs.)
  36
  37 ;;; Code:
  38
  39 (defalias 'nntp-header-number 'header-number)
  40 (defmacro header-number (header)
  41   "Return article number in HEADER."
  42   (` (aref (, header) 0)))
  43
  44 (defalias 'nntp-set-header-number 'header-set-number)
  45 (defmacro header-set-number (header number)
  46   "Set article number of HEADER to NUMBER."
  47   (` (aset (, header) 0 (, number))))
  48
  49 (defalias 'nntp-header-subject 'header-subject)
  50 (defmacro header-subject (header)
  51   "Return subject string in HEADER."
  52   (` (aref (, header) 1)))
  53
  54 (defalias 'nntp-set-header-subject 'header-set-subject)
  55 (defmacro header-set-subject (header subject)
  56   "Set article subject of HEADER to SUBJECT."
  57   (` (aset (, header) 1 (, subject))))
  58
  59 (defalias 'nntp-header-from 'header-from)
  60 (defmacro header-from (header)
  61   "Return author string in HEADER."
  62   (` (aref (, header) 2)))
  63
  64 (defalias 'nntp-set-header-from 'header-set-from)
  65 (defmacro header-set-from (header from)
  66   "Set article author of HEADER to FROM."
  67   (` (aset (, header) 2 (, from))))
  68
  69 (defalias 'nntp-header-xref 'header-xref)
  70 (defmacro header-xref (header)
  71   "Return xref string in HEADER."
  72   (` (aref (, header) 8)))
  73
  74 (defalias 'nntp-set-header-xref 'header-set-xref)
  75 (defmacro header-set-xref (header xref)
  76   "Set article xref of HEADER to xref."
  77   (` (aset (, header) 8 (, xref))))
  78
  79 (defalias 'nntp-header-lines 'header-lines)
  80 (defmacro header-lines (header)
  81   "Return lines in HEADER."
  82   (` (aref (, header) 7)))
  83
  84 (defalias 'nntp-set-header-lines 'header-set-lines)
  85 (defmacro header-set-lines (header lines)
  86   "Set article lines of HEADER to LINES."
  87   (` (aset (, header) 7 (, lines))))
  88
  89 (defalias 'nntp-header-date 'header-date)
  90 (defmacro header-date (header)
  91   "Return date in HEADER."
  92   (` (aref (, header) 3)))
  93
  94 (defalias 'nntp-set-header-date 'header-set-date)
  95 (defmacro header-set-date (header date)
  96   "Set article date of HEADER to DATE."
  97   (` (aset (, header) 3 (, date))))
  98
  99 (defalias 'nntp-header-id 'header-id)
 100 (defmacro header-id (header)
 101   "Return Id in HEADER."
 102   (` (aref (, header) 4)))
 103
 104 (defalias 'nntp-set-header-id 'header-set-id)
 105 (defmacro header-set-id (header id)
 106   "Set article Id of HEADER to ID."
 107   (` (aset (, header) 4 (, id))))
 108
 109 (defalias 'nntp-header-references 'header-references)
 110 (defmacro header-references (header)
 111   "Return references in HEADER."
 112   (` (aref (, header) 5)))
 113
 114 (defalias 'nntp-set-header-references 'header-set-references)
 115 (defmacro header-set-references (header ref)
 116   "Set article references of HEADER to REF."
 117   (` (aset (, header) 5 (, ref))))
 118
 119 (defalias 'nntp-header-chars 'header-chars)
 120 (defmacro header-chars (header)
 121   "Return number of chars of article in HEADER."
 122   (` (aref (, header) 6)))
 123
 124 (defalias 'nntp-set-header-chars 'header-set-chars)
 125 (defmacro header-set-chars (header chars)
 126   "Set number of chars in article of HEADER to CHARS."
 127   (` (aset (, header) 6 (, chars))))
 128
 129 ;; Various cruft the backends and Gnus need to communicate.
 130
 131 (defvar nntp-server-buffer nil)
 132 (defvar gnus-verbose-backends t
 133   "*If non-nil, Gnus backends will generate lots of comments.")
 134 (defvar gnus-nov-is-evil nil
 135   "If non-nil, Gnus backends will never output headers in the NOV format.")
 136 (defvar news-reply-yank-from nil)
 137 (defvar news-reply-yank-message-id nil)
 138
 139 ;; All backends use this function, so I moved it to this file.
 140
 141 (defun nnheader-init-server-buffer ()
 142   (save-excursion
 143     (setq nntp-server-buffer (get-buffer-create " *nntpd*"))
 144     (set-buffer nntp-server-buffer)
 145     (buffer-disable-undo (current-buffer))
 146     (erase-buffer)
 147     (kill-all-local-variables)
 148     (setq case-fold-search t)           ;Should ignore case.
 149     t))
 150
 151 (defun nnheader-set-init-variables (server defs)
 152   (let ((s server)
 153         val)
 154     ;; First we set the server variables in the sequence required.  We
 155     ;; use the definitions from the `defs' list where that is
 156     ;; possible.
 157     (while s
 158       (set (car (car s))
 159            (if (setq val (assq (car (car s)) defs))
 160                (nth 1 val)
 161              (nth 1 (car s))))
 162       (setq s (cdr s)))
 163     ;; The we go through the defs list and set any variables that were
 164     ;; not set in the first sweep.
 165     (while defs
 166       (if (not (assq (car (car defs)) server))
 167           (set (car (car defs))
 168                (if (and (symbolp (nth 1 (car defs)))
 169                         (not (boundp (nth 1 (car defs)))))
 170                    (nth 1 (car defs))
 171                  (eval (nth 1 (car defs))))))
 172       (setq defs (cdr defs)))))
 173
 174 (defun nnheader-save-variables (server)
 175   (let (out)
 176     (while server
 177       (setq out (cons (list (car (car server))
 178                             (symbol-value (car (car server))))
 179                       out))
 180       (setq server (cdr server)))
 181     (nreverse out)))
 182
 183 (defun nnheader-restore-variables (state)
 184   (while state
 185     (set (car (car state)) (nth 1 (car state)))
 186     (setq state (cdr state))))
 187
 188 ;; Read the head of an article.
 189 (defun nnheader-insert-head (file)
 190   (let ((beg 0)
 191         (chop 1024))
 192     (while (and (eq chop (nth 1 (insert-file-contents
 193                                  file nil beg (setq beg (+ chop beg)))))
 194                 (prog1 (not (search-backward "\n\n" nil t))
 195                   (goto-char (point-max)))))))
 196
 197 (defun nnheader-article-p ()
 198   (goto-char (point-min))
 199   (if (not (search-forward "\n\n" nil t))
 200       nil
 201     (narrow-to-region (point-min) (1- (point)))
 202     (goto-char (point-min))
 203     (while (looking-at "[A-Z][^ \t]+:.*\n\\([ \t].*\n\\)*\\|From .*\n")
 204       (goto-char (match-end 0)))
 205     (prog1
 206         (eobp)
 207       (widen))))
 208
 209 (defun nnheader-find-file-noselect (file)
 210   "Basically does the same as `find-file-noselect', but avoids that function."
 211   (save-excursion
 212     (or
 213      (get-file-buffer file)
 214      (prog1
 215          (set-buffer (get-buffer-create (create-file-buffer file)))
 216        (and (file-exists-p file)
 217             (not (file-directory-p file))
 218             (insert-file-contents file))
 219        (set-visited-file-name file)
 220        (set-buffer-modified-p nil)))))
 221
 222 (provide 'nnheader)
 223
 224 ;;; nnheader.el ends here