shr.el 38.8 KB
Newer Older
1 2
;;; shr.el --- Simple HTML Renderer

3
;; Copyright (C) 2010-2011 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: html

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This package takes a HTML parse tree (as provided by
;; libxml-parse-html-region) and renders it in the current buffer.  It
;; does not do CSS, JavaScript or anything advanced: It's geared
;; towards rendering typical short snippets of HTML, like what you'd
;; find in HTML email and the like.

;;; Code:

33
(eval-when-compile (require 'cl))
34 35
(require 'browse-url)

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
(defgroup shr nil
  "Simple HTML Renderer"
  :group 'mail)

(defcustom shr-max-image-proportion 0.9
  "How big pictures displayed are in relation to the window they're in.
A value of 0.7 means that they are allowed to take up 70% of the
width and height of the window.  If they are larger than this,
and Emacs supports it, then the images will be rescaled down to
fit these criteria."
  :version "24.1"
  :group 'shr
  :type 'float)

(defcustom shr-blocked-images nil
  "Images that have URLs matching this regexp will be blocked."
  :version "24.1"
  :group 'shr
  :type 'regexp)

56 57 58 59 60 61 62
(defcustom shr-table-horizontal-line ?-
  "Character used to draw horizontal table lines."
  :group 'shr
  :type 'character)

(defcustom shr-table-vertical-line ?|
  "Character used to draw vertical table lines."
63
  :group 'shr
64
  :type 'character)
65 66

(defcustom shr-table-corner ?+
67
  "Character used to draw table corners."
68
  :group 'shr
69
  :type 'character)
70 71

(defcustom shr-hr-line ?-
72
  "Character used to draw hr lines."
73
  :group 'shr
74
  :type 'character)
75

76
(defcustom shr-width fill-column
77 78 79 80 81 82
  "Frame width to use for rendering.
May either be an integer specifying a fixed width in characters,
or nil, meaning that the full width of the window should be
used."
  :type '(choice (integer :tag "Fixed width in characters")
		 (const   :tag "Use the width of the window" nil))
83 84
  :group 'shr)

85 86 87 88 89
(defvar shr-content-function nil
  "If bound, this should be a function that will return the content.
This is used for cid: URLs, and the function is called with the
cid: URL as the argument.")

90 91
;;; Internal variables.

92 93 94
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
95
(defvar shr-indentation 0)
96
(defvar shr-inhibit-images nil)
97
(defvar shr-list-mode nil)
98
(defvar shr-content-cache nil)
99
(defvar shr-kinsoku-shorten nil)
100
(defvar shr-table-depth 0)
101
(defvar shr-stylesheet nil)
102

103 104 105 106 107 108 109
(defvar shr-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'shr-show-alt-text)
    (define-key map "i" 'shr-browse-image)
    (define-key map "I" 'shr-insert-image)
    (define-key map "u" 'shr-copy-url)
    (define-key map "v" 'shr-browse-url)
110
    (define-key map "o" 'shr-save-contents)
111 112 113
    (define-key map "\r" 'shr-browse-url)
    map))

114 115 116 117
;; Public functions and commands.

;;;###autoload
(defun shr-insert-document (dom)
118
  (setq shr-content-cache nil)
119
  (let ((shr-state nil)
120 121
	(shr-start nil)
	(shr-width (or shr-width (window-width))))
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
    (shr-descend (shr-transform-dom dom))))

(defun shr-copy-url ()
  "Copy the URL under point to the kill ring.
If called twice, then try to fetch the URL and see whether it
redirects somewhere else."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
    (cond
     ((not url)
      (message "No URL under point"))
     ;; Resolve redirected URLs.
     ((equal url (car kill-ring))
      (url-retrieve
       url
       (lambda (a)
	 (when (and (consp a)
		    (eq (car a) :redirect))
	   (with-temp-buffer
	     (insert (cadr a))
	     (goto-char (point-min))
	     ;; Remove common tracking junk from the URL.
	     (when (re-search-forward ".utm_.*" nil t)
	       (replace-match "" t t))
	     (message "Copied %s" (buffer-string))
	     (copy-region-as-kill (point-min) (point-max)))))))
     ;; Copy the URL to the kill ring.
     (t
      (with-temp-buffer
	(insert url)
	(copy-region-as-kill (point-min) (point-max))
	(message "Copied %s" url))))))

(defun shr-show-alt-text ()
  "Show the ALT text of the image under point."
  (interactive)
  (let ((text (get-text-property (point) 'shr-alt)))
    (if (not text)
	(message "No image under point")
      (message "%s" text))))

(defun shr-browse-image ()
  "Browse the image under point."
  (interactive)
166
  (let ((url (get-text-property (point) 'image-url)))
167 168 169 170 171
    (if (not url)
	(message "No image under point")
      (message "Browsing %s..." url)
      (browse-url url))))

172 173 174
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
175
  (let ((url (get-text-property (point) 'image-url)))
176 177 178 179 180 181 182
    (if (not url)
	(message "No image under point")
      (message "Inserting %s..." url)
      (url-retrieve url 'shr-image-fetched
		    (list (current-buffer) (1- (point)) (point-marker))
		    t))))

183 184
;;; Utility functions.

185 186 187 188 189 190 191 192
(defun shr-transform-dom (dom)
  (let ((result (list (pop dom))))
    (dolist (arg (pop dom))
      (push (cons (intern (concat ":" (symbol-name (car arg))) obarray)
		  (cdr arg))
	    result))
    (dolist (sub dom)
      (if (stringp sub)
193
	  (push (cons 'text sub) result)
194 195 196 197
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

(defun shr-descend (dom)
198 199
  (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray))
	(style (cdr (assq :style (cdr dom))))
200
	(shr-stylesheet shr-stylesheet)
201
	(start (point)))
202 203 204 205 206
    (when style
      (if (string-match "color" style)
	  (setq shr-stylesheet (nconc (shr-parse-style style)
				      shr-stylesheet))
	(setq style nil)))
207 208
    (if (fboundp function)
	(funcall function (cdr dom))
209
      (shr-generic (cdr dom)))
210 211 212 213 214
    ;; If style is set, then this node has set the color.
    (when style
      (shr-colorize-region start (point)
			   (cdr (assq 'color shr-stylesheet))
			   (cdr (assq 'background-color shr-stylesheet))))))
215 216 217 218

(defun shr-generic (cont)
  (dolist (sub cont)
    (cond
219
     ((eq (car sub) 'text)
220
      (shr-insert (cdr sub)))
221
     ((listp (cdr sub))
222 223
      (shr-descend sub)))))

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
(defmacro shr-char-breakable-p (char)
  "Return non-nil if a line can be broken before and after CHAR."
  `(aref fill-find-break-point-function-table ,char))
(defmacro shr-char-nospace-p (char)
  "Return non-nil if no space is required before and after CHAR."
  `(aref fill-nospace-between-words-table ,char))

;; KINSOKU is a Japanese word meaning a rule that should not be violated.
;; In Emacs, it is a term used for characters, e.g. punctuation marks,
;; parentheses, and so on, that should not be placed in the beginning
;; of a line or the end of a line.
(defmacro shr-char-kinsoku-bol-p (char)
  "Return non-nil if a line ought not to begin with CHAR."
  `(aref (char-category-set ,char) ?>))
(defmacro shr-char-kinsoku-eol-p (char)
  "Return non-nil if a line ought not to end with CHAR."
  `(aref (char-category-set ,char) ?<))
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
  (load "kinsoku" nil t))

244
(defun shr-insert (text)
245 246
  (when (and (eq shr-state 'image)
	     (not (string-match "\\`[ \t\n]+\\'" text)))
247 248 249 250 251 252
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
253 254 255 256 257 258 259 260 261
    (when (and (string-match "\\`[ \t\n]" text)
	       (not (bolp))
	       (not (eq (char-after (1- (point))) ? )))
      (insert " "))
    (dolist (elem (split-string text))
      (when (and (bolp)
		 (> shr-indentation 0))
	(shr-indent))
      ;; No space is needed behind a wide character categorized as
262 263
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
264
      (let (prev)
265 266
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
267
		   (or (= (line-beginning-position) (1- (point)))
268 269 270 271 272
		       (and (shr-char-breakable-p
			     (setq prev (char-after (- (point) 2))))
			    (shr-char-kinsoku-bol-p prev))
		       (and (shr-char-nospace-p prev)
			    (shr-char-nospace-p (aref elem 0)))))
273
	  (delete-char -1)))
274 275 276 277 278
      ;; The shr-start is a special variable that is used to pass
      ;; upwards the first point in the buffer where the text really
      ;; starts.
      (unless shr-start
	(setq shr-start (point)))
279
      (insert elem)
280 281 282 283
      (let (found)
	(while (and (> (current-column) shr-width)
		    (progn
		      (setq found (shr-find-fill-point))
284
		      (not (eolp))))
285 286 287 288
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
289 290 291 292 293 294 295 296
	    (put-text-property (1- (point)) (point) 'shr-break t)
	    ;; No space is needed at the beginning of a line.
	    (when (eq (following-char) ? )
	      (delete-char 1)))
	  (when (> shr-indentation 0)
	    (shr-indent))
	  (end-of-line))
	(insert " ")))
297 298
    (unless (string-match "[ \t\n]\\'" text)
      (delete-char -1)))))
299

300
(defun shr-find-fill-point ()
301 302
  (when (> (move-to-column shr-width) shr-width)
    (backward-char 1))
303 304 305 306 307 308 309
  (let ((bp (point))
	failed)
    (while (not (or (setq failed (= (current-column) shr-indentation))
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
310 311 312 313
		    (if (eq (preceding-char) ?')
			(not (memq (char-after (- (point) 2))
				   (list nil ?\n ? )))
		      (and (shr-char-kinsoku-bol-p (preceding-char))
314
			   (shr-char-breakable-p (following-char))
315
			   (not (shr-char-kinsoku-bol-p (following-char)))))
316
		    (shr-char-kinsoku-eol-p (following-char))))
317
      (backward-char 1))
318 319 320 321 322 323 324
    (if (and (not (or failed (eolp)))
	     (eq (preceding-char) ?'))
	(while (not (or (setq failed (eolp))
			(eq (following-char) ? )
			(shr-char-breakable-p (following-char))
			(shr-char-kinsoku-eol-p (following-char))))
	  (forward-char 1)))
325
    (if failed
326
	;; There's no breakable point, so we give it up.
327 328 329 330 331 332 333 334 335
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
	    (while (and (setq found (re-search-forward
				     "\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				     (line-end-position) 'move))
			(eq (preceding-char) ?')))
	    (if (and found (not (match-beginning 1)))
		(goto-char (match-beginning 0)))))
336 337
      (or
       (eolp)
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
       ;; Don't put kinsoku-bol characters at the beginning of a line,
       ;; or kinsoku-eol characters at the end of a line.
       (cond
	(shr-kinsoku-shorten
	 (while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
		     (shr-char-kinsoku-eol-p (preceding-char)))
	   (backward-char 1))
	 (when (setq failed (= (current-column) shr-indentation))
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
			 (<= (current-column) shr-width))
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
	 (if (shr-char-kinsoku-eol-p (following-char))
	     ;; There are consecutive kinsoku-eol characters.
	     (setq failed t)
	   (let ((count 4))
	     (while
		 (progn
		   (backward-char 1)
		   (and (> (setq count (1- count)) 0)
			(not (memq (preceding-char) (list ?\C-@ ?\n ? )))
			(or (shr-char-kinsoku-eol-p (preceding-char))
			    (shr-char-kinsoku-bol-p (following-char)))))))
	   (if (setq failed (= (current-column) shr-indentation))
368
	       ;; There's no breakable point that doesn't violate kinsoku,
369 370 371 372 373 374 375 376
	       ;; so we go to the second best position.
	       (if (looking-at "\\(\\c<+\\)\\c<")
		   (goto-char (match-end 1))
		 (forward-char 1)))))
	(t
	 (if (shr-char-kinsoku-bol-p (preceding-char))
	     ;; There are consecutive kinsoku-bol characters.
	     (setq failed t)
377 378
	   (let ((count 4))
	     (while (and (>= (setq count (1- count)) 0)
379 380 381 382 383 384
			 (shr-char-kinsoku-bol-p (following-char))
			 (shr-char-breakable-p (following-char)))
	       (forward-char 1))))))
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
385

386 387 388
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
389 390 391

(defun shr-ensure-paragraph ()
  (unless (bobp)
392
    (if (<= (current-column) shr-indentation)
393 394 395
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
396 397 398
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
399
	    (looking-at " *$"))
400 401 402
	  (insert "\n")
	(insert "\n\n")))))

403
(defun shr-indent ()
404 405
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
406

407
(defun shr-fontize-cont (cont &rest types)
408 409
  (let (shr-start)
    (shr-generic cont)
410 411
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
412

413 414 415
;; Add an overlay in the region, but avoid putting the font properties
;; on blank text at the start of the line, and the newline at the end,
;; to avoid ugliness.
416
(defun shr-add-font (start end type)
417 418 419 420 421 422 423 424 425 426
  (save-excursion
    (goto-char start)
    (while (< (point) end)
      (when (bolp)
	(skip-chars-forward " "))
      (let ((overlay (make-overlay (point) (min (line-end-position) end))))
	(overlay-put overlay 'face type))
      (if (< (line-end-position) end)
	  (forward-line 1)
	(goto-char end)))))
427

428 429 430 431
(defun shr-browse-url ()
  "Browse the URL under point."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
432 433 434 435
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
436
      (browse-url-mailto url))
437 438
     (t
      (browse-url url)))))
439

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
(defun shr-save-contents (directory)
  "Save the contents from URL in a file."
  (interactive "DSave contents of URL to directory: ")
  (let ((url (get-text-property (point) 'shr-url)))
    (if (not url)
	(message "No link under point")
      (url-retrieve (shr-encode-url url)
		    'shr-store-contents (list url directory)))))

(defun shr-store-contents (status url directory)
  (unless (plist-get status :error)
    (when (or (search-forward "\n\n" nil t)
	      (search-forward "\r\n\r\n" nil t))
      (write-region (point) (point-max)
		    (expand-file-name (file-name-nondirectory url)
				      directory)))))

457 458 459 460 461 462 463 464
(defun shr-image-fetched (status buffer start end)
  (when (and (buffer-name buffer)
	     (not (plist-get status :error)))
    (url-store-in-cache (current-buffer))
    (when (or (search-forward "\n\n" nil t)
	      (search-forward "\r\n\r\n" nil t))
      (let ((data (buffer-substring (point) (point-max))))
        (with-current-buffer buffer
465 466 467 468 469 470
	  (save-excursion
	    (let ((alt (buffer-substring start end))
		  (inhibit-read-only t))
	      (delete-region start end)
	      (goto-char start)
	      (shr-put-image data alt)))))))
471 472
  (kill-buffer (current-buffer)))

473
(defun shr-put-image (data alt)
474 475 476 477
  (if (display-graphic-p)
      (let ((image (ignore-errors
                     (shr-rescale-image data))))
        (when image
478 479 480 481 482
	  ;; When inserting big-ish pictures, put them at the
	  ;; beginning of the line.
	  (when (and (> (current-column) 0)
		     (> (car (image-size image t)) 400))
	    (insert "\n"))
483 484
	  (insert-image image (or alt "*"))))
    (insert alt)))
485 486 487 488 489 490

(defun shr-rescale-image (data)
  (if (or (not (fboundp 'imagemagick-types))
	  (not (get-buffer-window (current-buffer))))
      (create-image data nil t)
    (let* ((image (create-image data nil t))
491
	   (size (image-size image t))
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
	   (width (car size))
	   (height (cdr size))
	   (edges (window-inside-pixel-edges
		   (get-buffer-window (current-buffer))))
	   (window-width (truncate (* shr-max-image-proportion
				      (- (nth 2 edges) (nth 0 edges)))))
	   (window-height (truncate (* shr-max-image-proportion
				       (- (nth 3 edges) (nth 1 edges)))))
	   scaled-image)
      (when (> height window-height)
	(setq image (or (create-image data 'imagemagick t
				      :height window-height)
			image))
	(setq size (image-size image t)))
      (when (> (car size) window-width)
	(setq image (or
		     (create-image data 'imagemagick t
				   :width window-width)
		     image)))
511 512 513
      (when (and (fboundp 'create-animated-image)
		 (eq (image-type data nil t) 'gif))
	(setq image (create-animated-image data 'gif t)))
514 515
      image)))

Glenn Morris's avatar
Glenn Morris committed
516 517 518
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
519
(autoload 'browse-url-mailto "browse-url")
Glenn Morris's avatar
Glenn Morris committed
520

521 522 523 524 525
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
526
    (when (ignore-errors
527
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
528 529 530 531
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
	(buffer-substring (point) (point-max))))))
532

533 534 535 536
(defun shr-image-displayer (content-function)
  "Return a function to display an image.
CONTENT-FUNCTION is a function to retrieve an image for a cid url that
is an argument.  The function to be returned takes three arguments URL,
537
START, and END.  Note that START and END should be merkers."
538
  `(lambda (url start end)
539 540 541 542 543 544 545 546
     (when url
       (if (string-match "\\`cid:" url)
	   ,(when content-function
	      `(let ((image (funcall ,content-function
				     (substring url (match-end 0)))))
		 (when image
		   (goto-char start)
		   (shr-put-image image
547 548
				  (buffer-substring-no-properties start end))
		   (delete-region (point) end))))
549 550 551
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
		       t)))))
552

553 554 555 556 557
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

Glenn Morris's avatar
Glenn Morris committed
558 559
(autoload 'widget-convert-button "wid-edit")

560
(defun shr-urlify (start url &optional title)
561 562
  (widget-convert-button
   'url-link start (point)
563
   :help-echo (if title (format "%s (%s)" url title) url)
564 565 566 567 568 569 570 571
   :keymap shr-map
   url)
  (put-text-property start (point) 'shr-url url))

(defun shr-encode-url (url)
  "Encode URL."
  (browse-url-url-encode-chars url "[)$ ]"))

572 573
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

(defun shr-color-check (fg bg)
  "Check that FG is visible on BG.
Returns (fg bg) with corrected values.
Returns nil if the colors that would be used are the default
ones, in case fg and bg are nil."
  (when (or fg bg)
    (let ((fixed (cond ((null fg) 'fg)
                       ((null bg) 'bg))))
      ;; Convert colors to hexadecimal, or set them to default.
      (let ((fg (or (shr-color->hexadecimal fg)
                    (frame-parameter nil 'foreground-color)))
            (bg (or (shr-color->hexadecimal bg)
                    (frame-parameter nil 'background-color))))
        (cond ((eq fixed 'bg)
               ;; Only return the new fg
               (list nil (cadr (shr-color-visible bg fg t))))
              ((eq fixed 'fg)
               ;; Invert args and results and return only the new bg
               (list (cadr (shr-color-visible fg bg t)) nil))
              (t
               (shr-color-visible bg fg)))))))

597
(defun shr-colorize-region (start end fg &optional bg)
598
  (when (or fg bg)
599
    (let ((new-colors (shr-color-check fg bg)))
600
      (when new-colors
601 602
	(when fg
	  (shr-put-color start end :foreground (cadr new-colors)))
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
	(when bg
	  (shr-put-color start end :background (car new-colors)))))))

;; Put a color in the region, but avoid putting colors on on blank
;; text at the start of the line, and the newline at the end, to avoid
;; ugliness.  Also, don't overwrite any existing color information,
;; since this can be called recursively, and we want the "inner" color
;; to win.
(defun shr-put-color (start end type color)
  (save-excursion
    (goto-char start)
    (while (< (point) end)
      (when (bolp)
	(skip-chars-forward " "))
      (when (> (line-end-position) (point))
	(shr-put-color-1 (point) (min (line-end-position) end) type color))
      (if (< (line-end-position) end)
	  (forward-line 1)
621 622 623 624 625 626
	(goto-char end)))
    (when (eq type :background)
      (shr-expand-newlines start end color))))

(defun shr-expand-newlines (start end color)
  (save-restriction
627 628 629 630 631 632 633 634 635
    ;; Skip past all white space at the start and ends.
    (goto-char start)
    (skip-chars-forward " \t\n")
    (beginning-of-line)
    (setq start (point))
    (goto-char end)
    (skip-chars-backward " \t\n")
    (forward-line 1)
    (setq end (point))
636 637 638 639 640 641
    (narrow-to-region start end)
    (let ((width (shr-natural-width))
	  column)
      (goto-char (point-min))
      (while (not (eobp))
	(end-of-line)
642 643
	(when (and (< (setq column (current-column)) width)
		   (< (setq column (shr-previous-newline-padding-width column))
644
		      width))
645 646
	  (let ((overlay (make-overlay (point) (1+ (point)))))
	    (overlay-put overlay 'before-string
647 648 649
			 (concat
			  (mapconcat
			   (lambda (overlay)
650 651
			     (let ((string (getf (overlay-properties overlay)
						 'before-string)))
652 653 654 655 656 657
			       (if (not string)
				   ""
				 (overlay-put overlay 'before-string "")
				 string)))
			   (overlays-at (point))
			   "")
658
			  (propertize (make-string (- width column) ? )
659
				      'face (list :background color))))))
660
	(forward-line 1)))))
661

662 663 664 665 666 667 668 669 670 671 672
(defun shr-previous-newline-padding-width (width)
  (let ((overlays (overlays-at (point)))
	(previous-width 0))
    (if (null overlays)
	width
      (dolist (overlay overlays)
	(setq previous-width
	      (+ previous-width
		 (length (getf (overlay-properties overlay) 'before-string)))))
      (+ width previous-width))))

673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
(defun shr-put-color-1 (start end type color)
  (let* ((old-props (get-text-property start 'face))
	 (do-put (not (memq type old-props)))
	 change)
    (while (< start end)
      (setq change (next-single-property-change start 'face nil end))
      (when do-put
	(put-text-property start change 'face
			   (nconc (list type color) old-props)))
      (setq old-props (get-text-property change 'face))
      (setq do-put (not (memq type old-props)))
      (setq start change))
    (when (and do-put
	       (> end start))
      (put-text-property start end 'face
			 (nconc (list type color old-props))))))
689

690 691
;;; Tag-specific rendering rules.

692
(defun shr-tag-body (cont)
693 694 695
  (let* ((start (point))
	 (fgcolor (cdr (assq :fgcolor cont)))
	 (bgcolor (cdr (assq :bgcolor cont)))
696 697
	 (shr-stylesheet (list (cons 'color fgcolor)
			       (cons 'background-color bgcolor))))
698
    (shr-generic cont)
699
    (shr-colorize-region start (point) fgcolor bgcolor)))
700

701 702 703
(defun shr-tag-style (cont)
  )

704 705 706
(defun shr-tag-script (cont)
  )

707 708 709 710
(defun shr-tag-label (cont)
  (shr-generic cont)
  (shr-ensure-paragraph))

711 712
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
713
  (shr-indent)
714 715 716
  (shr-generic cont)
  (shr-ensure-paragraph))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
717 718 719 720 721 722
(defun shr-tag-div (cont)
  (shr-ensure-newline)
  (shr-indent)
  (shr-generic cont)
  (shr-ensure-newline))

723 724 725 726 727 728 729 730 731
(defun shr-tag-b (cont)
  (shr-fontize-cont cont 'bold))

(defun shr-tag-i (cont)
  (shr-fontize-cont cont 'italic))

(defun shr-tag-em (cont)
  (shr-fontize-cont cont 'bold))

732 733 734
(defun shr-tag-strong (cont)
  (shr-fontize-cont cont 'bold))

735 736 737 738 739 740
(defun shr-tag-u (cont)
  (shr-fontize-cont cont 'underline))

(defun shr-tag-s (cont)
  (shr-fontize-cont cont 'strike-through))

741 742
(defun shr-parse-style (style)
  (when style
743 744 745
    (save-match-data
      (when (string-match "\n" style)
        (setq style (replace-match " " t t style))))
746 747 748 749 750 751 752 753
    (let ((plist nil))
      (dolist (elem (split-string style ";"))
	(when elem
	  (setq elem (split-string elem ":"))
	  (when (and (car elem)
		     (cadr elem))
	    (let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
		  (value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
754 755
	      (when (string-match " *!important\\'" value)
		(setq value (substring value 0 (match-beginning 0))))
756 757 758 759 760
	      (push (cons (intern name obarray)
			  value)
		    plist)))))
      plist)))

761 762
(defun shr-tag-a (cont)
  (let ((url (cdr (assq :href cont)))
763
        (title (cdr (assq :title cont)))
764 765 766
	(start (point))
	shr-start)
    (shr-generic cont)
767
    (shr-urlify (or shr-start start) url title)))
768 769

(defun shr-tag-object (cont)
770 771 772 773 774 775 776 777
  (let ((start (point))
	url)
    (dolist (elem cont)
      (when (eq (car elem) 'embed)
	(setq url (or url (cdr (assq :src (cdr elem))))))
      (when (and (eq (car elem) 'param)
		 (equal (cdr (assq :name (cdr elem))) "movie"))
	(setq url (or url (cdr (assq :value (cdr elem)))))))
778 779
    (when url
      (shr-insert " [multimedia] ")
780 781 782 783 784 785 786 787 788
      (shr-urlify start url))
    (shr-generic cont)))

(defun shr-tag-video (cont)
  (let ((image (cdr (assq :poster cont)))
	(url (cdr (assq :src cont)))
	(start (point)))
    (shr-tag-img nil image)
    (shr-urlify start url)))
789

790 791 792 793
(defun shr-tag-img (cont &optional url)
  (when (or url
	    (and cont
		 (cdr (assq :src cont))))
794 795 796 797
    (when (and (> (current-column) 0)
	       (not (eq shr-state 'image)))
      (insert "\n"))
    (let ((alt (cdr (assq :alt cont)))
798
	  (url (or url (cdr (assq :src cont)))))
799 800
      (let ((start (point-marker)))
	(when (zerop (length alt))
801
	  (setq alt "*"))
802
	(cond
803 804 805 806
	 ((or (member (cdr (assq :height cont)) '("0" "1"))
	      (member (cdr (assq :width cont)) '("0" "1")))
	  ;; Ignore zero-sized or single-pixel images.
	  )
807 808 809 810 811 812 813
	 ((and (not shr-inhibit-images)
	       (string-match "\\`cid:" url))
	  (let ((url (substring url (match-end 0)))
		image)
	    (if (or (not shr-content-function)
		    (not (setq image (funcall shr-content-function url))))
		(insert alt)
814
	      (shr-put-image image alt))))
815 816 817 818 819
	 ((or shr-inhibit-images
	      (and shr-blocked-images
		   (string-match shr-blocked-images url)))
	  (setq shr-start (point))
	  (let ((shr-state 'space))
820 821
	    (if (> (string-width alt) 8)
		(shr-insert (truncate-string-to-width alt 8))
822 823
	      (shr-insert alt))))
	 ((url-is-cached (shr-encode-url url))
824
	  (shr-put-image (shr-get-image-data url) alt))
825 826 827 828 829 830 831 832
	 (t
	  (insert alt)
	  (ignore-errors
	    (url-retrieve (shr-encode-url url) 'shr-image-fetched
			  (list (current-buffer) start (point-marker))
			  t))))
	(put-text-property start (point) 'keymap shr-map)
	(put-text-property start (point) 'shr-alt alt)
833 834
	(put-text-property start (point) 'image-url url)
	(put-text-property start (point) 'image-displayer
835
			   (shr-image-displayer shr-content-function))
836
	(put-text-property start (point) 'help-echo alt)
837
	(setq shr-state 'image)))))
838 839 840 841

(defun shr-tag-pre (cont)
  (let ((shr-folding-mode 'none))
    (shr-ensure-newline)
842
    (shr-indent)
843 844 845 846 847
    (shr-generic cont)
    (shr-ensure-newline)))

(defun shr-tag-blockquote (cont)
  (shr-ensure-paragraph)
848
  (shr-indent)
849 850 851
  (let ((shr-indentation (+ shr-indentation 4)))
    (shr-generic cont))
  (shr-ensure-paragraph))
852 853 854 855

(defun shr-tag-ul (cont)
  (shr-ensure-paragraph)
  (let ((shr-list-mode 'ul))
856 857
    (shr-generic cont))
  (shr-ensure-paragraph))
858 859

(defun shr-tag-ol (cont)
860
  (shr-ensure-paragraph)
861
  (let ((shr-list-mode 1))
862 863
    (shr-generic cont))
  (shr-ensure-paragraph))
864 865

(defun shr-tag-li (cont)
866 867
  (shr-ensure-paragraph)
  (shr-indent)
868 869 870 871 872 873 874 875 876
  (let* ((bullet
	  (if (numberp shr-list-mode)
	      (prog1
		  (format "%d " shr-list-mode)
		(setq shr-list-mode (1+ shr-list-mode)))
	    "* "))
	 (shr-indentation (+ shr-indentation (length bullet))))
    (insert bullet)
    (shr-generic cont)))
877 878

(defun shr-tag-br (cont)
879
  (unless (bobp)
880 881
    (insert "\n")
    (shr-indent))
882 883 884
  (shr-generic cont))

(defun shr-tag-h1 (cont)
885
  (shr-heading cont 'bold 'underline))
886 887

(defun shr-tag-h2 (cont)
888
  (shr-heading cont 'bold))
889 890

(defun shr-tag-h3 (cont)
891
  (shr-heading cont 'italic))
892 893

(defun shr-tag-h4 (cont)
894
  (shr-heading cont))
895 896

(defun shr-tag-h5 (cont)
897
  (shr-heading cont))
898 899

(defun shr-tag-h6 (cont)
900
  (shr-heading cont))
901

902 903
(defun shr-tag-hr (cont)
  (shr-ensure-newline)
904
  (insert (make-string shr-width shr-hr-line) "\n"))
905

906 907 908
(defun shr-tag-title (cont)
  (shr-heading cont 'bold 'underline))

909
(defun shr-tag-font (cont)
910 911 912 913
  (let* ((start (point))
         (color (cdr (assq :color cont)))
         (shr-stylesheet (nconc (list (cons 'color color))
				shr-stylesheet)))
914
    (shr-generic cont)
915 916 917
    (when color
      (shr-colorize-region start (point) color
			   (cdr (assq 'background-color shr-stylesheet))))))
918

919
;;; Table rendering algorithm.
920

921 922 923 924 925 926 927 928
;; Table rendering is the only complicated thing here.  We do this by
;; first counting how many TDs there are in each TR, and registering
;; how wide they think they should be ("width=45%", etc).  Then we
;; render each TD separately (this is done in temporary buffers, so
;; that we can use all the rendering machinery as if we were in the
;; main buffer).  Now we know how much space each TD really takes, so
;; we then render everything again with the new widths, and finally
;; insert all these boxes into the main buffer.
929
(defun shr-tag-table-1 (cont)
930 931
  (setq cont (or (cdr (assq 'tbody cont))
		 cont))
932
  (let* ((shr-inhibit-images t)
933
	 (shr-table-depth (1+ shr-table-depth))
934
	 (shr-kinsoku-shorten t)
935
	 ;; Find all suggested widths.
936
	 (columns (shr-column-specs cont))
937
	 ;; Compute how many characters wide each TD should be.
938
	 (suggested-widths (shr-pro-rate-columns columns))
939 940 941
	 ;; Do a "test rendering" to see how big each TD is (this can
	 ;; be smaller (if there's little text) or bigger (if there's
	 ;; unbreakable text).
942
	 (sketch (shr-make-table cont suggested-widths))
943
	 (sketch-widths (shr-table-widths sketch suggested-widths)))
944
    ;; This probably won't work very well.
945 946 947
    (when (> (+ (loop for width across sketch-widths
		      summing (1+ width))
		shr-indentation 1)
948 949
	     (frame-width))
      (setq truncate-lines t))
950
    ;; Then render the table again with these new "hard" widths.
951
    (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths))
952 953 954
  ;; Finally, insert all the images after the table.  The Emacs buffer
  ;; model isn't strong enough to allow us to put the images actually
  ;; into the tables.
955 956 957
  (when (zerop shr-table-depth)
    (dolist (elem (shr-find-elements cont 'img))
      (shr-tag-img (cdr elem)))))
958

959 960 961 962 963 964
(defun shr-tag-table (cont)
  (shr-ensure-paragraph)
  (let* ((caption (cdr (assq 'caption cont)))
	 (header (cdr (assq 'thead cont)))
	 (body (or (cdr (assq 'tbody cont)) cont))
	 (footer (cdr (assq 'tfoot cont)))
965
         (bgcolor (cdr (assq :bgcolor cont)))
966 967 968
	 (start (point))
	 (shr-stylesheet (nconc (list (cons 'background-color bgcolor))
				shr-stylesheet))
969 970 971 972
	 (nheader (if header (shr-max-columns header)))
	 (nbody (if body (shr-max-columns body)))
	 (nfooter (if footer (shr-max-columns footer))))
    (shr-tag-table-1
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
     (nconc
      (if caption `((tr (td ,@caption))))
      (if header
	  (if footer
	      ;; hader + body + footer
	      (if (= nheader nbody)
		  (if (= nbody nfooter)
		      `((tr (td (table (tbody ,@header ,@body ,@footer)))))
		    (nconc `((tr (td (table (tbody ,@header ,@body)))))
			   (if (= nfooter 1)
			       footer
			     `((tr (td (table (tbody ,@footer))))))))
		(nconc `((tr (td (table (tbody ,@header)))))
		       (if (= nbody nfooter)
			   `((tr (td (table (tbody ,@body ,@footer)))))
			 (nconc `((tr (td (table (tbody ,@body)))))
				(if (= nfooter 1)
				    footer
				  `((tr (td (table (tbody ,@footer))))))))))
	    ;; header + body
	    (if (= nheader nbody)
		`((tr (td (table (tbody ,@header ,@body)))))
	      (if (= nheader 1)
		  `(,@header (tr (td (table (tbody ,@body)))))
		`((tr (td (table (tbody ,@header))))
		  (tr (td (table (tbody ,@body))))))))
	(if footer
	    ;; body + footer
	    (if (= nbody nfooter)
		`((tr (td (table (tbody ,@body ,@footer)))))
	      (nconc `((tr (td (table (tbody ,@body)))))
1004
		     (if (= nfooter 1)
1005 1006 1007 1008
			 footer
		       `((tr (td (table (tbody ,@footer))))))))
	  (if caption
	      `((tr (td (table (tbody ,@body)))))
1009 1010 1011 1012
	    body)))))
    (when bgcolor
      (shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
			   bgcolor))))
1013

1014 1015 1016 1017 1018 1019 1020 1021
(defun shr-find-elements (cont type)
  (let (result)
    (dolist (elem cont)
      (cond ((eq (car elem) type)
	     (push elem result))
	    ((consp (cdr elem))
	     (setq result (nconc (shr-find-elements (cdr elem) type) result)))))
    (nreverse result)))
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032

(defun shr-insert-table (table widths)
  (shr-insert-table-ruler widths)
  (dolist (row table)
    (let ((start (point))
	  (height (let ((max 0))
		    (dolist (column row)
		      (setq max (max max (cadr column))))
		    max)))
      (dotimes (i height)
	(shr-indent)
1033
	(insert shr-table-vertical-line "\n"))
1034 1035
      (dolist (column row)
	(goto-char start)
1036
	(let ((lines (nth 2 column))
1037 1038
	      (overlay-lines (nth 3 column))
	      overlay overlay-line)
1039
	  (dolist (line lines)
1040
	    (setq overlay-line (pop overlay-lines))
1041
	    (end-of-line)
1042
	    (insert line shr-table-vertical-line)
1043 1044 1045 1046 1047 1048 1049
	    (dolist (overlay overlay-line)
	      (let ((o (make-overlay (- (point) (nth 0 overlay) 1)
				     (- (point) (nth 1 overlay) 1)))
		    (properties (nth 2 overlay)))
		(while properties
		  (overlay-put o (pop properties) (pop properties)))))
	    (forward-line 1))
1050 1051 1052 1053
	  ;; Add blank lines at padding at the bottom of the TD,
	  ;; possibly.
	  (dotimes (i (- height (length lines)))
	    (end-of-line)
1054 1055
	    (insert (make-string (string-width (car lines)) ? )
		    shr-table-vertical-line)
1056 1057 1058 1059
	    (forward-line 1)))))
    (shr-insert-table-ruler widths)))

(defun shr-insert-table-ruler (widths)
1060 1061 1062
  (when (and (bolp)
	     (> shr-indentation 0))
    (shr-indent))
1063
  (insert shr-table-corner)
1064
  (dotimes (i (length widths))
1065 1066
    (insert (make-string (aref widths i) shr-table-horizontal-line)
	    shr-table-corner))
1067 1068
  (insert "\n"))

1069 1070 1071 1072
(defun shr-table-widths (table suggested-widths)
  (let* ((length (length suggested-widths))
	 (widths (make-vector length 0))
	 (natural-widths (make-vector length 0)))
1073 1074 1075 1076 1077
    (dolist (row table)
      (let ((i 0))
	(dolist (column row)
	  (aset widths i (max (aref widths i)
			      (car column)))
1078 1079 1080
	  (aset natural-widths i (max (aref natural-widths i)
				      (cadr column)))
	  (setq i (1+ i)))))
1081 1082
    (let ((extra (- (apply '+ (append suggested-widths nil))
		    (apply '+ (append widths nil))))
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	  (expanded-columns 0))
      (when (> extra 0)
	(dotimes (i length)
	  ;; If the natural width is wider than the rendered width, we
	  ;; want to allow the column to expand.
	  (when (> (aref natural-widths i) (aref widths i))
	    (setq expanded-columns (1+ expanded-columns))))
	(dotimes (i length)
	  (when (> (aref natural-widths i) (aref widths i))
	    (aset widths i (min
			    (1+ (aref natural-widths i))
			    (+ (/ extra expanded-columns)
			       (aref widths i))))))))
1096 1097 1098 1099 1100 1101
    widths))

(defun shr-make-table (cont widths &optional fill)
  (let ((trs nil))
    (dolist (row cont)
      (when (eq (car row) 'tr)
1102 1103 1104 1105 1106 1107 1108 1109
	(let ((tds nil)
	      (columns (cdr row))
	      (i 0)
	      column)
	  (while (< i (length widths))
	    (setq column (pop columns))
	    (when (or (memq (car column) '(td th))
		      (null column))
1110 1111 1112 1113 1114 1115 1116
	      (push (shr-render-td (cdr column) (aref widths i) fill)
		    tds)
	      (setq i (1+ i))))
	  (push (nreverse tds) trs))))
    (nreverse trs)))

(defun shr-render-td (cont width fill)
1117
  (with-temp-buffer
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
    (let ((bgcolor (cdr (assq :bgcolor cont)))
	  (fgcolor (cdr (assq :fgcolor cont)))
	  (style (cdr (assq :style cont)))
	  (shr-stylesheet shr-stylesheet)
	  overlays)
      (when style
	(setq style (and (string-match "color" style)
			 (shr-parse-style style))))
      (when bgcolor
	(setq style (nconc (list (cons 'background-color bgcolor)) style)))
      (when fgcolor
	(setq style (nconc (list (cons 'color fgcolor)) style)))
      (when style
	(setq shr-stylesheet (append style shr-stylesheet)))
      (let ((cache (cdr (assoc (cons width cont) shr-content-cache))))
	(if cache
	    (progn
	      (insert (car cache))
	      (let ((end (length (car cache))))
		(dolist (overlay (cadr cache))
		  (let ((new-overlay
			 (make-overlay (1+ (- end (nth 0 overlay)))
				       (1+ (- end (nth 1 overlay)))))
			(properties (nth 2 overlay)))
		    (while properties
		      (overlay-put new-overlay
				   (pop properties) (pop properties)))))))
	  (let ((shr-width width)
		(shr-indentation 0))
	    (shr-descend (cons 'td cont)))
	  (delete-region
	   (point)
	   (+ (point)
	      (skip-chars-backward " \t\n")))
	  (push (list (cons width cont) (buffer-string)
		      (shr-overlays-in-region (point-min) (point-max)))
		shr-content-cache)))
      (goto-char (point-min))
      (let ((max 0))
	(while (not (eobp))
	  (end-of-line)
	  (setq max (max max (current-column)))
	  (forward-line 1))
	(when fill
	  (goto-char (point-min))
	  ;; If the buffer is totally empty, then put a single blank
	  ;; line here.
	  (if (zerop (buffer-size))
	      (insert (make-string width ? ))
	    ;; Otherwise, fill the buffer.
	    (while (not (eobp))
	      (end-of-line)
	      (when (> (- width (current-column)) 0)
		(insert (make-string (- width (current-column)) ? )))
	      (forward-line 1))))
	(when style
	  (shr-colorize-region
	   (point-min) (point-max)
	   (cdr (assq 'color shr-stylesheet))
	   (cdr (assq 'background-color shr-stylesheet))))
	(if fill
	    (list max
		  (count-lines (point-min) (point-max))
		  (split-string (buffer-string) "\n")
		  (shr-collect-overlays))
1183
	  (list max
1184
		(shr-natural-width)))))))
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

(defun shr-natural-width ()
  (goto-char (point-min))
  (let ((current 0)
	(max 0))
    (while (not (eobp))
      (end-of-line)
      (setq current (+ current (current-column)))
      (unless (get-text-property (point) 'shr-break)
	(setq max (max max current)
	      current 0))
      (forward-line 1))
    max))
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220

(defun shr-collect-overlays ()
  (save-excursion
    (goto-char (point-min))
    (let ((overlays nil))
      (while (not (eobp))
	(push (shr-overlays-in-region (point) (line-end-position))
	      overlays)
	(forward-line 1))
      (nreverse overlays))))

(defun shr-overlays-in-region (start end)
  (let (result)
    (dolist (overlay (overlays-in start end))
      (push (list (if (> start (overlay-start overlay))
		      (- end start)
		    (- end (overlay-start overlay)))
		  (if (< end (overlay-end overlay))
		      0
		    (- end (overlay-end overlay)))
		  (overlay-properties overlay))
	    result))
    (nreverse result)))
1221 1222 1223 1224 1225

(defun shr-pro-rate-columns (columns)
  (let ((total-percentage 0)
	(widths (make-vector (length columns) 0)))
    (dotimes (i (length columns))
1226
      (setq total-percentage (+ total-percentage (aref columns i))))
Gnus developers's avatar