shr.el 39.4 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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
(defface shr-tag-h1 '((t (:bold t :height 2.2)))
  "Face used for H1 tags."
  :group 'shr)

(defface shr-tag-h2 '((t (:bold t :height 2.0)))
  "Face used for H2 tags."
  :group 'shr)

(defface shr-tag-h3 '((t (:bold t :height 1.8)))
  "Face used for H3 tags."
  :group 'shr)

(defface shr-tag-h4 '((t (:bold t :height 1.6)))
  "Face used for H4 tags."
  :group 'shr)

(defface shr-tag-h5 '((t (:bold t :height 1.4)))
  "Face used for H5 tags."
  :group 'shr)

(defface shr-tag-h6 '((t (:bold t :height 1.2)))
  "Face used for H6 tags."
  :group 'shr)

109 110 111 112 113
(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.")

114 115
;;; Internal variables.

116 117 118
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
119
(defvar shr-indentation 0)
120
(defvar shr-inhibit-images nil)
121
(defvar shr-list-mode nil)
122
(defvar shr-content-cache nil)
123
(defvar shr-kinsoku-shorten nil)
124
(defvar shr-table-depth 0)
125
(defvar shr-stylesheet nil)
126

127 128 129 130 131 132 133
(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)
134
    (define-key map "o" 'shr-save-contents)
135 136 137
    (define-key map "\r" 'shr-browse-url)
    map))

138 139 140 141
;; Public functions and commands.

;;;###autoload
(defun shr-insert-document (dom)
142
  (setq shr-content-cache nil)
143
  (let ((shr-state nil)
144 145
	(shr-start nil)
	(shr-width (or shr-width (window-width))))
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
    (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)
190
  (let ((url (get-text-property (point) 'image-url)))
191 192 193 194 195
    (if (not url)
	(message "No image under point")
      (message "Browsing %s..." url)
      (browse-url url))))

196 197 198
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
199
  (let ((url (get-text-property (point) 'image-url)))
200 201 202 203 204 205 206
    (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))))

207 208
;;; Utility functions.

209 210 211 212 213 214 215 216
(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)
217
	  (push (cons 'text sub) result)
218 219 220 221
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

(defun shr-descend (dom)
222 223
  (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray))
	(style (cdr (assq :style (cdr dom))))
224
	(shr-stylesheet shr-stylesheet)
225
	(start (point)))
226 227 228 229 230
    (when style
      (if (string-match "color" style)
	  (setq shr-stylesheet (nconc (shr-parse-style style)
				      shr-stylesheet))
	(setq style nil)))
231 232
    (if (fboundp function)
	(funcall function (cdr dom))
233
      (shr-generic (cdr dom)))
234 235 236 237 238
    ;; 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))))))
239 240 241 242

(defun shr-generic (cont)
  (dolist (sub cont)
    (cond
243
     ((eq (car sub) 'text)
244
      (shr-insert (cdr sub)))
245
     ((listp (cdr sub))
246 247
      (shr-descend sub)))))

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
(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))

268
(defun shr-insert (text)
269 270
  (when (and (eq shr-state 'image)
	     (not (string-match "\\`[ \t\n]+\\'" text)))
271 272 273 274 275 276
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
277 278 279 280 281 282 283 284 285
    (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
286 287
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
288
      (let (prev)
289 290
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
291
		   (or (= (line-beginning-position) (1- (point)))
292 293 294 295 296
		       (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)))))
297
	  (delete-char -1)))
298 299 300 301 302
      ;; 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)))
303
      (insert elem)
304 305 306 307
      (let (found)
	(while (and (> (current-column) shr-width)
		    (progn
		      (setq found (shr-find-fill-point))
308
		      (not (eolp))))
309 310 311 312
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
313 314 315 316 317 318 319 320
	    (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 " ")))
321 322
    (unless (string-match "[ \t\n]\\'" text)
      (delete-char -1)))))
323

324
(defun shr-find-fill-point ()
325 326
  (when (> (move-to-column shr-width) shr-width)
    (backward-char 1))
327 328 329 330 331 332 333
  (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))
334 335 336 337
		    (if (eq (preceding-char) ?')
			(not (memq (char-after (- (point) 2))
				   (list nil ?\n ? )))
		      (and (shr-char-kinsoku-bol-p (preceding-char))
338
			   (shr-char-breakable-p (following-char))
339
			   (not (shr-char-kinsoku-bol-p (following-char)))))
340
		    (shr-char-kinsoku-eol-p (following-char))))
341
      (backward-char 1))
342 343 344 345 346 347 348
    (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)))
349
    (if failed
350
	;; There's no breakable point, so we give it up.
351 352 353 354 355 356 357 358 359
	(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)))))
360 361
      (or
       (eolp)
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
       ;; 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))
392
	       ;; There's no breakable point that doesn't violate kinsoku,
393 394 395 396 397 398 399 400
	       ;; 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)
401 402
	   (let ((count 4))
	     (while (and (>= (setq count (1- count)) 0)
403 404 405 406 407 408
			 (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)))
409

410 411 412
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
413 414 415

(defun shr-ensure-paragraph ()
  (unless (bobp)
416
    (if (<= (current-column) shr-indentation)
417 418 419
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
420 421 422
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
423
	    (looking-at " *$"))
424 425 426
	  (insert "\n")
	(insert "\n\n")))))

427
(defun shr-indent ()
428 429
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
430

431
(defun shr-fontize-cont (cont &rest types)
432 433
  (let (shr-start)
    (shr-generic cont)
434 435
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
436

437 438 439
;; 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.
440
(defun shr-add-font (start end type)
441 442 443 444 445 446 447 448 449 450
  (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)))))
451

452 453 454 455
(defun shr-browse-url ()
  "Browse the URL under point."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
456 457 458 459
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
460
      (browse-url-mailto url))
461 462
     (t
      (browse-url url)))))
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
(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)))))

481 482 483 484 485 486 487 488
(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
489 490 491 492 493 494
	  (save-excursion
	    (let ((alt (buffer-substring start end))
		  (inhibit-read-only t))
	      (delete-region start end)
	      (goto-char start)
	      (shr-put-image data alt)))))))
495 496
  (kill-buffer (current-buffer)))

497
(defun shr-put-image (data alt)
498 499 500 501
  (if (display-graphic-p)
      (let ((image (ignore-errors
                     (shr-rescale-image data))))
        (when image
502 503 504 505 506
	  ;; 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"))
507 508
	  (insert-image image (or alt "*"))))
    (insert alt)))
509 510 511 512 513 514

(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))
515
	   (size (image-size image t))
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
	   (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)))
535 536 537
      (when (and (fboundp 'create-animated-image)
		 (eq (image-type data nil t) 'gif))
	(setq image (create-animated-image data 'gif t)))
538 539
      image)))

Glenn Morris's avatar
Glenn Morris committed
540 541 542
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
543
(autoload 'browse-url-mailto "browse-url")
Glenn Morris's avatar
Glenn Morris committed
544

545 546 547 548 549
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
550
    (when (ignore-errors
551
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
552 553 554 555
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
	(buffer-substring (point) (point-max))))))
556

557 558 559 560
(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,
561
START, and END.  Note that START and END should be merkers."
562
  `(lambda (url start end)
563 564 565 566 567 568 569 570
     (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
571 572
				  (buffer-substring-no-properties start end))
		   (delete-region (point) end))))
573 574 575
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
		       t)))))
576

577 578 579 580 581
(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
582 583
(autoload 'widget-convert-button "wid-edit")

584
(defun shr-urlify (start url &optional title)
585 586
  (widget-convert-button
   'url-link start (point)
587
   :help-echo (if title (format "%s (%s)" url title) url)
588 589 590 591 592 593 594 595
   :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 "[)$ ]"))

596 597
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620

(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)))))))

621
(defun shr-colorize-region (start end fg &optional bg)
622
  (when (or fg bg)
623
    (let ((new-colors (shr-color-check fg bg)))
624
      (when new-colors
625 626
	(when fg
	  (shr-put-color start end :foreground (cadr new-colors)))
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
	(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)
645 646 647 648 649 650
	(goto-char end)))
    (when (eq type :background)
      (shr-expand-newlines start end color))))

(defun shr-expand-newlines (start end color)
  (save-restriction
651 652 653 654 655 656 657 658 659
    ;; 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))
660 661 662 663 664 665
    (narrow-to-region start end)
    (let ((width (shr-natural-width))
	  column)
      (goto-char (point-min))
      (while (not (eobp))
	(end-of-line)
666 667
	(when (and (< (setq column (current-column)) width)
		   (< (setq column (shr-previous-newline-padding-width column))
668
		      width))
669 670
	  (let ((overlay (make-overlay (point) (1+ (point)))))
	    (overlay-put overlay 'before-string
671 672 673
			 (concat
			  (mapconcat
			   (lambda (overlay)
674 675
			     (let ((string (getf (overlay-properties overlay)
						 'before-string)))
676 677 678 679 680 681
			       (if (not string)
				   ""
				 (overlay-put overlay 'before-string "")
				 string)))
			   (overlays-at (point))
			   "")
682
			  (propertize (make-string (- width column) ? )
683
				      'face (list :background color))))))
684
	(forward-line 1)))))
685

686 687 688 689 690 691 692 693 694 695 696
(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))))

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
(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))))))
713

714 715
;;; Tag-specific rendering rules.

716
(defun shr-tag-body (cont)
717 718 719
  (let* ((start (point))
	 (fgcolor (cdr (assq :fgcolor cont)))
	 (bgcolor (cdr (assq :bgcolor cont)))
720 721
	 (shr-stylesheet (list (cons 'color fgcolor)
			       (cons 'background-color bgcolor))))
722
    (shr-generic cont)
723
    (shr-colorize-region start (point) fgcolor bgcolor)))
724

725 726 727
(defun shr-tag-style (cont)
  )

728 729 730
(defun shr-tag-script (cont)
  )

731 732 733 734
(defun shr-tag-label (cont)
  (shr-generic cont)
  (shr-ensure-paragraph))

735 736
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
737
  (shr-indent)
738 739 740
  (shr-generic cont)
  (shr-ensure-paragraph))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
741 742 743 744 745 746
(defun shr-tag-div (cont)
  (shr-ensure-newline)
  (shr-indent)
  (shr-generic cont)
  (shr-ensure-newline))

747 748 749 750 751 752 753 754 755
(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))

756 757 758
(defun shr-tag-strong (cont)
  (shr-fontize-cont cont 'bold))

759 760 761 762 763 764
(defun shr-tag-u (cont)
  (shr-fontize-cont cont 'underline))

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

765 766
(defun shr-parse-style (style)
  (when style
767 768 769
    (save-match-data
      (when (string-match "\n" style)
        (setq style (replace-match " " t t style))))
770 771 772 773 774 775 776 777
    (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))))
778 779
	      (when (string-match " *!important\\'" value)
		(setq value (substring value 0 (match-beginning 0))))
780 781 782 783 784
	      (push (cons (intern name obarray)
			  value)
		    plist)))))
      plist)))

785 786
(defun shr-tag-a (cont)
  (let ((url (cdr (assq :href cont)))
787
        (title (cdr (assq :title cont)))
788 789 790
	(start (point))
	shr-start)
    (shr-generic cont)
791
    (shr-urlify (or shr-start start) url title)))
792 793

(defun shr-tag-object (cont)
794 795 796 797 798 799 800 801
  (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)))))))
802 803
    (when url
      (shr-insert " [multimedia] ")
804 805 806 807 808 809 810 811 812
      (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)))
813

814 815 816 817
(defun shr-tag-img (cont &optional url)
  (when (or url
	    (and cont
		 (cdr (assq :src cont))))
818 819 820 821
    (when (and (> (current-column) 0)
	       (not (eq shr-state 'image)))
      (insert "\n"))
    (let ((alt (cdr (assq :alt cont)))
822
	  (url (or url (cdr (assq :src cont)))))
823 824
      (let ((start (point-marker)))
	(when (zerop (length alt))
825
	  (setq alt "*"))
826
	(cond
827 828 829 830
	 ((or (member (cdr (assq :height cont)) '("0" "1"))
	      (member (cdr (assq :width cont)) '("0" "1")))
	  ;; Ignore zero-sized or single-pixel images.
	  )
831 832 833 834 835 836 837
	 ((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)
838
	      (shr-put-image image alt))))
839 840 841 842 843
	 ((or shr-inhibit-images
	      (and shr-blocked-images
		   (string-match shr-blocked-images url)))
	  (setq shr-start (point))
	  (let ((shr-state 'space))
844 845
	    (if (> (string-width alt) 8)
		(shr-insert (truncate-string-to-width alt 8))
846 847
	      (shr-insert alt))))
	 ((url-is-cached (shr-encode-url url))
848
	  (shr-put-image (shr-get-image-data url) alt))
849 850 851 852 853 854 855 856
	 (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)
857 858
	(put-text-property start (point) 'image-url url)
	(put-text-property start (point) 'image-displayer
859
			   (shr-image-displayer shr-content-function))
860
	(put-text-property start (point) 'help-echo alt)
861
	(setq shr-state 'image)))))
862 863 864 865

(defun shr-tag-pre (cont)
  (let ((shr-folding-mode 'none))
    (shr-ensure-newline)
866
    (shr-indent)
867 868 869 870 871
    (shr-generic cont)
    (shr-ensure-newline)))

(defun shr-tag-blockquote (cont)
  (shr-ensure-paragraph)
872
  (shr-indent)
873 874 875
  (let ((shr-indentation (+ shr-indentation 4)))
    (shr-generic cont))
  (shr-ensure-paragraph))
876 877 878 879

(defun shr-tag-ul (cont)
  (shr-ensure-paragraph)
  (let ((shr-list-mode 'ul))
880 881
    (shr-generic cont))
  (shr-ensure-paragraph))
882 883

(defun shr-tag-ol (cont)
884
  (shr-ensure-paragraph)
885
  (let ((shr-list-mode 1))
886 887
    (shr-generic cont))
  (shr-ensure-paragraph))
888 889

(defun shr-tag-li (cont)
890 891
  (shr-ensure-paragraph)
  (shr-indent)
892 893 894 895 896 897 898 899 900
  (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)))
901 902

(defun shr-tag-br (cont)
903
  (unless (bobp)
904 905
    (insert "\n")
    (shr-indent))
906 907 908
  (shr-generic cont))

(defun shr-tag-h1 (cont)
909
  (shr-heading cont 'shr-tag-h1))
910 911

(defun shr-tag-h2 (cont)
912
  (shr-heading cont 'shr-tag-h2))
913 914

(defun shr-tag-h3 (cont)
915
  (shr-heading cont 'shr-tag-h3))
916 917

(defun shr-tag-h4 (cont)
918
  (shr-heading cont 'shr-tag-h4))
919 920

(defun shr-tag-h5 (cont)
921
  (shr-heading cont 'shr-tag-h5))
922 923

(defun shr-tag-h6 (cont)
924
  (shr-heading cont 'shr-tag-h6))
925

926 927
(defun shr-tag-hr (cont)
  (shr-ensure-newline)
928
  (insert (make-string shr-width shr-hr-line) "\n"))
929

930 931 932
(defun shr-tag-title (cont)
  (shr-heading cont 'bold 'underline))

933
(defun shr-tag-font (cont)
934 935 936 937
  (let* ((start (point))
         (color (cdr (assq :color cont)))
         (shr-stylesheet (nconc (list (cons 'color color))
				shr-stylesheet)))
938
    (shr-generic cont)
939 940 941
    (when color
      (shr-colorize-region start (point) color
			   (cdr (assq 'background-color shr-stylesheet))))))
942

943
;;; Table rendering algorithm.
944

945 946 947 948 949 950 951 952
;; 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.
953
(defun shr-tag-table-1 (cont)
954 955
  (setq cont (or (cdr (assq 'tbody cont))
		 cont))
956
  (let* ((shr-inhibit-images t)
957
	 (shr-table-depth (1+ shr-table-depth))
958
	 (shr-kinsoku-shorten t)
959
	 ;; Find all suggested widths.
960
	 (columns (shr-column-specs cont))
961
	 ;; Compute how many characters wide each TD should be.
962
	 (suggested-widths (shr-pro-rate-columns columns))
963 964 965
	 ;; 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).
966
	 (sketch (shr-make-table cont suggested-widths))
967
	 (sketch-widths (shr-table-widths sketch suggested-widths)))
968
    ;; This probably won't work very well.
969 970 971
    (when (> (+ (loop for width across sketch-widths
		      summing (1+ width))
		shr-indentation 1)
972 973
	     (frame-width))
      (setq truncate-lines t))
974
    ;; Then render the table again with these new "hard" widths.
975
    (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths))
976 977 978
  ;; 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.
979 980 981
  (when (zerop shr-table-depth)
    (dolist (elem (shr-find-elements cont 'img))
      (shr-tag-img (cdr elem)))))
982

983 984 985 986 987 988
(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)))
989
         (bgcolor (cdr (assq :bgcolor cont)))
990 991 992
	 (start (point))
	 (shr-stylesheet (nconc (list (cons 'background-color bgcolor))
				shr-stylesheet))
993 994 995 996
	 (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
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
     (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)))))
1028
		     (if (= nfooter 1)
1029 1030 1031 1032
			 footer
		       `((tr (td (table (tbody ,@footer))))))))
	  (if caption
	      `((tr (td (table (tbody ,@body)))))
1033 1034 1035 1036
	    body)))))
    (when bgcolor
      (shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
			   bgcolor))))
1037

1038 1039 1040 1041 1042 1043 1044 1045
(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)))
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056

(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)
1057
	(insert shr-table-vertical-line "\n"))
1058 1059
      (dolist (column row)
	(goto-char start)
1060
	(let ((lines (nth 2 column))
1061 1062
	      (overlay-lines (nth 3 column))
	      overlay overlay-line)
1063
	  (dolist (line lines)
1064
	    (setq overlay-line (pop overlay-lines))
1065
	    (end-of-line)
1066
	    (insert line shr-table-vertical-line)
1067 1068 1069 1070 1071 1072 1073
	    (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))
1074 1075 1076 1077
	  ;; Add blank lines at padding at the bottom of the TD,
	  ;; possibly.
	  (dotimes (i (- height (length lines)))
	    (end-of-line)
1078 1079
	    (insert (make-string (string-width (car lines)) ? )
		    shr-table-vertical-line)
1080 1081 1082 1083
	    (forward-line 1)))))
    (shr-insert-table-ruler widths)))

(defun shr-insert-table-ruler (widths)
1084 1085 1086
  (when (and (bolp)
	     (> shr-indentation 0))
    (shr-indent))
1087
  (insert shr-table-corner)
1088
  (dotimes (i (length widths))
1089 1090
    (insert (make-string (aref widths i) shr-table-horizontal-line)
	    shr-table-corner))
1091 1092
  (insert "\n"))

1093 1094 1095 1096
(defun shr-table-widths (table suggested-widths)
  (let* ((length (length suggested-widths))
	 (widths (make-vector length 0))
	 (natural-widths (make-vector length 0)))
1097 1098 1099 1100 1101
    (dolist (row table)
      (let ((i 0))
	(dolist (column row)
	  (aset widths i (max (aref widths i)
			      (car column)))
1102 1103 1104
	  (aset natural-widths i (max (aref natural-widths i)
				      (cadr column)))
	  (setq i (1+ i)))))
1105 1106
    (let ((extra (- (apply '+ (append suggested-widths nil))
		    (apply '+ (append widths nil))))
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	  (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))))))))
1120 1121 1122 1123 1124 1125
    widths))

(defun shr-make-table (cont widths &optional fill)
  (let ((trs nil))
    (dolist (row cont)
      (when (eq (car row) 'tr)
1126 1127 1128 1129 1130 1131 1132 1133
	(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))
1134 1135 1136 1137 1138 1139 1140
	      (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)
1141
  (with-temp-buffer
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 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
    (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))
1207
	  (list max
1208
		(shr-natural-width)))))))
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221

(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))
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237