lisp/net/newst-plainview.el

   1 ;;; newst-plainview.el --- Single buffer frontend for newsticker.
   2
   3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author:      Ulf Jasper <ulf.jasper@web.de>
   7 ;; Filename:    newst-plainview.el
   8 ;; URL:         http://www.nongnu.org/newsticker
   9 ;; Time-stamp:  "6. Dezember 2009, 19:17:02 (ulf)"
  10 ;; Package:     newsticker
  11
  12 ;; ======================================================================
  13
  14 ;; This file is part of GNU Emacs.
  15
  16 ;; GNU Emacs is free software: you can redistribute it and/or modify
  17 ;; it under the terms of the GNU General Public License as published by
  18 ;; the Free Software Foundation, either version 3 of the License, or
  19 ;; (at your option) any later version.
  20
  21 ;; GNU Emacs is distributed in the hope that it will be useful,
  22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 ;; GNU General Public License for more details.
  25
  26 ;; You should have received a copy of the GNU General Public License
  27 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  28
  29 ;; ======================================================================
  30 ;;; Commentary:
  31
  32 ;; See newsticker.el
  33
  34 ;; ======================================================================
  35 ;;; Code:
  36
  37 (require 'newst-ticker)
  38 (require 'newst-reader)
  39 (require 'derived)
  40 (require 'xml)
  41
  42 ;; Silence warnings
  43 (defvar w3-mode-map)
  44 (defvar w3m-minor-mode-map)
  45
  46 ;; ======================================================================
  47 ;;; Customization
  48 ;; ======================================================================
  49 (defgroup newsticker-plainview nil
  50   "Settings for the simple plain view reader.
  51 See also `newsticker-plainview-hooks'."
  52   :group 'newsticker-reader)
  53
  54
  55 (defun newsticker--set-customvar-buffer (symbol value)
  56   "Set newsticker-variable SYMBOL value to VALUE.
  57 Calls all actions which are necessary in order to make the new
  58 value effective."
  59   (if (or (not (boundp symbol))
  60           (equal (symbol-value symbol) value))
  61       (set symbol value)
  62     ;; something must have changed
  63     (set symbol value)
  64     (newsticker--buffer-set-uptodate nil)))
  65
  66 (defun newsticker--set-customvar-sorting (symbol value)
  67   "Set newsticker-variable SYMBOL value to VALUE.
  68 Calls all actions which are necessary in order to make the new
  69 value effective."
  70   (if (or (not (boundp symbol))
  71           (equal (symbol-value symbol) value))
  72       (set symbol value)
  73     ;; something must have changed
  74     (set symbol value)
  75     (message "Applying new sort method...")
  76     (when (fboundp 'newsticker--cache-sort) (newsticker--cache-sort))
  77     (when (fboundp 'newsticker--buffer-set-uptodate)
  78       (newsticker--buffer-set-uptodate nil))
  79     (message "Applying new sort method...done")))
  80
  81 (defcustom newsticker-sort-method
  82   'sort-by-original-order
  83   "Sort method for news items.
  84 The following sort methods are available:
  85 * `sort-by-original-order' keeps the order in which the items
  86   appear in the headline file (please note that for immortal items,
  87   which have been removed from the news feed, there is no original
  88   order),
  89 * `sort-by-time' looks at the time at which an item has been seen
  90   the first time.  The most recent item is put at top,
  91 * `sort-by-title' will put the items in an alphabetical order."
  92   :type '(choice
  93           (const :tag "Keep original order" sort-by-original-order)
  94           (const :tag "Sort by time"        sort-by-time)
  95           (const :tag "Sort by title"       sort-by-title))
  96   :set 'newsticker--set-customvar-sorting
  97   :group 'newsticker-plainview)
  98
  99 (defcustom newsticker-heading-format
 100   "%l
 101 %t %d %s"
 102   "Format string for feed headings.
 103 The following printf-like specifiers can be used:
 104 %d  The date the feed was retrieved.  See `newsticker-date-format'.
 105 %l  The logo (image) of the feed.  Most news feeds provide a small
 106     image as logo.  Newsticker can display them, if Emacs can --
 107     see `image-types' for a list of supported image types.
 108 %L  The logo (image) of the feed.  If the logo is not available
 109     the title of the feed is used.
 110 %s  The statistical data of the feed.  See `newsticker-statistics-format'.
 111 %t  The title of the feed, i.e. its name."
 112   :type 'string
 113   :set 'newsticker--set-customvar-formatting
 114   :group 'newsticker-plainview)
 115
 116 (defcustom newsticker-item-format
 117   "%t %d"
 118   "Format string for news item headlines.
 119 The following printf-like specifiers can be used:
 120 %d  The date the item was (first) retrieved.  See `newsticker-date-format'.
 121 %l  The logo (image) of the feed.  Most news feeds provide a small
 122     image as logo.  Newsticker can display them, if Emacs can --
 123     see `image-types' for a list of supported image types.
 124 %L  The logo (image) of the feed.  If the logo is not available
 125     the title of the feed is used.
 126 %t  The title of the item."
 127   :type 'string
 128   :set 'newsticker--set-customvar-formatting
 129   :group 'newsticker-plainview)
 130
 131 (defcustom newsticker-desc-format
 132   "%d %c"
 133   "Format string for news descriptions (contents).
 134 The following printf-like specifiers can be used:
 135 %c  The contents (description) of the item.
 136 %d  The date the item was (first) retrieved.  See
 137     `newsticker-date-format'."
 138   :type 'string
 139   :set 'newsticker--set-customvar-formatting
 140   :group 'newsticker-plainview)
 141
 142 (defcustom newsticker-statistics-format
 143   "[%n + %i + %o + %O = %a]"
 144   "Format for the statistics part in feed lines.
 145 The following printf-like specifiers can be used:
 146 %a  The number of all items in the feed.
 147 %i  The number of immortal items in the feed.
 148 %n  The number of new items in the feed.
 149 %o  The number of old items in the feed.
 150 %O  The number of obsolete items in the feed."
 151   :type 'string
 152   :set 'newsticker--set-customvar-formatting
 153   :group 'newsticker-plainview)
 154
 155
 156 ;; ======================================================================
 157 ;; faces
 158
 159 (defface newsticker-new-item-face
 160   '((((class color) (background dark))
 161      (:family "helvetica" :bold t))
 162     (((class color) (background light))
 163      (:family "helvetica" :bold t)))
 164   "Face for new news items."
 165   :group 'newsticker-faces)
 166
 167 (defface newsticker-old-item-face
 168   '((((class color) (background dark))
 169      (:family "helvetica" :bold t :foreground "orange3"))
 170     (((class color) (background light))
 171      (:family "helvetica" :bold t :foreground "red4")))
 172   "Face for old news items."
 173   :group 'newsticker-faces)
 174
 175 (defface newsticker-immortal-item-face
 176   '((((class color) (background dark))
 177      (:family "helvetica" :bold t :italic t :foreground "orange"))
 178     (((class color) (background light))
 179      (:family "helvetica" :bold t :italic t :foreground "blue")))
 180   "Face for immortal news items."
 181   :group 'newsticker-faces)
 182
 183 (defface newsticker-obsolete-item-face
 184   '((((class color) (background dark))
 185      (:family "helvetica" :bold t :strike-through t))
 186     (((class color) (background light))
 187      (:family "helvetica" :bold t :strike-through t)))
 188   "Face for old news items."
 189   :group 'newsticker-faces)
 190
 191 (defface newsticker-date-face
 192   '((((class color) (background dark))
 193      (:family "helvetica" :italic t :height 0.8))
 194     (((class color) (background light))
 195      (:family "helvetica" :italic t :height 0.8)))
 196   "Face for newsticker dates."
 197   :group 'newsticker-faces)
 198
 199 (defface newsticker-statistics-face
 200   '((((class color) (background dark))
 201      (:family "helvetica" :italic t :height 0.8))
 202     (((class color) (background light))
 203      (:family "helvetica" :italic t :height 0.8)))
 204   "Face for newsticker dates."
 205   :group 'newsticker-faces)
 206
 207 (defface newsticker-default-face
 208   '((((class color) (background dark))
 209      (:inherit default))
 210     (((class color) (background light))
 211      (:inherit default)))
 212   "Face for the description of news items."
 213   ;;:set 'newsticker--set-customvar
 214   :group 'newsticker-faces)
 215
 216 (defcustom newsticker-hide-old-items-in-newsticker-buffer
 217   nil
 218   "Decides whether to automatically hide old items in the *newsticker* buffer.
 219 If set to t old items will be completely folded and only new
 220 items will show up in the *newsticker* buffer.  Otherwise old as
 221 well as new items will be visible."
 222   :type 'boolean
 223   :set 'newsticker--set-customvar-buffer
 224   :group 'newsticker-plainview)
 225
 226 (defcustom newsticker-show-descriptions-of-new-items
 227   t
 228   "Whether to automatically show descriptions of new items in *newsticker*.
 229 If set to t old items will be folded and new items will be
 230 unfolded.  Otherwise old as well as new items will be folded."
 231   :type 'boolean
 232   :set 'newsticker--set-customvar-buffer
 233   :group 'newsticker-plainview)
 234
 235 (defcustom newsticker-show-all-news-elements
 236   nil
 237   "Show all news elements."
 238   :type 'boolean
 239   ;;:set 'newsticker--set-customvar
 240   :group 'newsticker-plainview)
 241
 242 ;; ======================================================================
 243 ;; hooks
 244 (defgroup newsticker-plainview-hooks nil
 245   "Settings for newsticker hooks which apply to plainview only."
 246   :group 'newsticker-hooks)
 247
 248 (defcustom newsticker-select-item-hook
 249   'newsticker--buffer-make-item-completely-visible
 250   "List of functions run after a headline has been selected.
 251 Each function is called after one of `newsticker-next-item',
 252 `newsticker-next-new-item', `newsticker-previous-item',
 253 `newsticker-previous-new-item' has been called.
 254
 255 The default value 'newsticker--buffer-make-item-completely-visible
 256 assures that the current item is always completely visible."
 257   :type 'hook
 258   :options '(newsticker--buffer-make-item-completely-visible)
 259   :group 'newsticker-plainview-hooks)
 260
 261 (defcustom newsticker-select-feed-hook
 262   'newsticker--buffer-make-item-completely-visible
 263   "List of functions run after a feed has been selected.
 264 Each function is called after one of `newsticker-next-feed', and
 265 `newsticker-previous-feed' has been called.
 266
 267 The default value 'newsticker--buffer-make-item-completely-visible
 268 assures that the current feed is completely visible."
 269   :type 'hook
 270   :options '(newsticker--buffer-make-item-completely-visible)
 271   :group 'newsticker-plainview-hooks)
 272
 273 (defcustom newsticker-buffer-change-hook
 274   'newsticker-w3m-show-inline-images
 275   "List of functions run after the newsticker buffer has been updated.
 276 Each function is called after `newsticker-buffer-update' has been called.
 277
 278 The default value '`newsticker-w3m-show-inline-images' loads inline
 279 images."
 280   :type 'hook
 281   :group 'newsticker-plainview-hooks)
 282
 283 (defcustom newsticker-narrow-hook
 284   'newsticker-w3m-show-inline-images
 285   "List of functions run after narrowing in newsticker buffer has changed.
 286 Each function is called after
 287 `newsticker-toggle-auto-narrow-to-feed' or
 288 `newsticker-toggle-auto-narrow-to-item' has been called.
 289
 290 The default value '`newsticker-w3m-show-inline-images' loads inline
 291 images."
 292   :type 'hook
 293   :group 'newsticker-plainview-hooks)
 294
 295 ;; ======================================================================
 296 ;;; Toolbar
 297 ;; ======================================================================
 298
 299 (defvar newsticker--plainview-tool-bar-map
 300   (if (featurep 'xemacs)
 301       nil
 302     (if (boundp 'tool-bar-map)
 303         (let ((tool-bar-map (make-sparse-keymap)))
 304           (define-key tool-bar-map [newsticker-sep-1]
 305             (list 'menu-item "--double-line"))
 306           (define-key tool-bar-map [newsticker-browse-url]
 307             (list 'menu-item "newsticker-browse-url" 'newsticker-browse-url
 308                   :visible t
 309                   :help "Browse URL for item at point"
 310                   :image newsticker--browse-image))
 311           (define-key tool-bar-map [newsticker-buffer-force-update]
 312             (list 'menu-item "newsticker-buffer-force-update"
 313                   'newsticker-buffer-force-update
 314                   :visible t
 315                   :help "Update newsticker buffer"
 316                   :image newsticker--update-image
 317                   :enable '(not newsticker--buffer-uptodate-p)))
 318           (define-key tool-bar-map [newsticker-get-all-news]
 319             (list 'menu-item "newsticker-get-all-news" 'newsticker-get-all-news
 320                   :visible t
 321                   :help "Get news for all feeds"
 322                   :image newsticker--get-all-image))
 323           (define-key tool-bar-map [newsticker-mark-item-at-point-as-read]
 324             (list 'menu-item "newsticker-mark-item-at-point-as-read"
 325                   'newsticker-mark-item-at-point-as-read
 326                   :visible t
 327                   :image newsticker--mark-read-image
 328                   :help "Mark current item as read"
 329                   :enable '(newsticker-item-not-old-p)))
 330           (define-key tool-bar-map [newsticker-mark-item-at-point-as-immortal]
 331             (list 'menu-item "newsticker-mark-item-at-point-as-immortal"
 332                   'newsticker-mark-item-at-point-as-immortal
 333                   :visible t
 334                   :image newsticker--mark-immortal-image
 335                   :help "Mark current item as immortal"
 336                   :enable '(newsticker-item-not-immortal-p)))
 337           (define-key tool-bar-map [newsticker-toggle-auto-narrow-to-feed]
 338             (list 'menu-item "newsticker-toggle-auto-narrow-to-feed"
 339                   'newsticker-toggle-auto-narrow-to-feed
 340                   :visible t
 341                   :help "Toggle visibility of other feeds"
 342                   :image newsticker--narrow-image))
 343           (define-key tool-bar-map [newsticker-next-feed]
 344             (list 'menu-item "newsticker-next-feed" 'newsticker-next-feed
 345                   :visible t
 346                   :help "Go to next feed"
 347                   :image newsticker--next-feed-image
 348                   :enable '(newsticker-next-feed-available-p)))
 349           (define-key tool-bar-map [newsticker-next-item]
 350             (list 'menu-item "newsticker-next-item" 'newsticker-next-item
 351                   :visible t
 352                   :help "Go to next item"
 353                   :image newsticker--next-item-image
 354                   :enable '(newsticker-next-item-available-p)))
 355           (define-key tool-bar-map [newsticker-previous-item]
 356             (list 'menu-item "newsticker-previous-item" 'newsticker-previous-item
 357                   :visible t
 358                   :help "Go to previous item"
 359                   :image newsticker--previous-item-image
 360                   :enable '(newsticker-previous-item-available-p)))
 361           (define-key tool-bar-map [newsticker-previous-feed]
 362             (list 'menu-item "newsticker-previous-feed" 'newsticker-previous-feed
 363                   :visible t
 364                   :help "Go to previous feed"
 365                   :image newsticker--previous-feed-image
 366                   :enable '(newsticker-previous-feed-available-p)))
 367           ;; standard icons / actions
 368           (tool-bar-add-item "close"
 369                              'newsticker-close-buffer
 370                              'newsticker-close-buffer
 371                              :help "Close newsticker buffer")
 372           (tool-bar-add-item "preferences"
 373                              'newsticker-customize
 374                              'newsticker-customize
 375                              :help "Customize newsticker")
 376           tool-bar-map))))
 377
 378 ;; ======================================================================
 379 ;;; Newsticker mode
 380 ;; ======================================================================
 381
 382 (define-derived-mode newsticker-mode fundamental-mode
 383   "NewsTicker"
 384   "Viewing news feeds in Emacs."
 385   (if (boundp 'tool-bar-map)
 386       (set (make-local-variable 'tool-bar-map)
 387            newsticker--plainview-tool-bar-map))
 388   (set (make-local-variable 'imenu-sort-function) nil)
 389   (set (make-local-variable 'scroll-conservatively) 999)
 390   (setq imenu-create-index-function 'newsticker--imenu-create-index)
 391   (setq imenu-default-goto-function 'newsticker--imenu-goto)
 392   (setq buffer-read-only t)
 393   (auto-fill-mode -1) ;; turn auto-fill off!
 394   (font-lock-mode -1) ;; turn off font-lock!!
 395   (set (make-local-variable 'font-lock-defaults) nil)
 396   (set (make-local-variable 'line-move-ignore-invisible) t)
 397   (setq mode-line-format
 398         (list "-"
 399               'mode-line-mule-info
 400               'mode-line-modified
 401               'mode-line-frame-identification
 402               " Newsticker ("
 403               '(newsticker--buffer-uptodate-p
 404                 "up to date"
 405                 "NEED UPDATE")
 406               ") "
 407               '(:eval (format "[%d]" (length newsticker--process-ids)))
 408               " -- "
 409               '(:eval (newsticker--buffer-get-feed-title-at-point))
 410               ": "
 411               '(:eval (newsticker--buffer-get-item-title-at-point))
 412               " %-"))
 413   (add-to-invisibility-spec 't)
 414   (unless newsticker-show-all-news-elements
 415     (add-to-invisibility-spec 'extra))
 416   (newsticker--buffer-set-uptodate nil))
 417
 418 ;; refine its mode-map
 419 (define-key newsticker-mode-map "sO" 'newsticker-show-old-items)
 420 (define-key newsticker-mode-map "hO" 'newsticker-hide-old-items)
 421 (define-key newsticker-mode-map "sa" 'newsticker-show-all-desc)
 422 (define-key newsticker-mode-map "ha" 'newsticker-hide-all-desc)
 423 (define-key newsticker-mode-map "sf" 'newsticker-show-feed-desc)
 424 (define-key newsticker-mode-map "hf" 'newsticker-hide-feed-desc)
 425 (define-key newsticker-mode-map "so" 'newsticker-show-old-item-desc)
 426 (define-key newsticker-mode-map "ho" 'newsticker-hide-old-item-desc)
 427 (define-key newsticker-mode-map "sn" 'newsticker-show-new-item-desc)
 428 (define-key newsticker-mode-map "hn" 'newsticker-hide-new-item-desc)
 429 (define-key newsticker-mode-map "se" 'newsticker-show-entry)
 430 (define-key newsticker-mode-map "he" 'newsticker-hide-entry)
 431 (define-key newsticker-mode-map "sx" 'newsticker-show-extra)
 432 (define-key newsticker-mode-map "hx" 'newsticker-hide-extra)
 433
 434 (define-key newsticker-mode-map " "  'scroll-up)
 435 (define-key newsticker-mode-map "q"  'newsticker-close-buffer)
 436 (define-key newsticker-mode-map "p"  'newsticker-previous-item)
 437 (define-key newsticker-mode-map "P"  'newsticker-previous-new-item)
 438 (define-key newsticker-mode-map "F"  'newsticker-previous-feed)
 439 (define-key newsticker-mode-map "\t" 'newsticker-next-item)
 440 (define-key newsticker-mode-map "n"  'newsticker-next-item)
 441 (define-key newsticker-mode-map "N"  'newsticker-next-new-item)
 442 (define-key newsticker-mode-map "f"  'newsticker-next-feed)
 443 (define-key newsticker-mode-map "M"  'newsticker-mark-all-items-as-read)
 444 (define-key newsticker-mode-map "m"
 445   'newsticker-mark-all-items-at-point-as-read-and-redraw)
 446 (define-key newsticker-mode-map "o"
 447   'newsticker-mark-item-at-point-as-read)
 448 (define-key newsticker-mode-map "O"
 449   'newsticker-mark-all-items-at-point-as-read)
 450 (define-key newsticker-mode-map "G"  'newsticker-get-all-news)
 451 (define-key newsticker-mode-map "g"  'newsticker-get-news-at-point)
 452 (define-key newsticker-mode-map "u"  'newsticker-buffer-update)
 453 (define-key newsticker-mode-map "U"  'newsticker-buffer-force-update)
 454 (define-key newsticker-mode-map "a"  'newsticker-add-url)
 455
 456 (define-key newsticker-mode-map "i"
 457   'newsticker-mark-item-at-point-as-immortal)
 458
 459 (define-key newsticker-mode-map "xf"
 460   'newsticker-toggle-auto-narrow-to-feed)
 461 (define-key newsticker-mode-map "xi"
 462   'newsticker-toggle-auto-narrow-to-item)
 463
 464 ;; maps for the clickable portions
 465 (defvar newsticker--url-keymap (make-sparse-keymap)
 466   "Key map for click-able headings in the newsticker buffer.")
 467 (define-key newsticker--url-keymap [mouse-1]
 468   'newsticker-mouse-browse-url)
 469 (define-key newsticker--url-keymap [mouse-2]
 470   'newsticker-mouse-browse-url)
 471 (define-key newsticker--url-keymap "\n"
 472   'newsticker-browse-url)
 473 (define-key newsticker--url-keymap "\C-m"
 474   'newsticker-browse-url)
 475 (define-key newsticker--url-keymap [(control return)]
 476   'newsticker-handle-url)
 477
 478 ;; newsticker menu
 479 (defvar newsticker-menu (make-sparse-keymap "Newsticker"))
 480
 481 (define-key newsticker-menu [newsticker-browse-url]
 482   '("Browse URL for item at point" . newsticker-browse-url))
 483 (define-key newsticker-menu [newsticker-separator-1]
 484   '("--"))
 485 (define-key newsticker-menu [newsticker-buffer-update]
 486   '("Update buffer" . newsticker-buffer-update))
 487 (define-key newsticker-menu [newsticker-separator-2]
 488   '("--"))
 489 (define-key newsticker-menu [newsticker-get-all-news]
 490   '("Get news from all feeds" . newsticker-get-all-news))
 491 (define-key newsticker-menu [newsticker-get-news-at-point]
 492   '("Get news from feed at point" . newsticker-get-news-at-point))
 493 (define-key newsticker-menu [newsticker-separator-3]
 494   '("--"))
 495 (define-key newsticker-menu [newsticker-mark-all-items-as-read]
 496   '("Mark all items as read" . newsticker-mark-all-items-as-read))
 497 (define-key newsticker-menu [newsticker-mark-all-items-at-point-as-read]
 498   '("Mark all items in feed at point as read" .
 499     newsticker-mark-all-items-at-point-as-read))
 500 (define-key newsticker-menu [newsticker-mark-item-at-point-as-read]
 501   '("Mark item at point as read" .
 502     newsticker-mark-item-at-point-as-read))
 503 (define-key newsticker-menu [newsticker-mark-item-at-point-as-immortal]
 504   '("Toggle immortality for item at point" .
 505     newsticker-mark-item-at-point-as-immortal))
 506 (define-key newsticker-menu [newsticker-separator-4]
 507   '("--"))
 508 (define-key newsticker-menu [newsticker-toggle-auto-narrow-to-item]
 509   '("Narrow to single item" . newsticker-toggle-auto-narrow-to-item))
 510 (define-key newsticker-menu [newsticker-toggle-auto-narrow-to-feed]
 511   '("Narrow to single news feed" . newsticker-toggle-auto-narrow-to-feed))
 512 (define-key newsticker-menu [newsticker-hide-old-items]
 513   '("Hide old items" . newsticker-hide-old-items))
 514 (define-key newsticker-menu [newsticker-show-old-items]
 515   '("Show old items" . newsticker-show-old-items))
 516 (define-key newsticker-menu [newsticker-next-item]
 517   '("Go to next item" . newsticker-next-item))
 518 (define-key newsticker-menu [newsticker-previous-item]
 519   '("Go to previous item" . newsticker-previous-item))
 520
 521 ;; bind menu to mouse
 522 (define-key newsticker-mode-map [down-mouse-3] newsticker-menu)
 523 ;; Put menu in menu-bar
 524 (define-key newsticker-mode-map [menu-bar Newsticker]
 525   (cons "Newsticker" newsticker-menu))
 526
 527
 528 ;; ======================================================================
 529 ;;; User fun
 530 ;; ======================================================================
 531 ;;;###autoload
 532 (defun newsticker-plainview ()
 533   "Start newsticker plainview."
 534   (interactive)
 535   (newsticker-buffer-update t)
 536   (switch-to-buffer "*newsticker*"))
 537
 538 (defun newsticker-buffer-force-update ()
 539   "Update the newsticker buffer, even if not necessary."
 540   (interactive)
 541   (newsticker-buffer-update t))
 542
 543 (defun newsticker-buffer-update (&optional force)
 544   "Update the *newsticker* buffer.
 545 Unless FORCE is t this is done only if necessary, i.e. when the
 546 *newsticker* buffer is not up-to-date."
 547   (interactive)
 548   ;; bring cache data into proper order....
 549   (newsticker--cache-sort)
 550   ;; fill buffer
 551   (save-excursion
 552     (let ((buf (get-buffer "*newsticker*")))
 553       (if buf
 554           (switch-to-buffer buf)
 555         (switch-to-buffer (get-buffer-create "*newsticker*"))
 556         (newsticker--buffer-set-uptodate nil)))
 557    (when (or force
 558              (not newsticker--buffer-uptodate-p))
 559      (message "Preparing newsticker buffer...")
 560      (setq buffer-undo-list t)
 561      (let ((inhibit-read-only t))
 562        (set-buffer-modified-p nil)
 563        (erase-buffer)
 564        (newsticker-mode)
 565        ;; Emacs 21.3.50 does not care if we turn off auto-fill in the
 566        ;; definition of newsticker-mode, so we do it here (again)
 567        (auto-fill-mode -1)
 568
 569        (set-buffer-file-coding-system 'utf-8)
 570
 571        (if newsticker-use-full-width
 572            (set (make-local-variable 'fill-column) (1- (window-width))))
 573        (newsticker--buffer-insert-all-items)
 574
 575        ;; FIXME: needed for methods buffer in ecb
 576        ;; (set-visited-file-name "*newsticker*")
 577
 578        (set-buffer-modified-p nil)
 579         (newsticker-hide-all-desc)
 580         (if newsticker-hide-old-items-in-newsticker-buffer
 581             (newsticker-hide-old-items))
 582         (if newsticker-show-descriptions-of-new-items
 583             (newsticker-show-new-item-desc))
 584        )
 585      (message ""))
 586    (newsticker--buffer-set-uptodate t)
 587    (run-hooks 'newsticker-buffer-change-hook)))
 588
 589 (defun newsticker-get-news-at-point ()
 590   "Launch retrieval of news for the feed point is in.
 591 This does NOT start the retrieval timers."
 592   (interactive)
 593   ;; launch retrieval of news
 594   (let ((feed (get-text-property (point) 'feed)))
 595       (when feed
 596         (newsticker--debug-msg "Getting news for %s" (symbol-name feed))
 597         (newsticker-get-news (symbol-name feed)))))
 598
 599 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r)))
 600 (declare-function w3m-toggle-inline-image "ext:w3m" (&optional force no-cache))
 601
 602 (defun newsticker-w3m-show-inline-images ()
 603   "Show inline images in visible text ranges.
 604 In-line images in invisible text ranges are hidden.  This function
 605 calls `w3m-toggle-inline-image'.  It works only if
 606 `newsticker-html-renderer' is set to `w3m-region'."
 607   (interactive)
 608   (if (eq newsticker-html-renderer 'w3m-region)
 609       (let ((inhibit-read-only t))
 610         (save-excursion
 611           (save-restriction
 612             (widen)
 613             (goto-char (point-min))
 614             (let ((pos (point)))
 615               (while pos
 616                 (setq pos (next-single-property-change pos 'w3m-image))
 617                 (when pos
 618                   (goto-char pos)
 619                   (when (get-text-property pos 'w3m-image)
 620                     (let ((invis (newsticker--lists-intersect-p
 621                                   (get-text-property (1- (point))
 622                                                      'invisible)
 623                                   buffer-invisibility-spec)))
 624                       (unless  (car (get-text-property (1- (point))
 625                                                        'display))
 626                         (unless invis
 627                           (w3m-toggle-inline-image t)))))))))))))
 628
 629 ;; ======================================================================
 630 ;;; Keymap stuff
 631 ;; ======================================================================
 632 (defun newsticker-close-buffer ()
 633   "Close the newsticker buffer."
 634   (interactive)
 635   (newsticker--cache-update t)
 636   (bury-buffer))
 637
 638 (defun newsticker-next-new-item (&optional do-not-wrap-at-eob)
 639   "Go to next new news item.
 640 If no new item is found behind point, search is continued at
 641 beginning of buffer unless optional argument DO-NOT-WRAP-AT-EOB
 642 is non-nil."
 643   (interactive)
 644   (widen)
 645   (let ((go-ahead t))
 646     (while go-ahead
 647       (unless (newsticker--buffer-goto '(item) 'new)
 648         ;; found nothing -- wrap
 649         (unless do-not-wrap-at-eob
 650           (goto-char (point-min))
 651           (newsticker-next-new-item t))
 652         (setq go-ahead nil))
 653       (unless (newsticker--lists-intersect-p
 654                (get-text-property (point) 'invisible)
 655                buffer-invisibility-spec)
 656         ;; this item is invisible -- continue search
 657         (setq go-ahead nil))))
 658   (run-hooks 'newsticker-select-item-hook)
 659   (point))
 660
 661 (defun newsticker-previous-new-item (&optional do-not-wrap-at-bob)
 662   "Go to previous new news item.
 663 If no new item is found before point, search is continued at
 664 beginning of buffer unless optional argument DO-NOT-WRAP-AT-BOB
 665 is non-nil."
 666   (interactive)
 667   (widen)
 668   (let ((go-ahead t))
 669     (while go-ahead
 670       (unless (newsticker--buffer-goto '(item) 'new t)
 671         (unless do-not-wrap-at-bob
 672           (goto-char (point-max))
 673           (newsticker--buffer-goto '(item) 'new t)))
 674       (unless (newsticker--lists-intersect-p
 675                (get-text-property (point) 'invisible)
 676                     buffer-invisibility-spec)
 677         (setq go-ahead nil))))
 678   (run-hooks 'newsticker-select-item-hook)
 679   (point))
 680
 681 (defun newsticker-next-item (&optional do-not-wrap-at-eob)
 682   "Go to next news item.
 683 Return new buffer position.
 684 If no item is found below point, search is continued at beginning
 685 of buffer unless optional argument DO-NOT-WRAP-AT-EOB is
 686 non-nil."
 687   (interactive)
 688   (widen)
 689   (let ((go-ahead t)
 690         (search-list '(item)))
 691     (if newsticker--auto-narrow-to-item
 692         (setq search-list '(item feed)))
 693     (while go-ahead
 694       (unless (newsticker--buffer-goto search-list)
 695         ;; found nothing -- wrap
 696         (unless do-not-wrap-at-eob
 697           (goto-char (point-min)))
 698         (setq go-ahead nil))
 699       (unless (newsticker--lists-intersect-p
 700                (get-text-property (point) 'invisible)
 701                     buffer-invisibility-spec)
 702         (setq go-ahead nil))))
 703   (run-hooks 'newsticker-select-item-hook)
 704   (force-mode-line-update)
 705   (point))
 706
 707 (defun newsticker-next-item-same-feed ()
 708   "Go to next news item in the same feed.
 709 Return new buffer position.  If no item is found below point or if
 710 auto-narrow-to-item is enabled, nil is returned."
 711   (interactive)
 712   (if newsticker--auto-narrow-to-item
 713       nil
 714     (let ((go-ahead t)
 715           (current-pos (point))
 716           (end-of-feed (save-excursion (newsticker--buffer-end-of-feed))))
 717       (while go-ahead
 718         (unless (newsticker--buffer-goto '(item))
 719           (setq go-ahead nil))
 720         (unless (newsticker--lists-intersect-p
 721                  (get-text-property (point) 'invisible)
 722                  buffer-invisibility-spec)
 723           (setq go-ahead nil)))
 724       (if (and (> (point) current-pos)
 725                (< (point) end-of-feed))
 726           (point)
 727         (goto-char current-pos)
 728         nil))))
 729
 730 (defun newsticker-previous-item (&optional do-not-wrap-at-bob)
 731   "Go to previous news item.
 732 Return new buffer position.
 733 If no item is found before point, search is continued at
 734 beginning of buffer unless optional argument DO-NOT-WRAP-AT-BOB
 735 is non-nil."
 736   (interactive)
 737   (widen)
 738   (let ((go-ahead t)
 739         (search-list '(item)))
 740     (if newsticker--auto-narrow-to-item
 741         (setq search-list '(item feed)))
 742     (when (bobp)
 743       (unless do-not-wrap-at-bob
 744         (goto-char (point-max))))
 745     (while go-ahead
 746       (if (newsticker--buffer-goto search-list nil t)
 747           (unless (newsticker--lists-intersect-p
 748                    (get-text-property (point) 'invisible)
 749                    buffer-invisibility-spec)
 750             (setq go-ahead nil))
 751         (goto-char (point-min))
 752         (setq go-ahead nil))))
 753   (run-hooks 'newsticker-select-item-hook)
 754   (force-mode-line-update)
 755   (point))
 756
 757 (defun newsticker-next-feed ()
 758   "Go to next news feed.
 759 Return new buffer position."
 760   (interactive)
 761   (widen)
 762   (newsticker--buffer-goto '(feed))
 763   (run-hooks 'newsticker-select-feed-hook)
 764   (force-mode-line-update)
 765   (point))
 766
 767 (defun newsticker-previous-feed ()
 768   "Go to previous news feed.
 769 Return new buffer position."
 770   (interactive)
 771   (widen)
 772   (newsticker--buffer-goto '(feed) nil t)
 773   (run-hooks 'newsticker-select-feed-hook)
 774   (force-mode-line-update)
 775   (point))
 776
 777 (defun newsticker-mark-all-items-at-point-as-read-and-redraw ()
 778   "Mark all items as read and clear ticker contents."
 779   (interactive)
 780   (when (or newsticker--buffer-uptodate-p
 781             (y-or-n-p
 782              "Buffer is not up to date -- really mark items as read? "))
 783     (newsticker-mark-all-items-of-feed-as-read
 784      (get-text-property (point) 'feed))))
 785
 786 (defun newsticker-mark-all-items-of-feed-as-read (feed)
 787   "Mark all items of FEED as read, clear ticker, and redraw buffer."
 788   (when feed
 789     (let ((pos (point)))
 790       (message "Marking all items as read for %s" (symbol-name feed))
 791       (newsticker--cache-replace-age newsticker--cache feed 'new 'old)
 792       (newsticker--cache-replace-age newsticker--cache feed 'obsolete
 793                                      'old)
 794       (newsticker--cache-update)
 795       (newsticker--buffer-set-uptodate nil)
 796       (newsticker--ticker-text-setup)
 797       (newsticker-buffer-update)
 798       ;; go back to where we came frome
 799       (goto-char pos)
 800       (end-of-line)
 801       (newsticker--buffer-goto '(feed) nil t))))
 802
 803 (defun newsticker-mark-all-items-at-point-as-read ()
 804   "Mark all items as read and clear ticker contents."
 805   (interactive)
 806   (when (or newsticker--buffer-uptodate-p
 807             (y-or-n-p
 808              "Buffer is not up to date -- really mark items as read? "))
 809     (newsticker--do-mark-item-at-point-as-read t)
 810     (while (newsticker-next-item-same-feed)
 811       (newsticker--do-mark-item-at-point-as-read t))
 812     (newsticker-next-item t)))
 813
 814 (defun newsticker-mark-item-at-point-as-read (&optional respect-immortality)
 815   "Mark item at point as read and move to next item.
 816 If optional argument RESPECT-IMMORTALITY is not nil immortal items do
 817 not get changed."
 818   (interactive)
 819   (when (or newsticker--buffer-uptodate-p
 820             (y-or-n-p
 821              "Buffer is not up to date -- really mark this item as read? "))
 822     (newsticker--do-mark-item-at-point-as-read respect-immortality)
 823     ;; move forward
 824     (newsticker-next-item t)))
 825
 826 (defun newsticker--do-mark-item-at-point-as-read (&optional respect-immortality)
 827   "Mark item at point as read.
 828 If optional argument RESPECT-IMMORTALITY is not nil immortal items do
 829 not get changed."
 830   (let ((feed (get-text-property (point) 'feed)))
 831     (when feed
 832       (save-excursion
 833         (newsticker--buffer-beginning-of-item)
 834         (let ((inhibit-read-only t)
 835               (age (get-text-property (point) 'nt-age))
 836               (title (get-text-property (point) 'nt-title))
 837               (guid (get-text-property (point) 'nt-guid))
 838               (nt-desc (get-text-property (point) 'nt-desc))
 839               (pos (save-excursion (newsticker--buffer-end-of-item)))
 840               item)
 841           (when (or (eq age 'new)
 842                     (eq age 'obsolete)
 843                     (and (eq age 'immortal)
 844                          (not respect-immortality)))
 845             ;; find item
 846             (setq item (newsticker--cache-contains newsticker--cache
 847                                                    feed title nt-desc
 848                                                    nil nil guid))
 849             ;; mark as old
 850             (when item
 851               (setcar (nthcdr 4 item) 'old)
 852               (newsticker--do-forget-preformatted item))
 853             ;; clean up ticker
 854             (if (or (and (eq age 'new)
 855                          newsticker-hide-immortal-items-in-echo-area)
 856                     (and (memq age '(old immortal))
 857                          (not
 858                           (eq newsticker-hide-old-items-in-newsticker-buffer
 859                               newsticker-hide-immortal-items-in-echo-area))))
 860                 (newsticker--ticker-text-remove feed title))
 861             ;; set faces etc.
 862             (save-excursion
 863               (save-restriction
 864                 (widen)
 865                 (put-text-property (point) pos 'nt-age 'old)
 866                 (newsticker--buffer-set-faces (point) pos)))
 867             (set-buffer-modified-p nil)))))))
 868
 869 (defun newsticker-mark-item-at-point-as-immortal ()
 870   "Mark item at point as read."
 871   (interactive)
 872   (when (or newsticker--buffer-uptodate-p
 873             (y-or-n-p
 874              "Buffer is not up to date -- really mark this item as read? "))
 875     (let ((feed (get-text-property (point) 'feed))
 876           (item nil))
 877       (when feed
 878         (save-excursion
 879           (newsticker--buffer-beginning-of-item)
 880           (let ((inhibit-read-only t)
 881                 (oldage (get-text-property (point) 'nt-age))
 882                 (title (get-text-property (point) 'nt-title))
 883                 (guid (get-text-property (point) 'nt-guid))
 884                 (pos  (save-excursion (newsticker--buffer-end-of-item))))
 885             (let ((newage 'immortal))
 886               (if (eq oldage 'immortal)
 887                   (setq newage 'old))
 888               (setq item (newsticker--cache-contains newsticker--cache
 889                                                      feed title nil nil nil
 890                                                      guid))
 891               ;; change age
 892               (when item
 893                 (setcar (nthcdr 4 item) newage)
 894                 (newsticker--do-forget-preformatted item))
 895               (if (or (and (eq newage 'immortal)
 896                            newsticker-hide-immortal-items-in-echo-area)
 897                       (and (eq newage 'obsolete)
 898                            newsticker-hide-obsolete-items-in-echo-area)
 899                       (and (eq oldage 'immortal)
 900                            (not
 901                             (eq newsticker-hide-old-items-in-newsticker-buffer
 902                                 newsticker-hide-immortal-items-in-echo-area))))
 903                   (newsticker--ticker-text-remove feed title)
 904                 (newsticker--ticker-text-setup))
 905               (save-excursion
 906                 (save-restriction
 907                   (widen)
 908                   (put-text-property (point) pos 'nt-age newage)
 909                   (if (eq newage 'immortal)
 910                       (put-text-property (point) pos 'nt-age 'immortal)
 911                     (put-text-property (point) pos 'nt-age 'old))
 912                   (newsticker--buffer-set-faces (point) pos))))))
 913           (if item
 914             (newsticker-next-item t))))))
 915
 916 (defun newsticker-mark-all-items-as-read ()
 917   "Mark all items as read and clear ticker contents."
 918   (interactive)
 919   (when (or newsticker--buffer-uptodate-p
 920             (y-or-n-p
 921              "Buffer is not up to date -- really mark items as read? "))
 922     (newsticker--cache-replace-age newsticker--cache 'any 'new 'old)
 923     (newsticker--buffer-set-uptodate nil)
 924     (newsticker--ticker-text-setup)
 925     (newsticker--cache-update)
 926     (newsticker-buffer-update)))
 927
 928 (defun newsticker-hide-extra ()
 929   "Hide the extra elements of items."
 930   (interactive)
 931   (newsticker--buffer-hideshow 'extra nil)
 932   (newsticker--buffer-redraw))
 933
 934 (defun newsticker-show-extra ()
 935   "Show the extra elements of items."
 936   (interactive)
 937   (newsticker--buffer-hideshow 'extra t)
 938   (newsticker--buffer-redraw))
 939
 940 (defun newsticker-hide-old-item-desc ()
 941   "Hide the description of old items."
 942   (interactive)
 943   (newsticker--buffer-hideshow 'desc-old nil)
 944   (newsticker--buffer-redraw))
 945
 946 (defun newsticker-show-old-item-desc ()
 947   "Show the description of old items."
 948   (interactive)
 949   (newsticker--buffer-hideshow 'item-old t)
 950   (newsticker--buffer-hideshow 'desc-old t)
 951   (newsticker--buffer-redraw))
 952
 953 (defun newsticker-hide-new-item-desc ()
 954   "Hide the description of new items."
 955   (interactive)
 956   (newsticker--buffer-hideshow 'desc-new nil)
 957   (newsticker--buffer-hideshow 'desc-immortal nil)
 958   (newsticker--buffer-hideshow 'desc-obsolete nil)
 959   (newsticker--buffer-redraw))
 960
 961 (defun newsticker-show-new-item-desc ()
 962   "Show the description of new items."
 963   (interactive)
 964   (newsticker--buffer-hideshow 'desc-new t)
 965   (newsticker--buffer-hideshow 'desc-immortal t)
 966   (newsticker--buffer-hideshow 'desc-obsolete t)
 967   (newsticker--buffer-redraw))
 968
 969 (defun newsticker-hide-feed-desc ()
 970   "Hide the description of feeds."
 971   (interactive)
 972   (newsticker--buffer-hideshow 'desc-feed nil)
 973   (newsticker--buffer-redraw))
 974
 975 (defun newsticker-show-feed-desc ()
 976   "Show the description of old items."
 977   (interactive)
 978   (newsticker--buffer-hideshow 'desc-feed t)
 979   (newsticker--buffer-redraw))
 980
 981 (defun newsticker-hide-all-desc ()
 982   "Hide the descriptions of feeds and all items."
 983   (interactive)
 984   (newsticker--buffer-hideshow 'desc-feed nil)
 985   (newsticker--buffer-hideshow 'desc-immortal nil)
 986   (newsticker--buffer-hideshow 'desc-obsolete nil)
 987   (newsticker--buffer-hideshow 'desc-new  nil)
 988   (newsticker--buffer-hideshow 'desc-old  nil)
 989   (newsticker--buffer-redraw))
 990
 991 (defun newsticker-show-all-desc ()
 992   "Show the descriptions of feeds and all items."
 993   (interactive)
 994   (newsticker--buffer-hideshow 'desc-feed t)
 995   (newsticker--buffer-hideshow 'desc-immortal  t)
 996   (newsticker--buffer-hideshow 'desc-obsolete  t)
 997   (newsticker--buffer-hideshow 'desc-new  t)
 998   (newsticker--buffer-hideshow 'desc-old  t)
 999   (newsticker--buffer-redraw))
1000
1001 (defun newsticker-hide-old-items ()
1002   "Hide old items."
1003   (interactive)
1004   (newsticker--buffer-hideshow 'desc-old nil)
1005   (newsticker--buffer-hideshow 'item-old nil)
1006   (newsticker--buffer-redraw))
1007
1008 (defun newsticker-show-old-items ()
1009   "Show old items."
1010   (interactive)
1011   (newsticker--buffer-hideshow 'item-old t)
1012   (newsticker--buffer-redraw))
1013
1014 (defun newsticker-hide-entry ()
1015   "Hide description of entry at point."
1016   (interactive)
1017   (save-excursion
1018     (let* (pos1 pos2
1019                 (inhibit-read-only t)
1020                 inv-prop org-inv-prop
1021                 is-invisible)
1022       (newsticker--buffer-beginning-of-item)
1023       (newsticker--buffer-goto '(desc))
1024       (setq pos1 (max (point-min) (1- (point))))
1025       (newsticker--buffer-goto '(extra feed item nil))
1026       (setq pos2 (max (point-min) (1- (point))))
1027       (setq inv-prop (get-text-property pos1 'invisible))
1028       (setq org-inv-prop (get-text-property pos1 'org-invisible))
1029       (cond ((eq inv-prop t)
1030              ;; do nothing
1031              )
1032             ((eq org-inv-prop nil)
1033              (add-text-properties pos1 pos2
1034                                   (list 'invisible (list t)
1035                                         'org-invisible inv-prop)))
1036             (t
1037              ;; toggle
1038              (add-text-properties pos1 pos2
1039                                   (list 'invisible org-inv-prop))
1040              (remove-text-properties pos1 pos2 '(org-invisible))))))
1041   (newsticker--buffer-redraw))
1042
1043 (defun newsticker-show-entry ()
1044   "Show description of entry at point."
1045   (interactive)
1046   (save-excursion
1047     (let* (pos1 pos2
1048                 (inhibit-read-only t)
1049                 inv-prop org-inv-prop
1050                 is-invisible)
1051       (newsticker--buffer-beginning-of-item)
1052       (newsticker--buffer-goto '(desc))
1053       (setq pos1 (max (point-min) (1- (point))))
1054       (newsticker--buffer-goto '(extra feed item))
1055       (setq pos2 (max (point-min) (1- (point))))
1056       (setq inv-prop (get-text-property pos1 'invisible))
1057       (setq org-inv-prop (get-text-property pos1 'org-invisible))
1058       (cond ((eq org-inv-prop nil)
1059              (add-text-properties pos1 pos2
1060                                   (list 'invisible nil
1061                                         'org-invisible inv-prop)))
1062             (t
1063              ;; toggle
1064              (add-text-properties pos1 pos2
1065                                   (list 'invisible org-inv-prop))
1066              (remove-text-properties pos1 pos2 '(org-invisible))))))
1067   (newsticker--buffer-redraw))
1068
1069 (defun newsticker-toggle-auto-narrow-to-feed ()
1070   "Toggle narrowing to current news feed.
1071 If auto-narrowing is active, only news item of the current feed
1072 are visible."
1073   (interactive)
1074   (newsticker-set-auto-narrow-to-feed
1075    (not newsticker--auto-narrow-to-feed)))
1076
1077 (defun newsticker-set-auto-narrow-to-feed (value)
1078   "Turn narrowing to current news feed on or off.
1079 If VALUE is nil, auto-narrowing is turned off, otherwise it is turned on."
1080   (interactive)
1081   (setq newsticker--auto-narrow-to-item nil)
1082   (setq newsticker--auto-narrow-to-feed value)
1083   (widen)
1084   (newsticker--buffer-make-item-completely-visible)
1085   (run-hooks 'newsticker-narrow-hook))
1086
1087 (defun newsticker-toggle-auto-narrow-to-item ()
1088   "Toggle narrowing to current news item.
1089 If auto-narrowing is active, only one item of the current feed
1090 is visible."
1091   (interactive)
1092   (newsticker-set-auto-narrow-to-item
1093    (not newsticker--auto-narrow-to-item)))
1094
1095 (defun newsticker-set-auto-narrow-to-item (value)
1096   "Turn narrowing to current news item on or off.
1097 If VALUE is nil, auto-narrowing is turned off, otherwise it is turned on."
1098   (interactive)
1099   (setq newsticker--auto-narrow-to-feed nil)
1100   (setq newsticker--auto-narrow-to-item value)
1101   (widen)
1102   (newsticker--buffer-make-item-completely-visible)
1103   (run-hooks 'newsticker-narrow-hook))
1104
1105 (defun newsticker-next-feed-available-p ()
1106   "Return t if position is before last feed, nil otherwise."
1107   (save-excursion
1108     (let ((p (point)))
1109       (newsticker--buffer-goto '(feed))
1110       (not (= p (point))))))
1111
1112 (defun newsticker-previous-feed-available-p ()
1113   "Return t if position is behind first feed, nil otherwise."
1114   (save-excursion
1115     (let ((p (point)))
1116       (newsticker--buffer-goto '(feed) nil t)
1117       (not (= p (point))))))
1118
1119 (defun newsticker-next-item-available-p ()
1120   "Return t if position is before last feed, nil otherwise."
1121   (save-excursion
1122     (catch 'result
1123       (while (< (point) (point-max))
1124         (unless (newsticker--buffer-goto '(item))
1125           (throw 'result nil))
1126         (unless (newsticker--lists-intersect-p
1127                  (get-text-property (point) 'invisible)
1128                  buffer-invisibility-spec)
1129           (throw 'result t))))))
1130
1131 (defun newsticker-previous-item-available-p ()
1132   "Return t if position is behind first item, nil otherwise."
1133   (save-excursion
1134     (catch 'result
1135       (while (> (point) (point-min))
1136         (unless (newsticker--buffer-goto '(item) nil t)
1137           (throw 'result nil))
1138         (unless (newsticker--lists-intersect-p
1139                  (get-text-property (point) 'invisible)
1140                  buffer-invisibility-spec)
1141           (throw 'result t))))))
1142
1143 (defun newsticker-item-not-old-p ()
1144   "Return t if there is an item at point which is not old, nil otherwise."
1145     (when (get-text-property (point) 'feed)
1146       (save-excursion
1147         (newsticker--buffer-beginning-of-item)
1148         (let ((age (get-text-property (point) 'nt-age)))
1149           (and (memq  age '(new immortal obsolete)) t)))))
1150
1151 (defun newsticker-item-not-immortal-p ()
1152   "Return t if there is an item at point which is not immortal, nil otherwise."
1153     (when (get-text-property (point) 'feed)
1154       (save-excursion
1155         (newsticker--buffer-beginning-of-item)
1156         (let ((age (get-text-property (point) 'nt-age)))
1157           (and (memq  age '(new old obsolete)) t)))))
1158
1159 ;; ======================================================================
1160 ;;; Imenu stuff
1161 ;; ======================================================================
1162 (defun newsticker--imenu-create-index ()
1163   "Scan newsticker buffer and return an index for imenu."
1164   (save-excursion
1165     (goto-char (point-min))
1166     (let ((index-alist nil)
1167           (feed-list nil)
1168           (go-ahead t))
1169       (while go-ahead
1170         (let ((type  (get-text-property (point) 'nt-type))
1171               (title (get-text-property (point) 'nt-title)))
1172           (cond ((eq type 'feed)
1173                  ;; we're on a feed heading
1174                  (when feed-list
1175                    (if index-alist
1176                        (nconc index-alist (list feed-list))
1177                      (setq index-alist (list feed-list))))
1178                  (setq feed-list (list title)))
1179                 (t
1180                  (nconc feed-list
1181                         (list (cons title (point)))))))
1182         (setq go-ahead (newsticker--buffer-goto '(item feed))))
1183       (if index-alist
1184           (nconc index-alist (list feed-list))
1185         (setq index-alist (list feed-list)))
1186       index-alist)))
1187
1188 (defun newsticker--imenu-goto (name pos &rest args)
1189   "Go to item NAME at position POS and show item.
1190 ARGS are ignored."
1191   (goto-char pos)
1192   ;; show headline
1193   (newsticker--buffer-goto '(desc extra feed item))
1194   (let* ((inhibit-read-only t)
1195          (pos1 (max (point-min) (1- pos)))
1196          (pos2 (max pos1 (1- (point))))
1197          (inv-prop (get-text-property pos 'invisible))
1198          (org-inv-prop (get-text-property pos 'org-invisible)))
1199     (when (eq org-inv-prop nil)
1200       (add-text-properties pos1 pos2 (list 'invisible nil
1201                                           'org-invisible inv-prop))))
1202   ;; show desc
1203   (newsticker-show-entry))
1204
1205 ;; ======================================================================
1206 ;;; Buffer stuff
1207 ;; ======================================================================
1208 (defun newsticker--buffer-set-uptodate (value)
1209   "Set the uptodate-status of the newsticker buffer to VALUE.
1210 The mode-line is changed accordingly."
1211   (setq newsticker--buffer-uptodate-p value)
1212   (let ((b (get-buffer "*newsticker*")))
1213     (when b
1214       (with-current-buffer b
1215         (setq mode-name (if value
1216                             "Newsticker -- up to date -- "
1217                           "Newsticker -- NEED UPDATE -- ")))
1218       (force-mode-line-update 0))))
1219
1220 (defun newsticker--buffer-redraw ()
1221   "Redraw the newsticker window."
1222   (if (fboundp 'force-window-update)
1223       (force-window-update (current-buffer))
1224     (redraw-frame (selected-frame)))
1225   (run-hooks 'newsticker-buffer-change-hook)
1226   (sit-for 0))
1227
1228 (defun newsticker--buffer-insert-all-items ()
1229   "Insert all cached newsticker items into the current buffer.
1230 Keeps order of feeds as given in `newsticker-url-list' and
1231 `newsticker-url-list-defaults'."
1232   (goto-char (point-min))
1233   (mapc (lambda (url-item)
1234           (let* ((feed-name (car url-item))
1235                  (feed-name-symbol (intern feed-name))
1236                  (feed (assoc feed-name-symbol newsticker--cache))
1237                  (items (cdr feed))
1238                  (pos (point)))
1239             (when feed
1240               ;; insert the feed description
1241               (mapc (lambda (item)
1242                       (when (eq (newsticker--age item) 'feed)
1243                         (newsticker--buffer-insert-item item
1244                                                         feed-name-symbol)))
1245                     items)
1246               ;;insert the items
1247               (mapc (lambda (item)
1248                       (if (memq (newsticker--age item) '(new immortal old
1249                                                              obsolete))
1250                           (newsticker--buffer-insert-item item
1251                                                           feed-name-symbol)))
1252                     items)
1253               (put-text-property pos (point) 'feed (car feed))
1254
1255               ;; insert empty line between feeds
1256               (let ((p (point)))
1257                 (insert "\n")
1258                 (put-text-property p (point) 'hard t)))))
1259         (append newsticker-url-list newsticker-url-list-defaults))
1260
1261   (newsticker--buffer-set-faces (point-min) (point-max))
1262   (newsticker--buffer-set-invisibility (point-min) (point-max))
1263   (goto-char (point-min)))
1264
1265 (defun newsticker--buffer-insert-item (item &optional feed-name-symbol)
1266   "Insert a news item in the current buffer.
1267 Insert a formatted representation of the ITEM.  The optional parameter
1268 FEED-NAME-SYMBOL determines how the item is formatted and whether the
1269 item-retrieval time is added as well."
1270   ;; insert headline
1271   (if (eq (newsticker--age item) 'feed)
1272       (newsticker--buffer-do-insert-text item 'feed feed-name-symbol)
1273     (newsticker--buffer-do-insert-text item 'item feed-name-symbol))
1274   ;; insert the description
1275   (newsticker--buffer-do-insert-text item 'desc feed-name-symbol))
1276
1277 (defun newsticker--buffer-do-insert-text (item type feed-name-symbol)
1278   "Actually insert contents of news item, format it, render it and all that.
1279 ITEM is a news item, TYPE tells which part of the item shall be inserted,
1280 FEED-NAME-SYMBOL tells to which feed this item belongs."
1281   (let* ((pos (point))
1282          (format newsticker-desc-format)
1283          (pos-date-start nil)
1284          (pos-date-end nil)
1285          (pos-stat-start nil)
1286          (pos-stat-end nil)
1287          (pos-text-start nil)
1288          (pos-text-end nil)
1289          (pos-extra-start nil)
1290          (pos-extra-end nil)
1291          (pos-enclosure-start nil)
1292          (pos-enclosure-end nil)
1293          (age (newsticker--age item))
1294          (preformatted-contents (newsticker--preformatted-contents item))
1295          (preformatted-title (newsticker--preformatted-title item)))
1296     (cond ((and preformatted-contents
1297                 (not (eq (aref preformatted-contents 0) ?\n));; we must
1298                                                        ;; NOT have a line
1299                                                        ;; break!
1300                 (eq type 'desc))
1301            (insert preformatted-contents))
1302           ((and preformatted-title
1303                 (not (eq (aref preformatted-title 0) ?\n));; we must NOT have a
1304                                                     ;; line break!
1305                 (eq type 'item))
1306            (insert preformatted-title))
1307           (t
1308            ;; item was not formatted before.
1309            ;; Let's go.
1310            (if (eq type 'item)
1311                (setq format newsticker-item-format)
1312              (if (eq type 'feed)
1313                  (setq format newsticker-heading-format)))
1314
1315            (while (> (length format) 0)
1316              (let ((prefix (if (> (length format) 1)
1317                                (substring format 0 2)
1318                              "")))
1319                (cond ((string= "%c" prefix)
1320                       ;; contents
1321                       (when (newsticker--desc item)
1322                         (setq pos-text-start (point-marker))
1323                         (insert (newsticker--desc item))
1324                         (setq pos-text-end (point-marker)))
1325                       (setq format (substring format 2)))
1326                      ((string= "%d" prefix)
1327                       ;; date
1328                       (setq pos-date-start (point-marker))
1329                       (if (newsticker--time item)
1330                           (insert (format-time-string newsticker-date-format
1331                                                       (newsticker--time item))))
1332                       (setq pos-date-end (point-marker))
1333                       (setq format (substring format 2)))
1334                      ((string= "%l" prefix)
1335                       ;; logo
1336                       (let ((disabled (cond ((eq (newsticker--age item) 'feed)
1337                                              (= (newsticker--stat-num-items
1338                                                  feed-name-symbol 'new) 0))
1339                                             (t
1340                                              (not (eq (newsticker--age item)
1341                                                       'new))))))
1342                         (let ((img (newsticker--image-read feed-name-symbol
1343                                                            disabled)))
1344                           (when img
1345                             (newsticker--insert-image img (car item)))))
1346                       (setq format (substring format 2)))
1347                      ((string= "%L" prefix)
1348                       ;; logo or title
1349                       (let ((disabled (cond ((eq (newsticker--age item) 'feed)
1350                                              (= (newsticker--stat-num-items
1351                                                  feed-name-symbol 'new) 0))
1352                                             (t
1353                                              (not (eq (newsticker--age item)
1354                                                       'new))))))
1355                         (let ((img (newsticker--image-read feed-name-symbol
1356                                                            disabled)))
1357                           (if img
1358                               (newsticker--insert-image img (car item))
1359                             (when (car item)
1360                               (setq pos-text-start (point-marker))
1361                               (if (eq (newsticker--age item) 'feed)
1362                                   (insert (newsticker--title item))
1363                                 ;; FIXME: This is not the "real" title!
1364                                 (insert (format "%s"
1365                                                 (car (newsticker--cache-get-feed
1366                                                       feed-name-symbol)))))
1367                               (setq pos-text-end (point-marker))))))
1368                       (setq format (substring format 2)))
1369                      ((string= "%s" prefix)
1370                       ;; statistics
1371                       (setq pos-stat-start (point-marker))
1372                       (if (eq (newsticker--age item) 'feed)
1373                           (insert (newsticker--buffer-statistics
1374                                    feed-name-symbol)))
1375                       (setq pos-stat-end (point-marker))
1376                       (setq format (substring format 2)))
1377                      ((string= "%t" prefix)
1378                       ;; title
1379                       (when (car item)
1380                         (setq pos-text-start (point-marker))
1381                         (insert (car item))
1382                         (setq pos-text-end (point-marker)))
1383                       (setq format (substring format 2)))
1384                      ((string-match "%." prefix)
1385                       ;; unknown specifier!
1386                       (insert prefix)
1387                       (setq format (substring format 2)))
1388                      ((string-match "^\\([^%]*\\)\\(.*\\)" format) ;; FIXME!
1389                       ;; everything else
1390                       (let ((p (point)))
1391                         (insert (substring format
1392                                            (match-beginning 1) (match-end 1)))
1393                         ;; in case that the format string contained newlines
1394                         (put-text-property p (point) 'hard t))
1395                       (setq format (substring format (match-beginning 2)))))))
1396
1397            ;; decode HTML if possible...
1398            (let ((is-rendered-HTML nil))
1399              (when (and newsticker-html-renderer pos-text-start pos-text-end)
1400                (condition-case error-data
1401                    (save-excursion
1402                      ;; check whether it is necessary to call html renderer
1403                      ;; (regexp inspired by htmlr.el)
1404                      (goto-char pos-text-start)
1405                      (when (re-search-forward
1406                             "</?[A-Za-z1-6]*\\|&#?[A-Za-z0-9]+;" pos-text-end t)
1407                        ;; (message "%s" (newsticker--title item))
1408                        (let ((w3m-fill-column (if newsticker-use-full-width
1409                                                   -1 fill-column))
1410                              (w3-maximum-line-length
1411                               (if newsticker-use-full-width nil fill-column)))
1412                          (save-excursion
1413                            (funcall newsticker-html-renderer pos-text-start
1414                                     pos-text-end)))
1415                        (cond ((eq newsticker-html-renderer 'w3m-region)
1416                               (add-text-properties pos (point-max)
1417                                                    (list 'keymap
1418                                                          w3m-minor-mode-map)))
1419                              ((eq newsticker-html-renderer 'w3-region)
1420                               (add-text-properties pos (point-max)
1421                                                    (list 'keymap w3-mode-map))))
1422                        (setq is-rendered-HTML t)))
1423                  (error
1424                   (message "Error: HTML rendering failed: %s, %s"
1425                            (car error-data) (cdr error-data)))))
1426              ;; After html rendering there might be chunks of blank
1427              ;; characters between rendered text and date, statistics or
1428              ;; whatever.  Remove it
1429              (when (and (eq type 'item) is-rendered-HTML)
1430                (goto-char pos)
1431                (while (re-search-forward "[ \t]*\n[ \t]*" nil t)
1432                  (replace-match " " nil nil))
1433                (goto-char (point-max)))
1434              (when (and newsticker-justification
1435                         (memq type '(item desc))
1436                         (not is-rendered-HTML))
1437                (condition-case nil
1438                    (let ((use-hard-newlines t))
1439                      (fill-region pos (point-max) newsticker-justification))
1440                  (error nil))))
1441
1442            ;; remove leading and trailing newlines
1443            (goto-char pos)
1444            (unless (= 0 (skip-chars-forward " \t\r\n"))
1445              (delete-region pos (point)))
1446            (goto-char (point-max))
1447            (let ((end (point)))
1448              (unless (= 0 (skip-chars-backward " \t\r\n" (1+ pos)))
1449                (delete-region (point) end)))
1450            (goto-char (point-max))
1451            ;; closing newline
1452            (unless nil ;;(eq pos (point))
1453              (insert "\n")
1454              (put-text-property (1- (point)) (point) 'hard t))
1455
1456            ;; insert enclosure element
1457            (when (eq type 'desc)
1458              (setq pos-enclosure-start (point))
1459              (newsticker--insert-enclosure item newsticker--url-keymap)
1460              (setq pos-enclosure-end (point)))
1461
1462            ;; show extra elements
1463            (when (eq type 'desc)
1464              (goto-char (point-max))
1465              (setq pos-extra-start (point))
1466              (newsticker--print-extra-elements item newsticker--url-keymap)
1467              (setq pos-extra-end (point)))
1468
1469            ;; text properties
1470            (when (memq type '(feed item))
1471              (add-text-properties pos (1- (point))
1472                                   (list 'mouse-face 'highlight
1473                                         'nt-link (newsticker--link item)
1474                                         'help-echo
1475                                         (format "mouse-2: visit item (%s)"
1476                                                 (newsticker--link item))
1477                                         'keymap newsticker--url-keymap))
1478              (add-text-properties pos (point)
1479                                   (list 'nt-title (newsticker--title item)
1480                                         'nt-desc (newsticker--desc item))))
1481
1482            (add-text-properties pos (point)
1483                                 (list 'nt-type type
1484                                       'nt-face type
1485                                       'nt-age  age
1486                                       'nt-guid (newsticker--guid item)))
1487            (when (and pos-date-start pos-date-end)
1488              (put-text-property pos-date-start pos-date-end 'nt-face 'date))
1489            (when (and pos-stat-start pos-stat-end)
1490              (put-text-property pos-stat-start pos-stat-end 'nt-face 'stat))
1491            (when (and pos-extra-start pos-extra-end)
1492              (put-text-property pos-extra-start pos-extra-end
1493                                 'nt-face 'extra)
1494              (put-text-property pos-extra-start pos-extra-end
1495                                 'nt-type 'extra))
1496            (when (and pos-enclosure-start pos-enclosure-end
1497                       (> pos-enclosure-end pos-enclosure-start))
1498              (put-text-property pos-enclosure-start (1- pos-enclosure-end)
1499                                 'nt-face 'enclosure))
1500
1501            ;; left margin
1502            ;;(unless (memq type '(feed item))
1503            ;;(set-left-margin pos (1- (point)) 1))
1504
1505            ;; save rendered stuff
1506            (cond ((eq type 'desc)
1507                   ;; preformatted contents
1508                   (newsticker--cache-set-preformatted-contents
1509                    item (buffer-substring pos (point))))
1510                   ((eq type 'item)
1511                    ;; preformatted title
1512                    (newsticker--cache-set-preformatted-title
1513                     item (buffer-substring pos (point)))))))))
1514
1515 (defun newsticker--buffer-statistics (feed-name-symbol)
1516   "Return a statistic string for the feed given by FEED-NAME-SYMBOL.
1517 See `newsticker-statistics-format'."
1518   (let ((case-fold-search nil))
1519     (replace-regexp-in-string
1520      "%a"
1521      (format "%d" (newsticker--stat-num-items feed-name-symbol))
1522      (replace-regexp-in-string
1523       "%i"
1524       (format "%d" (newsticker--stat-num-items feed-name-symbol 'immortal))
1525       (replace-regexp-in-string
1526        "%n"
1527        (format "%d" (newsticker--stat-num-items feed-name-symbol 'new))
1528        (replace-regexp-in-string
1529         "%o"
1530         (format "%d" (newsticker--stat-num-items feed-name-symbol 'old))
1531         (replace-regexp-in-string
1532          "%O"
1533          (format "%d" (newsticker--stat-num-items feed-name-symbol 'obsolete))
1534          newsticker-statistics-format)))))))
1535
1536 (defun newsticker--buffer-set-faces (start end)
1537   "Add face properties according to mark property.
1538 Scans the buffer between START and END."
1539   (save-excursion
1540     (put-text-property start end 'face 'newsticker-default-face)
1541     (goto-char start)
1542     (let ((pos1 start)
1543           (pos2 1)
1544           (nt-face (get-text-property start 'nt-face))
1545           (nt-age (get-text-property start 'nt-age)))
1546       (when nt-face
1547         (setq pos2 (next-single-property-change (point) 'nt-face))
1548         (newsticker--set-face-properties pos1 pos2 nt-face nt-age)
1549         (setq nt-face (get-text-property pos2 'nt-face))
1550         (setq pos1 pos2))
1551       (while (and (setq pos2 (next-single-property-change pos1 'nt-face))
1552                   (<= pos2 end)
1553                   (> pos2 pos1))
1554         (newsticker--set-face-properties pos1 pos2 nt-face nt-age)
1555         (setq nt-face (get-text-property pos2 'nt-face))
1556         (setq nt-age (get-text-property pos2 'nt-age))
1557         (setq pos1 pos2)))))
1558
1559 (defun newsticker--buffer-set-invisibility (start end)
1560   "Add invisibility properties according to nt-type property.
1561 Scans the buffer between START and END.  Sets the 'invisible
1562 property to '(<nt-type>-<nt-age> <nt-type> <nt-age>)."
1563   (save-excursion
1564     ;; reset invisibility settings
1565     (put-text-property start end 'invisible nil)
1566     ;; let's go
1567     (goto-char start)
1568     (let ((pos1 start)
1569           (pos2 1)
1570           (nt-type (get-text-property start 'nt-type))
1571           (nt-age (get-text-property start 'nt-age)))
1572       (when nt-type
1573         (setq pos2 (next-single-property-change (point) 'nt-type))
1574         (put-text-property (max (point-min) pos1) (1- pos2)
1575                            'invisible
1576                            (list (intern
1577                                   (concat
1578                                    (symbol-name
1579                                     (if (eq nt-type 'extra) 'desc nt-type))
1580                                    "-"
1581                                    (symbol-name nt-age)))
1582                                  nt-type
1583                                  nt-age))
1584         (setq nt-type (get-text-property pos2 'nt-type))
1585         (setq pos1 pos2))
1586       (while (and (setq pos2 (next-single-property-change pos1 'nt-type))
1587                   (<= pos2 end)
1588                   (> pos2 pos1))
1589         ;; must shift one char to the left in order to handle inivisible
1590         ;; newlines, motion in invisible text areas and all that correctly
1591         (put-text-property (1- pos1) (1- pos2)
1592                            'invisible
1593                            (list (intern
1594                                   (concat
1595                                    (symbol-name
1596                                     (if (eq nt-type 'extra) 'desc nt-type))
1597                                    "-"
1598                                    (symbol-name nt-age)))
1599                                  nt-type
1600                                  nt-age))
1601         (setq nt-type (get-text-property pos2 'nt-type))
1602         (setq nt-age (get-text-property pos2 'nt-age))
1603         (setq pos1 pos2)))))
1604
1605 (defun newsticker--set-face-properties (pos1 pos2 nt-face age)
1606   "Set the face for the text between the positions POS1 and POS2.
1607 The face is chosen according the values of NT-FACE and AGE."
1608   (let ((face (cond ((eq nt-face 'feed)
1609                      'newsticker-feed-face)
1610                     ((eq nt-face 'item)
1611                      (cond ((eq age 'new)
1612                             'newsticker-new-item-face)
1613                            ((eq age 'old)
1614                             'newsticker-old-item-face)
1615                            ((eq age 'immortal)
1616                             'newsticker-immortal-item-face)
1617                            ((eq age 'obsolete)
1618                             'newsticker-obsolete-item-face)))
1619                     ((eq nt-face 'date)
1620                      'newsticker-date-face)
1621                     ((eq nt-face 'stat)
1622                      'newsticker-statistics-face)
1623                     ((eq nt-face 'extra)
1624                      'newsticker-extra-face)
1625                     ((eq nt-face 'enclosure)
1626                      'newsticker-enclosure-face))))
1627     (when face
1628       (put-text-property pos1 (max pos1 pos2) 'face face))))
1629
1630 ;; ======================================================================
1631 ;;; Functions working on the *newsticker* buffer
1632 ;; ======================================================================
1633 (defun newsticker--buffer-make-item-completely-visible ()
1634   "Scroll buffer until current item is completely visible."
1635   (when newsticker--auto-narrow-to-feed
1636     (let* ((min (or (save-excursion (newsticker--buffer-beginning-of-feed))
1637                     (point-min)))
1638            (max (or (save-excursion (newsticker--buffer-end-of-feed))
1639                     (point-max))))
1640       (narrow-to-region min max)))
1641   (when newsticker--auto-narrow-to-item
1642     (let* ((min (or (save-excursion (newsticker--buffer-beginning-of-item))
1643                     (point-min)))
1644            (max (or (save-excursion (newsticker--buffer-end-of-item))
1645                     (point-max))))
1646       (narrow-to-region min max)))
1647   (sit-for 0)
1648   ;; do not count lines and stuff because that does not work when images
1649   ;; are displayed. Do it the simple way:
1650   (save-excursion
1651     (newsticker--buffer-end-of-item)
1652     (unless (pos-visible-in-window-p)
1653       (recenter -1)))
1654   (unless (pos-visible-in-window-p)
1655     (recenter 0)))
1656
1657 (defun newsticker--buffer-get-feed-title-at-point ()
1658   "Return feed symbol of headline at point."
1659   (format "%s" (or (get-text-property (point) 'feed) " ")))
1660
1661 (defun newsticker--buffer-get-item-title-at-point ()
1662   "Return feed symbol of headline at point."
1663   (format "%s" (or (get-text-property (point) 'nt-title) " ")))
1664
1665 (defun newsticker--buffer-goto (types &optional age backwards)
1666   "Search next occurrence of TYPES in current buffer.
1667 TYPES is a list of symbols.  If TYPES is found point is moved, if
1668 not point is left unchanged.  If optional parameter AGE is not
1669 nil, the type AND the age must match.  If BACKWARDS is t, search
1670 backwards."
1671   (let ((pos (save-excursion
1672                (save-restriction
1673                  (widen)
1674                  (catch 'found
1675                    (let ((tpos (point)))
1676                      (while (setq tpos
1677                                   (if backwards
1678                                       (if (eq tpos (point-min))
1679                                           nil
1680                                         (or (previous-single-property-change
1681                                              tpos 'nt-type)
1682                                             (point-min)))
1683                                     (next-single-property-change
1684                                      tpos 'nt-type)))
1685                        (and (memq (get-text-property tpos 'nt-type) types)
1686                             (or (not age)
1687                                 (eq (get-text-property tpos 'nt-age) age))
1688                             (throw 'found tpos)))))))))
1689     (when pos
1690       (goto-char pos))
1691     pos))
1692
1693 (defun newsticker--buffer-hideshow (mark-age onoff)
1694   "Hide or show items of type MARK-AGE.
1695 If ONOFF is nil the item is hidden, otherwise it is shown."
1696   (if onoff
1697       (remove-from-invisibility-spec mark-age)
1698     (add-to-invisibility-spec mark-age)))
1699
1700 (defun newsticker--buffer-beginning-of-item ()
1701   "Move point to the beginning of the item at point.
1702 Return new position."
1703   (if (bobp)
1704       (point)
1705     (let ((type (get-text-property (point) 'nt-type))
1706           (typebefore (get-text-property (1- (point)) 'nt-type)))
1707       (if (and (memq type '(item feed))
1708                    (not (eq type typebefore)))
1709           (point)
1710         (newsticker--buffer-goto '(item feed) nil t)
1711         (point)))))
1712
1713 (defun newsticker--buffer-beginning-of-feed ()
1714   "Move point to the beginning of the feed at point.
1715 Return new position."
1716   (if (bobp)
1717       (point)
1718     (let ((type (get-text-property (point) 'nt-type))
1719           (typebefore (get-text-property (1- (point)) 'nt-type)))
1720       (if (and (memq type '(feed))
1721                    (not (eq type typebefore)))
1722           (point)
1723         (newsticker--buffer-goto '(feed) nil t)
1724         (point)))))
1725
1726 (defun newsticker--buffer-end-of-item ()
1727   "Move point to the end of the item at point.
1728 Take care: end of item is at the end of its last line!"
1729   (when (newsticker--buffer-goto '(item feed nil))
1730     (point)))
1731
1732 (defun newsticker--buffer-end-of-feed ()
1733   "Move point to the end of the last item of the feed at point.
1734 Take care: end of item is at the end of its last line!"
1735   (when (newsticker--buffer-goto '(feed nil))
1736     (backward-char 1)
1737     (point)))
1738
1739 ;; ======================================================================
1740 ;;; misc
1741 ;; ======================================================================
1742
1743 (defun newsticker-mouse-browse-url (event)
1744   "Call `browse-url' for the link of the item at which the EVENT occurred."
1745   (interactive "e")
1746   (save-excursion
1747     (switch-to-buffer (window-buffer (posn-window (event-end event))))
1748     (let ((url (get-text-property (posn-point (event-end event))
1749                                   'nt-link)))
1750       (when url
1751         (browse-url url)
1752         (save-excursion
1753           (goto-char (posn-point (event-end event)))
1754           (if newsticker-automatically-mark-visited-items-as-old
1755               (newsticker-mark-item-at-point-as-read t)))))))
1756
1757 (defun newsticker-browse-url ()
1758   "Call `browse-url' for the link of the item at point."
1759   (interactive)
1760   (let ((url (get-text-property (point) 'nt-link)))
1761     (when url
1762       (browse-url url)
1763       (if newsticker-automatically-mark-visited-items-as-old
1764           (newsticker-mark-item-at-point-as-read t)))))
1765
1766 (defvar newsticker-open-url-history
1767   '("wget" "xmms" "realplay")
1768   "...")
1769
1770 (defun newsticker-handle-url ()
1771   "Ask for a program to open the link of the item at point."
1772   (interactive)
1773   (let ((url (get-text-property (point) 'nt-link)))
1774     (when url
1775       (let ((prog (read-string "Open url with: " nil
1776                                'newsticker-open-url-history)))
1777         (when prog
1778           (message "%s %s" prog url)
1779           (start-process prog prog prog url)
1780       (if newsticker-automatically-mark-visited-items-as-old
1781           (newsticker-mark-item-at-point-as-read t)))))))
1782
1783
1784 ;; ======================================================================
1785 ;;; Misc
1786 ;; ======================================================================
1787
1788 (defun newsticker--cache-sort ()
1789   "Sort the newsticker cache data."
1790   (let ((sort-fun (cond ((eq newsticker-sort-method 'sort-by-time)
1791                          'newsticker--cache-item-compare-by-time)
1792                         ((eq newsticker-sort-method 'sort-by-title)
1793                          'newsticker--cache-item-compare-by-title)
1794                         ((eq newsticker-sort-method 'sort-by-original-order)
1795                          'newsticker--cache-item-compare-by-position))))
1796     (mapc (lambda (feed-list)
1797             (setcdr feed-list (sort (cdr feed-list)
1798                                     sort-fun)))
1799           newsticker--cache)))
1800
1801 (provide 'newst-plainview)
1802
1803 ;;; newst-plainview.el ends here