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

   1 ;;; gnus-ems.el --- functions for making Gnus work under different Emacsen
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile
  29   (require 'cl)
  30   (require 'ring))
  31
  32 ;;; Function aliases later to be redefined for XEmacs usage.
  33
  34 (defvar gnus-mouse-2 [mouse-2])
  35 (defvar gnus-down-mouse-3 [down-mouse-3])
  36 (defvar gnus-down-mouse-2 [down-mouse-2])
  37 (defvar gnus-widget-button-keymap nil)
  38 (defvar gnus-mode-line-modified
  39   (if (featurep 'xemacs)
  40       '("--**-" . "-----")
  41     '("**" "--")))
  42
  43 (eval-and-compile
  44   (autoload 'gnus-xmas-define "gnus-xmas")
  45   (autoload 'gnus-xmas-redefine "gnus-xmas"))
  46
  47 (autoload 'gnus-get-buffer-create "gnus")
  48 (autoload 'nnheader-find-etc-directory "nnheader")
  49 (autoload 'smiley-region "smiley")
  50
  51 (defun gnus-kill-all-overlays ()
  52   "Delete all overlays in the current buffer."
  53   (let* ((overlayss (overlay-lists))
  54          (buffer-read-only nil)
  55          (overlays (delq nil (nconc (car overlayss) (cdr overlayss)))))
  56     (while overlays
  57       (delete-overlay (pop overlays)))))
  58
  59 ;;; Mule functions.
  60
  61 (defun gnus-mule-max-width-function (el max-width)
  62   `(let* ((val (eval (, el)))
  63           (valstr (if (numberp val)
  64                       (int-to-string val) val)))
  65      (if (> (length valstr) ,max-width)
  66          (truncate-string-to-width valstr ,max-width)
  67        valstr)))
  68
  69 (eval-and-compile
  70   (if (featurep 'xemacs)
  71       (gnus-xmas-define)
  72     (defvar gnus-mouse-face-prop 'mouse-face
  73       "Property used for highlighting mouse regions.")))
  74
  75 (defvar gnus-tmp-unread)
  76 (defvar gnus-tmp-replied)
  77 (defvar gnus-tmp-score-char)
  78 (defvar gnus-tmp-indentation)
  79 (defvar gnus-tmp-opening-bracket)
  80 (defvar gnus-tmp-lines)
  81 (defvar gnus-tmp-name)
  82 (defvar gnus-tmp-closing-bracket)
  83 (defvar gnus-tmp-subject-or-nil)
  84 (defvar gnus-check-before-posting)
  85 (defvar gnus-mouse-face)
  86 (defvar gnus-group-buffer)
  87
  88 (defun gnus-ems-redefine ()
  89   (cond
  90    ((featurep 'xemacs)
  91     (gnus-xmas-redefine))
  92
  93    ((featurep 'mule)
  94     ;; Mule and new Emacs definitions
  95
  96     ;; [Note] Now there are three kinds of mule implementations,
  97     ;; original MULE, XEmacs/mule and Emacs 20+ including
  98     ;; MULE features.  Unfortunately these APIs are different.  In
  99     ;; particular, Emacs (including original Mule) and XEmacs are
 100     ;; quite different.  However, this version of Gnus doesn't support
 101     ;; anything other than XEmacs 20+ and Emacs 20.3+.
 102
 103     ;; Predicates to check are following:
 104     ;; (boundp 'MULE) is t only if Mule (original; anything older than
 105     ;;                     Mule 2.3) is running.
 106     ;; (featurep 'mule) is t when other mule variants are running.
 107
 108     ;; It is possible to detect XEmacs/mule by (featurep 'mule) and
 109     ;; (featurep 'xemacs).  In this case, the implementation for
 110     ;; XEmacs/mule may be shareable between XEmacs and XEmacs/mule.
 111
 112     (defvar gnus-summary-display-table nil
 113       "Display table used in summary mode buffers.")
 114     (defalias 'gnus-max-width-function 'gnus-mule-max-width-function)
 115
 116     (when (boundp 'gnus-check-before-posting)
 117       (setq gnus-check-before-posting
 118             (delq 'long-lines
 119                   (delq 'control-chars gnus-check-before-posting))))
 120
 121     (defun gnus-summary-line-format-spec ()
 122       (insert gnus-tmp-unread gnus-tmp-replied
 123               gnus-tmp-score-char gnus-tmp-indentation)
 124       (put-text-property
 125        (point)
 126        (progn
 127          (insert
 128           gnus-tmp-opening-bracket
 129           (format "%4d: %-20s"
 130                   gnus-tmp-lines
 131                   (if (> (length gnus-tmp-name) 20)
 132                       (truncate-string-to-width gnus-tmp-name 20)
 133                     gnus-tmp-name))
 134           gnus-tmp-closing-bracket)
 135          (point))
 136        gnus-mouse-face-prop gnus-mouse-face)
 137       (insert " " gnus-tmp-subject-or-nil "\n")))))
 138
 139 ;; Clone of `appt-select-lowest-window' in appt.el.
 140 (defun gnus-select-lowest-window ()
 141 "Select the lowest window on the frame."
 142   (let ((lowest-window (selected-window))
 143         (bottom-edge (nth 3 (window-edges))))
 144     (walk-windows (lambda (w)
 145                     (let ((next-bottom-edge (nth 3 (window-edges w))))
 146                       (when (< bottom-edge next-bottom-edge)
 147                         (setq bottom-edge next-bottom-edge
 148                               lowest-window w)))))
 149     (select-window lowest-window)))
 150
 151 (defun gnus-region-active-p ()
 152   "Say whether the region is active."
 153   (and (boundp 'transient-mark-mode)
 154        transient-mark-mode
 155        (boundp 'mark-active)
 156        mark-active))
 157
 158 (defun gnus-mark-active-p ()
 159   "Non-nil means the mark and region are currently active in this buffer."
 160   mark-active) ; aliased to region-exists-p in XEmacs.
 161
 162 (autoload 'gnus-alive-p "gnus-util")
 163 (autoload 'mm-disable-multibyte "mm-util")
 164
 165 (defun gnus-x-splash ()
 166   "Show a splash screen using a pixmap in the current buffer."
 167   (interactive)
 168   (unless window-system
 169     (error "`gnus-x-splash' requires running on the window system"))
 170   (switch-to-buffer (gnus-get-buffer-create (if (or (gnus-alive-p)
 171                                                     (interactive-p))
 172                                                 "*gnus-x-splash*"
 173                                               gnus-group-buffer)))
 174   (let ((inhibit-read-only t)
 175         (file (nnheader-find-etc-directory "images/gnus/x-splash" t))
 176         pixmap fcw fch width height fringes sbars left yoffset top ls)
 177     (erase-buffer)
 178     (sit-for 0) ;; Necessary for measuring the window size correctly.
 179     (when (and file
 180                (ignore-errors
 181                 (let ((coding-system-for-read 'raw-text))
 182                   (with-temp-buffer
 183                     (mm-disable-multibyte)
 184                     (insert-file-contents file)
 185                     (goto-char (point-min))
 186                     (setq pixmap (read (current-buffer)))))))
 187       (setq fcw (float (frame-char-width))
 188             fch (float (frame-char-height))
 189             width (/ (car pixmap) fcw)
 190             height (/ (cadr pixmap) fch)
 191             fringes (if (fboundp 'window-fringes)
 192                         (eval '(window-fringes))
 193                       '(10 11 nil))
 194             sbars (frame-parameter nil 'vertical-scroll-bars))
 195       (cond ((eq sbars 'right)
 196              (setq sbars
 197                    (cons 0 (/ (or (frame-parameter nil 'scroll-bar-width) 14)
 198                               fcw))))
 199             (sbars
 200              (setq sbars
 201                    (cons (/ (or (frame-parameter nil 'scroll-bar-width) 14)
 202                             fcw)
 203                          0)))
 204             (t
 205              (setq sbars '(0 . 0))))
 206       (setq left (- (* (round (/ (1- (/ (+ (window-width)
 207                                            (car sbars) (cdr sbars)
 208                                            (/ (+ (or (car fringes) 0)
 209                                                  (or (cadr fringes) 0))
 210                                               fcw))
 211                                         width))
 212                                  2))
 213                        width)
 214                     (car sbars)
 215                     (/ (or (car fringes) 0) fcw))
 216             yoffset (cadr (window-edges))
 217             top (max 0 (- (* (max (if (and (boundp 'tool-bar-mode)
 218                                            tool-bar-mode
 219                                            (not (featurep 'gtk))
 220                                            (eq (frame-first-window)
 221                                                (selected-window)))
 222                                       1 0)
 223                                   (round (/ (1- (/ (+ (1- (window-height))
 224                                                       (* 2 yoffset))
 225                                                    height))
 226                                             2)))
 227                              height)
 228                           yoffset))
 229             ls (/ (or line-spacing 0) fch)
 230             height (max 0 (- height ls)))
 231       (cond ((>= (- top ls) 1)
 232              (insert
 233               (propertize
 234                " "
 235                'display `(space :width 0 :ascent 100))
 236               "\n"
 237               (propertize
 238                " "
 239                'display `(space :width 0 :height ,(- top ls 1) :ascent 100))
 240               "\n"))
 241             ((> (- top ls) 0)
 242              (insert
 243               (propertize
 244                " "
 245                'display `(space :width 0 :height ,(- top ls) :ascent 100))
 246               "\n")))
 247       (if (and (> width 0) (> left 0))
 248           (insert (propertize
 249                    " "
 250                    'display `(space :width ,left :height ,height :ascent 0)))
 251         (setq width (+ width left)))
 252       (when (> width 0)
 253         (insert (propertize
 254                  " "
 255                  'display `(space :width ,width :height ,height :ascent 0)
 256                  'face `(gnus-splash :stipple ,pixmap))))
 257       (goto-char (if (<= (- top ls) 0) (1- (point)) (point-min)))
 258       (redraw-frame (selected-frame))
 259       (sit-for 0))))
 260
 261 ;;; Image functions.
 262
 263 (defun gnus-image-type-available-p (type)
 264   (and (fboundp 'image-type-available-p)
 265        (image-type-available-p type)
 266        (if (fboundp 'display-images-p)
 267            (display-images-p)
 268          t)))
 269
 270 (defun gnus-create-image (file &optional type data-p &rest props)
 271   (let ((face (plist-get props :face)))
 272     (when face
 273       (setq props (plist-put props :foreground (face-foreground face)))
 274       (setq props (plist-put props :background (face-background face))))
 275     (ignore-errors
 276       (apply 'create-image file type data-p props))))
 277
 278 (defun gnus-put-image (glyph &optional string category)
 279   (let ((point (point)))
 280     (insert-image glyph (or string "*"))
 281     (put-text-property point (point) 'gnus-image-category category)
 282     (unless string
 283       (put-text-property (1- (point)) (point)
 284                          'gnus-image-text-deletable t))
 285     glyph))
 286
 287 (defun gnus-remove-image (image &optional category)
 288   "Remove the image matching IMAGE and CATEGORY found first."
 289   (let ((start (point-min))
 290         val end)
 291     (while (and (not end)
 292                 (or (setq val (get-text-property start 'display))
 293                     (and (setq start
 294                                (next-single-property-change start 'display))
 295                          (setq val (get-text-property start 'display)))))
 296       (setq end (or (next-single-property-change start 'display)
 297                     (point-max)))
 298       (if (and (equal val image)
 299                (equal (get-text-property start 'gnus-image-category)
 300                       category))
 301           (progn
 302             (put-text-property start end 'display nil)
 303             (when (get-text-property start 'gnus-image-text-deletable)
 304               (delete-region start end)))
 305         (unless (= end (point-max))
 306           (setq start end
 307                 end nil))))))
 308
 309 (eval-and-compile
 310   (if (fboundp 'set-process-plist)
 311       (progn
 312         (defalias 'gnus-set-process-plist 'set-process-plist)
 313         (defalias 'gnus-process-plist 'process-plist)
 314         (defalias 'gnus-process-get 'process-get)
 315         (defalias 'gnus-process-put 'process-put))
 316     (defun gnus-set-process-plist (process plist)
 317       "Replace the plist of PROCESS with PLIST.  Returns PLIST."
 318       (put 'gnus-process-plist-internal process plist))
 319
 320     (defun gnus-process-plist (process)
 321       "Return the plist of PROCESS."
 322       ;; This form works but can't prevent the plist data from
 323       ;; growing infinitely.
 324       ;;(get 'gnus-process-plist-internal process)
 325       (let* ((plist (symbol-plist 'gnus-process-plist-internal))
 326              (tem (memq process plist)))
 327         (prog1
 328             (cadr tem)
 329           ;; Remove it from the plist data.
 330           (when tem
 331             (if (eq plist tem)
 332                 (progn
 333                   (setcar plist (caddr plist))
 334                   (setcdr plist (or (cdddr plist) '(nil))))
 335               (setcdr (nthcdr (- (length plist) (length tem) 1) plist)
 336                       (cddr tem)))))))
 337
 338     (defun gnus-process-get (process propname)
 339       "Return the value of PROCESS' PROPNAME property.
 340 This is the last value stored with `(gnus-process-put PROCESS PROPNAME VALUE)'."
 341       (plist-get (gnus-process-plist process) propname))
 342
 343     (defun gnus-process-put (process propname value)
 344       "Change PROCESS' PROPNAME property to VALUE.
 345 It can be retrieved with `(gnus-process-get PROCESS PROPNAME)'."
 346       (gnus-set-process-plist process
 347                               (plist-put (gnus-process-plist process)
 348                                          propname value)))))
 349
 350 (provide 'gnus-ems)
 351
 352 ;;; gnus-ems.el ends here