shr.el 32.7 KB
Newer Older
1 2 3 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
;;; shr.el --- Simple HTML Renderer

;; Copyright (C) 2010 Free Software Foundation, Inc.

;; 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
(require 'browse-url)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
35 36
(unless (aref (char-category-set (make-char 'japanese-jisx0208 33 35)) ?>)
  (load "kinsoku" nil t))
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
(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)

58 59 60 61 62 63 64
(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."
65
  :group 'shr
66
  :type 'character)
67 68

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

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

78 79 80 81 82
(defcustom shr-width fill-column
  "Frame width to use for rendering."
  :type 'integer
  :group 'shr)

83 84 85 86 87
(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.")

88 89
;;; Internal variables.

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

100 101 102 103 104 105 106
(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)
107
    (define-key map "o" 'shr-save-contents)
108 109 110
    (define-key map "\r" 'shr-browse-url)
    map))

111 112 113 114
;; Public functions and commands.

;;;###autoload
(defun shr-insert-document (dom)
115
  (setq shr-content-cache nil)
116 117 118 119 120 121 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
  (let ((shr-state nil)
	(shr-start nil))
    (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)
162
  (let ((url (get-text-property (point) 'image-url)))
163 164 165 166 167
    (if (not url)
	(message "No image under point")
      (message "Browsing %s..." url)
      (browse-url url))))

168 169 170
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
171
  (let ((url (get-text-property (point) 'image-url)))
172 173 174 175 176 177 178
    (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))))

179 180
;;; Utility functions.

181 182 183 184 185 186 187 188
(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)
189
	  (push (cons 'text sub) result)
190 191 192 193
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

(defun shr-descend (dom)
194 195 196 197 198 199
  (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray))
	(style (cdr (assq :style (cdr dom))))
	(start (point)))
    (when (and style
	       (string-match "color" style))
      (setq style (shr-parse-style style)))
200 201
    (if (fboundp function)
	(funcall function (cdr dom))
202 203
      (shr-generic (cdr dom)))
    (when (consp style)
204 205 206 207
      (shr-insert-background-overlay (cdr (assq 'background-color style))
                                     start)
      (shr-insert-foreground-overlay (cdr (assq 'color style))
                                     start (point)))))
208 209 210 211

(defun shr-generic (cont)
  (dolist (sub cont)
    (cond
212
     ((eq (car sub) 'text)
213
      (shr-insert (cdr sub)))
214
     ((listp (cdr sub))
215 216
      (shr-descend sub)))))

217
(defun shr-insert (text)
218 219
  (when (and (eq shr-state 'image)
	     (not (string-match "\\`[ \t\n]+\\'" text)))
220 221 222 223 224 225
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
226 227 228 229 230 231 232 233 234 235 236 237 238 239
    (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))
      ;; 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)))
      ;; No space is needed behind a wide character categorized as
240 241
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
242
      (let (prev)
243 244
	(when (and (eq (preceding-char) ? )
		   (or (= (line-beginning-position) (1- (point)))
245 246 247 248 249 250 251 252
		       (and (aref fill-find-break-point-function-table
				  (setq prev (char-after (- (point) 2))))
			    (aref (char-category-set prev) ?>))
		       (and (aref fill-nospace-between-words-table prev)
			    (aref fill-nospace-between-words-table
				  (aref elem 0)))))
	  (delete-char -1)))
      (insert elem)
253 254 255 256
      (let (found)
	(while (and (> (current-column) shr-width)
		    (progn
		      (setq found (shr-find-fill-point))
257
		      (not (or (bolp) (eolp)))))
258 259 260 261
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
262 263 264 265 266 267 268 269
	    (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 " ")))
270 271
    (unless (string-match "[ \t\n]\\'" text)
      (delete-char -1)))))
272

273
(defun shr-find-fill-point ()
274 275 276 277 278 279 280 281 282 283
  (when (> (move-to-column shr-width) shr-width)
    (backward-char 1))
  (let (failed)
    (while (not
	    (or (setq failed (= (current-column) shr-indentation))
		(eq (preceding-char) ? )
		(eq (following-char) ? )
		(aref fill-find-break-point-function-table (preceding-char))))
      (backward-char 1))
    (if failed
284
	;; There's no breakable point, so we give it up.
285 286 287 288 289 290 291 292 293
	(progn
	  (end-of-line)
	  (while (aref fill-find-break-point-function-table (preceding-char))
	    (backward-char 1))
	  nil)
      (or (eolp)
	  ;; Don't put kinsoku-bol characters at the beginning of a line,
	  ;; or kinsoku-eol characters at the end of a line,
	  (let ((count 4))
294 295 296 297 298 299
	    (if (or shr-kinsoku-shorten
		    (and (aref (char-category-set (preceding-char)) ?<)
			 (progn
			   (setq count (1- count))
			   (backward-char 1)
			   t)))
300
		(while (and
301 302
			(>= (setq count (1- count)) 0)
			(not (memq (preceding-char) (list ?\C-@ ?\n ? )))
303 304 305
			(or (aref (char-category-set (preceding-char)) ?<)
			    (aref (char-category-set (following-char)) ?>)))
		  (backward-char 1))
306
	      (while (and (>= (setq count (1- count)) 0)
307 308 309
			  (aref (char-category-set (following-char)) ?>)
			  (aref fill-find-break-point-function-table
				(following-char)))
310
		(forward-char 1)))
311 312
	    (when (eq (following-char) ? )
	      (forward-char 1))
313
	    t)))))
314

315 316 317
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
318 319 320

(defun shr-ensure-paragraph ()
  (unless (bobp)
321
    (if (<= (current-column) shr-indentation)
322 323 324
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
325 326 327
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
328
	    (looking-at " *$"))
329 330 331
	  (insert "\n")
	(insert "\n\n")))))

332
(defun shr-indent ()
333 334
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
335

336
(defun shr-fontize-cont (cont &rest types)
337 338
  (let (shr-start)
    (shr-generic cont)
339 340
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
341

342 343 344
;; 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.
345
(defun shr-add-font (start end type)
346 347 348 349 350 351 352 353 354 355
  (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)))))
356

357 358 359 360
(defun shr-browse-url ()
  "Browse the URL under point."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
361 362 363 364
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
365
      (browse-url-mailto url))
366 367
     (t
      (browse-url url)))))
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
(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)))))

386 387 388 389 390 391 392 393 394 395 396
(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
          (let ((alt (buffer-substring start end))
		(inhibit-read-only t))
	    (delete-region start end)
397 398
	    (goto-char start)
	    (shr-put-image data alt))))))
399 400
  (kill-buffer (current-buffer)))

401
(defun shr-put-image (data alt)
402 403 404 405
  (if (display-graphic-p)
      (let ((image (ignore-errors
                     (shr-rescale-image data))))
        (when image
406 407 408 409 410
	  ;; 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"))
411 412
	  (insert-image image (or alt "*"))))
    (insert alt)))
413 414 415 416 417 418

(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))
419
	   (size (image-size image t))
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
	   (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)))
      image)))

Glenn Morris's avatar
Glenn Morris committed
441 442 443
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
444
(autoload 'browse-url-mailto "browse-url")
Glenn Morris's avatar
Glenn Morris committed
445

446 447 448 449 450
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
451
    (when (ignore-errors
452
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
453 454 455 456
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
	(buffer-substring (point) (point-max))))))
457

458 459 460 461 462 463
(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,
START, and END."
  `(lambda (url start end)
464 465 466 467 468 469 470 471 472 473 474 475 476 477
     (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
				  (prog1
				      (buffer-substring-no-properties start end)
				    (delete-region start end))))))
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
		       t)))))
478

479 480 481 482 483
(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
484 485
(autoload 'widget-convert-button "wid-edit")

486 487 488 489 490 491 492 493 494 495 496 497
(defun shr-urlify (start url)
  (widget-convert-button
   'url-link start (point)
   :help-echo url
   :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 "[)$ ]"))

498 499
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524

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

(defun shr-get-background (pos)
  "Return background color at POS."
525
  (dolist (overlay (overlays-in pos (1+ pos)))
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
    (let ((background (plist-get (overlay-get overlay 'face)
                                 :background)))
      (when background
        (return background)))))

(defun shr-insert-foreground-overlay (fg start end)
  (when fg
    (let ((bg (shr-get-background start)))
      (let ((new-colors (shr-color-check fg bg)))
        (when new-colors
          (overlay-put (make-overlay start end) 'face
                       (list :foreground (cadr new-colors))))))))

(defun shr-insert-background-overlay (bg start)
  "Insert an overlay with background color BG at START.
The overlay has rear-advance set to t, so it will be used when
text will be inserted at start."
  (when bg
    (let ((new-colors (shr-color-check nil bg)))
      (when new-colors
        (overlay-put (make-overlay start start nil nil t) 'face
                     (list :background (car new-colors)))))))
548

549 550
;;; Tag-specific rendering rules.

551 552 553 554 555 556 557 558
(defun shr-tag-body (cont)
  (let ((start (point))
        (fgcolor (cdr (assq :fgcolor cont)))
        (bgcolor (cdr (assq :bgcolor cont))))
    (shr-insert-background-overlay bgcolor start)
    (shr-generic cont)
    (shr-insert-foreground-overlay fgcolor start (point))))

559 560
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
561
  (shr-indent)
562 563 564
  (shr-generic cont)
  (shr-ensure-paragraph))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
565 566 567 568 569 570
(defun shr-tag-div (cont)
  (shr-ensure-newline)
  (shr-indent)
  (shr-generic cont)
  (shr-ensure-newline))

571 572 573 574 575 576 577 578 579
(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))

580 581 582
(defun shr-tag-strong (cont)
  (shr-fontize-cont cont 'bold))

583 584 585 586 587 588
(defun shr-tag-u (cont)
  (shr-fontize-cont cont 'underline))

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

589 590
(defun shr-parse-style (style)
  (when style
591 592 593
    (save-match-data
      (when (string-match "\n" style)
        (setq style (replace-match " " t t style))))
594 595 596 597 598 599 600 601
    (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))))
602 603
	      (when (string-match " *!important\\'" value)
		(setq value (substring value 0 (match-beginning 0))))
604 605 606 607 608
	      (push (cons (intern name obarray)
			  value)
		    plist)))))
      plist)))

609 610 611 612 613
(defun shr-tag-a (cont)
  (let ((url (cdr (assq :href cont)))
	(start (point))
	shr-start)
    (shr-generic cont)
614 615 616
    (shr-urlify (or shr-start start) url)))

(defun shr-tag-object (cont)
617 618 619 620 621 622 623 624
  (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)))))))
625 626
    (when url
      (shr-insert " [multimedia] ")
627 628 629 630 631 632 633 634 635
      (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)))
636

637 638 639 640
(defun shr-tag-img (cont &optional url)
  (when (or url
	    (and cont
		 (cdr (assq :src cont))))
641 642 643 644
    (when (and (> (current-column) 0)
	       (not (eq shr-state 'image)))
      (insert "\n"))
    (let ((alt (cdr (assq :alt cont)))
645
	  (url (or url (cdr (assq :src cont)))))
646 647
      (let ((start (point-marker)))
	(when (zerop (length alt))
648
	  (setq alt "*"))
649
	(cond
650 651 652 653
	 ((or (member (cdr (assq :height cont)) '("0" "1"))
	      (member (cdr (assq :width cont)) '("0" "1")))
	  ;; Ignore zero-sized or single-pixel images.
	  )
654 655 656 657 658 659 660
	 ((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)
661
	      (shr-put-image image alt))))
662 663 664 665 666
	 ((or shr-inhibit-images
	      (and shr-blocked-images
		   (string-match shr-blocked-images url)))
	  (setq shr-start (point))
	  (let ((shr-state 'space))
667 668
	    (if (> (string-width alt) 8)
		(shr-insert (truncate-string-to-width alt 8))
669 670
	      (shr-insert alt))))
	 ((url-is-cached (shr-encode-url url))
671
	  (shr-put-image (shr-get-image-data url) alt))
672 673 674 675 676 677 678 679
	 (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)
680 681
	(put-text-property start (point) 'image-url url)
	(put-text-property start (point) 'image-displayer
682
			   (shr-image-displayer shr-content-function))
683
	(put-text-property start (point) 'help-echo alt)
684
	(setq shr-state 'image)))))
685 686 687 688

(defun shr-tag-pre (cont)
  (let ((shr-folding-mode 'none))
    (shr-ensure-newline)
689
    (shr-indent)
690 691 692 693 694
    (shr-generic cont)
    (shr-ensure-newline)))

(defun shr-tag-blockquote (cont)
  (shr-ensure-paragraph)
695
  (shr-indent)
696 697 698
  (let ((shr-indentation (+ shr-indentation 4)))
    (shr-generic cont))
  (shr-ensure-paragraph))
699 700 701 702

(defun shr-tag-ul (cont)
  (shr-ensure-paragraph)
  (let ((shr-list-mode 'ul))
703 704
    (shr-generic cont))
  (shr-ensure-paragraph))
705 706

(defun shr-tag-ol (cont)
707
  (shr-ensure-paragraph)
708
  (let ((shr-list-mode 1))
709 710
    (shr-generic cont))
  (shr-ensure-paragraph))
711 712

(defun shr-tag-li (cont)
713 714
  (shr-ensure-paragraph)
  (shr-indent)
715 716 717 718 719 720 721 722 723
  (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)))
724 725

(defun shr-tag-br (cont)
726
  (unless (bobp)
727 728
    (insert "\n")
    (shr-indent))
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
  (shr-generic cont))

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

(defun shr-tag-h2 (cont)
  (shr-heading cont 'bold))

(defun shr-tag-h3 (cont)
  (shr-heading cont 'italic))

(defun shr-tag-h4 (cont)
  (shr-heading cont))

(defun shr-tag-h5 (cont)
  (shr-heading cont))

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

749 750
(defun shr-tag-hr (cont)
  (shr-ensure-newline)
751
  (insert (make-string shr-width shr-hr-line) "\n"))
752

753 754 755
(defun shr-tag-title (cont)
  (shr-heading cont 'bold 'underline))

756 757 758 759
(defun shr-tag-font (cont)
  (let ((start (point))
        (color (cdr (assq :color cont))))
    (shr-generic cont)
760
    (shr-insert-foreground-overlay color start (point))))
761

762
;;; Table rendering algorithm.
763

764 765 766 767 768 769 770 771
;; 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.
772
(defun shr-tag-table-1 (cont)
773 774
  (setq cont (or (cdr (assq 'tbody cont))
		 cont))
775
  (let* ((shr-inhibit-images t)
776
	 (shr-table-depth (1+ shr-table-depth))
777
	 (shr-kinsoku-shorten t)
778
	 ;; Find all suggested widths.
779
	 (columns (shr-column-specs cont))
780
	 ;; Compute how many characters wide each TD should be.
781
	 (suggested-widths (shr-pro-rate-columns columns))
782 783 784
	 ;; 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).
785
	 (sketch (shr-make-table cont suggested-widths))
786
	 (sketch-widths (shr-table-widths sketch suggested-widths)))
787
    ;; This probably won't work very well.
788 789 790
    (when (> (+ (loop for width across sketch-widths
		      summing (1+ width))
		shr-indentation 1)
791 792
	     (frame-width))
      (setq truncate-lines t))
793
    ;; Then render the table again with these new "hard" widths.
794
    (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths))
795 796 797
  ;; 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.
798 799 800
  (when (zerop shr-table-depth)
    (dolist (elem (shr-find-elements cont 'img))
      (shr-tag-img (cdr elem)))))
801

802 803 804 805 806 807
(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)))
808
         (bgcolor (cdr (assq :bgcolor cont)))
809 810 811
	 (nheader (if header (shr-max-columns header)))
	 (nbody (if body (shr-max-columns body)))
	 (nfooter (if footer (shr-max-columns footer))))
812
    (shr-insert-background-overlay bgcolor (point))
813
    (shr-tag-table-1
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
     (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)))))
845
		     (if (= nfooter 1)
846 847 848 849 850
			 footer
		       `((tr (td (table (tbody ,@footer))))))))
	  (if caption
	      `((tr (td (table (tbody ,@body)))))
	    body)))))))
851

852 853 854 855 856 857 858 859
(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)))
860 861 862 863 864 865 866 867 868 869 870

(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)
871
	(insert shr-table-vertical-line "\n"))
872 873
      (dolist (column row)
	(goto-char start)
874
	(let ((lines (nth 2 column))
875 876
	      (overlay-lines (nth 3 column))
	      overlay overlay-line)
877
	  (dolist (line lines)
878
	    (setq overlay-line (pop overlay-lines))
879
	    (end-of-line)
880
	    (insert line shr-table-vertical-line)
881 882 883 884 885 886 887
	    (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))
888 889 890 891
	  ;; Add blank lines at padding at the bottom of the TD,
	  ;; possibly.
	  (dotimes (i (- height (length lines)))
	    (end-of-line)
892 893
	    (insert (make-string (string-width (car lines)) ? )
		    shr-table-vertical-line)
894 895 896 897
	    (forward-line 1)))))
    (shr-insert-table-ruler widths)))

(defun shr-insert-table-ruler (widths)
898 899 900
  (when (and (bolp)
	     (> shr-indentation 0))
    (shr-indent))
901
  (insert shr-table-corner)
902
  (dotimes (i (length widths))
903 904
    (insert (make-string (aref widths i) shr-table-horizontal-line)
	    shr-table-corner))
905 906
  (insert "\n"))

907 908 909 910
(defun shr-table-widths (table suggested-widths)
  (let* ((length (length suggested-widths))
	 (widths (make-vector length 0))
	 (natural-widths (make-vector length 0)))
911 912 913 914 915
    (dolist (row table)
      (let ((i 0))
	(dolist (column row)
	  (aset widths i (max (aref widths i)
			      (car column)))
916 917 918
	  (aset natural-widths i (max (aref natural-widths i)
				      (cadr column)))
	  (setq i (1+ i)))))
919 920
    (let ((extra (- (apply '+ (append suggested-widths nil))
		    (apply '+ (append widths nil))))
921 922 923 924 925 926 927 928 929 930 931 932 933
	  (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))))))))
934 935 936 937 938 939
    widths))

(defun shr-make-table (cont widths &optional fill)
  (let ((trs nil))
    (dolist (row cont)
      (when (eq (car row) 'tr)
940 941 942 943 944 945 946 947
	(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))
948 949 950 951 952 953 954
	      (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)
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
  (let ((background (shr-get-background (point))))
    (with-temp-buffer
      (let ((cache (cdr (assoc (cons width cont) shr-content-cache))))
        (if cache
            (insert cache)
          (shr-insert-background-overlay (or (cdr (assq :bgcolor cont))
                                             background)
                                         (point))
          (let ((shr-width width)
                (shr-indentation 0))
            (shr-generic cont))
          (delete-region
           (point)
           (+ (point)
              (skip-chars-backward " \t\n")))
          (push (cons (cons width cont) (buffer-string))
                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))))
        (if fill
            (list max
                  (count-lines (point-min) (point-max))
                  (split-string (buffer-string) "\n")
                  (shr-collect-overlays))
          (list max
                (shr-natural-width)))))))
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

(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))
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032

(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)))
1033 1034 1035 1036 1037

(defun shr-pro-rate-columns (columns)
  (let ((total-percentage 0)
	(widths (make-vector (length columns) 0)))
    (dotimes (i (length columns))
1038
      (setq total-percentage (+ total-percentage (aref columns i))))
1039 1040 1041 1042
    (setq total-percentage (/ 1.0 total-percentage))
    (dotimes (i (length columns))
      (aset widths i (max (truncate (* (aref columns i)
				       total-percentage
1043
				       (- shr-width (1+ (length columns)))))
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
			  10)))
    widths))

;; Return a summary of the number and shape of the TDs in the table.
(defun shr-column-specs (cont)
  (let ((columns (make-vector (shr-max-columns cont) 1)))
    (dolist (row cont)
      (when (eq (car row) 'tr)
	(let ((i 0))
	  (dolist (column (cdr row))
	    (when (memq (car column) '(td th))
	      (let ((width (cdr (assq :width (cdr column)))))
		(when (and width
			   (string-match "\\([0-9]+\\)%" width))
		  (aset columns i
			(/ (string-to-number (match-string 1 width))
1060 1061
			   100.0))))
	      (setq i (1+ i)))))))
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
    columns))

(defun shr-count (cont elem)
  (let ((i 0))
    (dolist (sub cont)
      (when (eq (car sub) elem)
	(setq i (1+ i))))
    i))

(defun shr-max-columns (cont)
  (let ((max 0))
    (dolist (row cont)
      (when (eq (car row) 'tr)
1075 1076
	(setq max (max max (+ (shr-count (cdr row) 'td)
			      (shr-count (cdr row) 'th))))))
1077 1078
    max))

1079
(provide 'shr)
1080 1081

;;; shr.el ends here